Get organization

Request

Read safe organization metadata and revision.

Security

bearerAuth

Path

idstring^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required

curl -i -X GET \
  'https://api-docs.shuffll.com/_mock/engage/openapi/v1/organizations/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Current resource or page.

Headers

X-Request-Idstring, (uuid)required

Identifier for tracing this response.

ETagstring

Quoted opaque revision when the resource or job result has one.

Bodyapplication/json

idstring^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required

meta_organization_idstring^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required

namestringrequired

slugstringrequired

is_activebooleanrequired

is_defaultbooleanrequired

revisionstring^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required

logo_urlstring or nullrequired

Any of:

string

favicon_urlstring or nullrequired

Any of:

string

primary_colorstring or nullrequired

Any of:

string

secondary_colorstring or nullrequired

Any of:

string

accent_colorstring or nullrequired

Any of:

string

font_familystring or nullrequired

Any of:

string

Response

{
  "id": "string",
  "meta_organization_id": "string",
  "name": "string",
  "slug": "string",
  "is_active": true,
  "is_default": true,
  "revision": "string",
  "logo_url": "string",
  "favicon_url": "string",
  "primary_color": "string",
  "secondary_color": "string",
  "accent_color": "string",
  "font_family": "string"
}