Skip to content
Coritan Docs

Organization API: API Keys

Create and revoke organization API keys.

View as Markdown

Create and revoke organization API keys. X-API-Key authenticates the commerce merchant API when the key carries commerce scopes; other org routes take a Bearer token.

Base URL: https://api.coritan.com/api/v1. Paths below are complete.

To try these requests in the browser, open the interactive Organization API reference.

GET /api/v1/orgs/{org_slug}/api-keys

Name In Type Required
org_slug path string yes
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.

A 200 response is a list; each item has these fields:

Field Type
[].id integer
[].org_id integer
[].label string
[].permissions object or null
[].rate_limit_per_hour integer
[].ip_whitelist array of any or null
[].is_active boolean
[].last_used_at string (date-time) or null
[].created_at string (date-time) or null

POST /api/v1/orgs/{org_slug}/api-keys

Name In Type Required
org_slug path string yes

application/json (required)

Field Type Required
label string yes
permissions object or null no
rate_limit_per_hour integer no
ip_whitelist array of string or null no
Status Meaning
201 Success.
422 The request is not valid. detail lists each problem.

Fields of a 201 response:

Field Type
id integer
org_id integer
label string
permissions object or null
rate_limit_per_hour integer
ip_whitelist array of any or null
is_active boolean
last_used_at string (date-time) or null
created_at string (date-time) or null
raw_key string

DELETE /api/v1/orgs/{org_slug}/api-keys/{key_id}

Name In Type Required
key_id path integer yes
org_slug path string yes
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.

GET /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/api-keys

Name In Type Required
org_slug path string yes
tenant_id path integer yes
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.

POST /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/api-keys

Name In Type Required
org_slug path string yes
tenant_id path integer yes

application/json (required)

Field Type Required
label string no
Status Meaning
201 Success.
422 The request is not valid. detail lists each problem.

DELETE /api/v1/orgs/{org_slug}/mail/tenants/{tenant_id}/api-keys/{key_id}

Name In Type Required
key_id path integer yes
org_slug path string yes
tenant_id path integer yes
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.

GET /api/v1/orgs/{org_slug}/staff/settings/api-keys

Name In Type Required
org_slug path string yes
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.

A key for the brand's own integrations

Section titled A key for the brand's own integrations

POST /api/v1/orgs/{org_slug}/staff/settings/api-keys

A key for the brand's own integrations. Shown once; only its hash is kept.

Name In Type Required
org_slug path string yes

application/json (required)

Field Type Required
label string yes
rate_limit_per_hour integer no
ip_whitelist array of string or null no
Status Meaning
201 Success.
422 The request is not valid. detail lists each problem.

DELETE /api/v1/orgs/{org_slug}/staff/settings/api-keys/{key_id}

Name In Type Required
key_id path integer yes
org_slug path string yes
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.