Skip to content
straddle API Docs
Get started
API Reference
Embed

Organizations

Organizations are a powerful feature in Straddle that allow you to manage multiple accounts under a single umbrella. This hierarchical structure is particularly useful for businesses with complex operations, multiple departments, or legally related entities.

Create an organization
embed.organizations.create(**kwargs) -> OrganizationV1 { data, meta, response_type }
POST/v1/organizations
List organizations
embed.organizations.list(**kwargs) -> PageNumberSchema<{ id, created_at, name, 3 more}>
GET/v1/organizations
Retrieve organization details
embed.organizations.get(organization_id, **kwargs) -> OrganizationV1 { data, meta, response_type }
GET/v1/organizations/{organization_id}
ModelsExpand Collapse
class OrganizationPagedV1 { data, meta, response_type }
data: Array[{ id, created_at, name, 3 more}]
id: String

Straddle's unique identifier for the organization.

formatuuid
created_at: Time

Timestamp of when the organization was created.

formatdate-time
name: String

The name of the organization.

updated_at: Time

Timestamp of the most recent update to the organization.

formatdate-time
external_id: String

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

metadata: Hash[Symbol, String]

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

meta: PagedResponseMetadata { api_request_id, api_request_timestamp, max_page_size, 6 more }

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

api_request_id: String

Unique identifier for this API request, useful for troubleshooting.

formatuuid
api_request_timestamp: Time

Timestamp for this API request, useful for troubleshooting.

formatdate-time
max_page_size: Integer

Maximum allowed page size for this endpoint.

formatint32
page_number: Integer

Page number for paginated results.

formatint32
page_size: Integer

Number of items per page in this response.

formatint32
sort_by: String

The field that the results were sorted by.

sort_order: :asc | :desc
One of the following:
:asc
:desc
total_items: Integer

Total number of items returned in this response.

formatint32
total_pages: Integer

The number of pages available.

formatint32
response_type: :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.
One of the following:
:object
:array
:error
:none
class OrganizationV1 { data, meta, response_type }
data: { id, created_at, name, 3 more}
id: String

Straddle's unique identifier for the organization.

formatuuid
created_at: Time

Timestamp of when the organization was created.

formatdate-time
name: String

The name of the organization.

updated_at: Time

Timestamp of the most recent update to the organization.

formatdate-time
external_id: String

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

metadata: Hash[Symbol, String]

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

meta: ResponseMetadata { api_request_id, api_request_timestamp }

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

api_request_id: String

Unique identifier for this API request, useful for troubleshooting.

formatuuid
api_request_timestamp: Time

Timestamp for this API request, useful for troubleshooting.

formatdate-time
response_type: :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.
One of the following:
:object
:array
:error
:none