Skip to main content
GET
TypeScript

Authorizations

Authorization
string
header
required

JWT access token or API token (prefixed with zipp_)

Path Parameters

orgId
string
required

Organization ID

Example:

"org_8f3kd92ld0"

slug
string
required

Brand slug to check

Required string length: 2 - 60
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
Example:

"acme"

Response

Default Response

slug
string
required

The slug that was checked

Example:

"acme"

available
boolean
required

Whether the slug is free within this organization

Example:

true