List organizations

embed.organizations.list() -> SyncPageNumberSchema[Data]

get/v1/organizations

Retrieves a list of organizations associated with your Straddle integration. The organizations are returned sorted by creation date, with the most recently created organizations appearing first. This endpoint supports advanced sorting and filtering options to help you find specific organizations.

ParametersExpand Collapse

external_id: Optional[str]

List organizations by their external ID.

name: Optional[str]

List organizations by name (partial match supported).

page_number: Optional[int]

Results page number. Starts at page 1.

formatint32

page_size: Optional[int]

Page size. Max value: 1000

formatint32

sort_by: Optional[str]

Sort By.

sort_order: Optional[Literal["asc", "desc"]]

Sort Order.

Accepts one of the following:

"asc"

"desc"

correlation_id: Optional[str]

request_id: Optional[str]

ReturnsExpand Collapse

Data

id: str

Straddle's unique identifier for the organization.

formatuuid

created_at: datetime

Timestamp of when the organization was created.

formatdate-time

name: str

The name of the organization.

updated_at: datetime

Timestamp of the most recent update to the organization.

formatdate-time

external_id: Optional[str]

Unique identifier for the organization in your database, used for cross-referencing between Straddle and your systems.

metadata: Optional[Dict[str, Optional[str]]]

Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the organization in a structured format.

List organizations

from straddle import Straddle

client = Straddle(
    api_key="My API Key",
)
page = client.embed.organizations.list()
page = page.data[0]
print(page.id)

{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "name": "name",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "external_id": "external_id",
      "metadata": {
        "foo": "string"
      }
    }
  ],
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z",
    "max_page_size": 0,
    "page_number": 0,
    "page_size": 0,
    "sort_by": "sort_by",
    "sort_order": "asc",
    "total_items": 0,
    "total_pages": 0
  },
  "response_type": "object"
}

Returns Examples

{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "name": "name",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "external_id": "external_id",
      "metadata": {
        "foo": "string"
      }
    }
  ],
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z",
    "max_page_size": 0,
    "page_number": 0,
    "page_size": 0,
    "sort_by": "sort_by",
    "sort_order": "asc",
    "total_items": 0,
    "total_pages": 0
  },
  "response_type": "object"
}