Create an organization

Creates a new organization related to your Straddle integration. Organizations can be used to group related accounts and manage permissions across multiple users.

POST /v1/organizations

cURL

cURL

curl --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_API_KEY' \
  --url https://sandbox.straddle.com/v1/organizations \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>"
}'

201

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "response_type": "object",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "external_id": "<string>",
    "metadata": {}
  }
}

Authorizations

Authorization · string · header · required

Use your Straddle API Key in the Authorization header as Bearer to authorize API requests.

Headers

request-id · string

Optional client generated identifier to trace and debug a request.

correlation-id · string

Optional client generated identifier to trace and debug a series of requests.

idempotency-key · string

Optional client generated value to use for idempotent requests.

Required string length: 10 - 40

Body

application/jsontext/jsonapplication/*+json

name · string · required

The name of the organization.

metadata · object

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

Show child attributes

external_id · string | null

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

Response

201

text/plain

Created

meta · object · required

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

Show child attributes

response_type · enum<string> · required

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.

Available options: object, array, error, none

data · object · required

Show child attributes