Skip to main content
GET
/
account
/
api
/
v1
/
organizations
/
{id}
Get organization
curl --request GET \
  --url https://www.closient.com/account/api/v1/organizations/{id} \
  --header 'X-API-Key: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "country": "<string>",
  "is_brand": true,
  "metadata": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.closient.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
id
string<shortuuid>
required

UUID of the organization.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

OK

​
id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
​
name
string
required

Organization name.

​
country
string
required

ISO 3166-1 alpha-2 country code.

​
is_brand
boolean
required

Whether this organization is a brand owner.

​
metadata
Metadata · object

Developer-attached key/value data attached to this object. Up to 50 keys; key max 40 chars, value max 500 chars.