Organizations API.¶

The DeepOriginClient can be used to access the organizations API using:

from deeporigin.platform.client import DeepOriginClient

client = DeepOriginClient()

Then, the following methods can be used, for example:

users = client.organizations.users()

src.platform.organizations.Organizations ¶

Organizations API wrapper.

Provides access to organizations-related endpoints through the DeepOriginClient.

Functions¶

users ¶

users(
    *,
    page: int | None = None,
    page_size: int | None = None,
    order: str | None = None,
    filter: str | None = None
) -> list[dict]

List all users associated with the organization.

Parameters:

Name	Type	Description	Default
`page`	`int \| None`	Page number of the pagination (default 0).	`None`
`page_size`	`int \| None`	Page size of the pagination (max 10,000).	`None`
`order`	`str \| None`	Order of the pagination.	`None`
`filter`	`str \| None`	Filter applied to the data set.	`None`

Returns:

Type	Description
`list[dict]`	List of user dictionaries, each containing fields like id, email,
`list[dict]`	firstName, lastName, authId, avatar, createdAt, updatedAt, etc.