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
OrganizationV1 Embed.Organizations.Create(OrganizationCreateParamsparameters, CancellationTokencancellationToken = default)
POST/v1/organizations
List organizations
OrganizationPagedV1 Embed.Organizations.List(OrganizationListParams?parameters, CancellationTokencancellationToken = default)
GET/v1/organizations
Retrieve organization details
OrganizationV1 Embed.Organizations.Get(OrganizationGetParamsparameters, CancellationTokencancellationToken = default)
GET/v1/organizations/{organization_id}
ModelsExpand Collapse
class OrganizationPagedV1:
required IReadOnlyList<Data> Data
required string ID

Straddle's unique identifier for the organization.

formatuuid
required DateTimeOffset CreatedAt

Timestamp of when the organization was created.

formatdate-time
required string Name

The name of the organization.

required DateTimeOffset UpdatedAt

Timestamp of the most recent update to the organization.

formatdate-time
string? ExternalID

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

IReadOnlyDictionary<string, string>? Metadata

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

required PagedResponseMetadata Meta

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

required string ApiRequestID

Unique identifier for this API request, useful for troubleshooting.

formatuuid
required DateTimeOffset ApiRequestTimestamp

Timestamp for this API request, useful for troubleshooting.

formatdate-time
required Int MaxPageSize

Maximum allowed page size for this endpoint.

formatint32
required Int PageNumber

Page number for paginated results.

formatint32
required Int PageSize

Number of items per page in this response.

formatint32
required string SortBy

The field that the results were sorted by.

required SortOrder SortOrder
One of the following:
"asc"Asc
"desc"Desc
required Int TotalItems

Total number of items returned in this response.

formatint32
required Int TotalPages

The number of pages available.

formatint32
required ResponseType ResponseType

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"Object
"array"Array
"error"Error
"none"None
class OrganizationV1:
required Data Data
required string ID

Straddle's unique identifier for the organization.

formatuuid
required DateTimeOffset CreatedAt

Timestamp of when the organization was created.

formatdate-time
required string Name

The name of the organization.

required DateTimeOffset UpdatedAt

Timestamp of the most recent update to the organization.

formatdate-time
string? ExternalID

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

IReadOnlyDictionary<string, string>? Metadata

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

required ResponseMetadata Meta

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

required string ApiRequestID

Unique identifier for this API request, useful for troubleshooting.

formatuuid
required DateTimeOffset ApiRequestTimestamp

Timestamp for this API request, useful for troubleshooting.

formatdate-time
required ResponseType ResponseType

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"Object
"array"Array
"error"Error
"none"None