Create organization

POST

/v1/organizations/

Create a new organization with an initial API key.

Request Body ^required

OrganizationCreate

object

name

required

Name

string

>= 1 characters <= 255 characters

default_currency

Default Currency

string

default: USD >= 3 characters <= 3 characters

timezone

Timezone

string

default: UTC <= 50 characters

hmac_key

Any of:

string

string

<= 255 characters

null

null

logo_url

Any of:

string

string

<= 2048 characters

null

null

portal_accent_color

Any of:

string

string

<= 7 characters

null

null

portal_welcome_message

Any of:

string

string

<= 500 characters

null

null

Responses

201

Successful Response

OrganizationCreateResponse

Organization creation response that includes the initial API key.

object

id

required

Id

string format: uuid

name

required

Name

string

default_currency

required

Default Currency

string

timezone

required

Timezone

string

hmac_key

required

Any of:

string

string

null

null

logo_url

required

Any of:

string

string

null

null

portal_accent_color

required

Any of:

string

string

null

null

portal_welcome_message

required

Any of:

string

string

null

null

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

api_key

required

ApiKeyCreateResponse

Returned only on creation — includes the raw API key.

object

id

required

Id

string format: uuid

organization_id

required

Organization Id

string format: uuid

key_prefix

required

Key Prefix

string

name

required

Any of:

string

string

null

null

last_used_at

required

Any of:

string

string format: date-time

null

null

expires_at

required

Any of:

string

string format: date-time

null

null

status

required

Status

string

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

raw_key

required

Raw Key

string

422

Validation error