Skip to content
straddle API Docs
  • Auto
  • Light
  • Dark
Get started
API Reference
Embed
View as Markdown
Copy Markdown
Open in Claude
Open in ChatGPT

Organizations

Create an organization
embed.organizations.create(OrganizationCreateParams**kwargs) -> OrganizationV1
post/v1/organizations
List organizations
embed.organizations.list(OrganizationListParams**kwargs) -> SyncPageNumberSchema[Data]
get/v1/organizations
Retrieve organization details
embed.organizations.get(strorganization_id, OrganizationGetParams**kwargs) -> OrganizationV1
get/v1/organizations/{organization_id}
ModelsExpand Collapse
class OrganizationPagedV1: …
data: List[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.

Metadata about the API request, including an identifier, timestamp, and pagination details.

api_request_id: str

Unique identifier for this API request, useful for troubleshooting.

formatuuid
api_request_timestamp: datetime

Timestamp for this API request, useful for troubleshooting.

formatdate-time
max_page_size: int

Maximum allowed page size for this endpoint.

formatint32
page_number: int

Page number for paginated results.

formatint32
page_size: int

Number of items per page in this response.

formatint32
sort_by: str

The field that the results were sorted by.

sort_order: Literal["asc", "desc"]
Accepts one of the following:
"asc"
"desc"
total_items: int

Total number of items returned in this response.

formatint32
total_pages: int

The number of pages available.

formatint32
response_type: Literal["object", "array", "error", "none"]

Indicates the structure of the returned content.

  • "object" means the data field contains a single JSON object.
  • "array" means the data field contains an array of objects.
  • "error" means the data field contains an error object with details of the issue.
  • "none" means no data is returned.
Accepts one of the following:
"object"
"array"
"error"
"none"
class OrganizationV1: …
data: 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.

Metadata about the API request, including an identifier and timestamp.

api_request_id: str

Unique identifier for this API request, useful for troubleshooting.

formatuuid
api_request_timestamp: datetime

Timestamp for this API request, useful for troubleshooting.

formatdate-time
response_type: Literal["object", "array", "error", "none"]

Indicates the structure of the returned content.

  • "object" means the data field contains a single JSON object.
  • "array" means the data field contains an array of objects.
  • "error" means the data field contains an error object with details of the issue.
  • "none" means no data is returned.
Accepts one of the following:
"object"
"array"
"error"
"none"