Skip to content
Get started

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
$ straddle embed:organizations create
POST/v1/organizations
List organizations
$ straddle embed:organizations list
GET/v1/organizations
Retrieve organization details
$ straddle embed:organizations get
GET/v1/organizations/{organization_id}
ModelsExpand Collapse
organizationPagedV1: object { data, meta, response_type }
data: array of object { id, created_at, name, 3 more }
id: string

Straddle's unique identifier for the organization.

created_at: string

Timestamp of when the organization was created.

name: string

The name of the organization.

updated_at: string

Timestamp of the most recent update to the organization.

external_id: optional string

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

metadata: optional map[string]

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

meta: object { 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.

api_request_timestamp: string

Timestamp for this API request, useful for troubleshooting.

max_page_size: number

Maximum allowed page size for this endpoint.

page_number: number

Page number for paginated results.

page_size: number

Number of items per page in this response.

sort_by: string

The field that the results were sorted by.

sort_order: "asc" or "desc"
"asc"
"desc"
total_items: number

Total number of items returned in this response.

total_pages: number

The number of pages available.

response_type: "object" or "array" or "error" or "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.
"object"
"array"
"error"
"none"
organizationV1: object { data, meta, response_type }
data: object { id, created_at, name, 3 more }
id: string

Straddle's unique identifier for the organization.

created_at: string

Timestamp of when the organization was created.

name: string

The name of the organization.

updated_at: string

Timestamp of the most recent update to the organization.

external_id: optional string

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

metadata: optional map[string]

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

meta: object { 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.

api_request_timestamp: string

Timestamp for this API request, useful for troubleshooting.

response_type: "object" or "array" or "error" or "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.
"object"
"array"
"error"
"none"