Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsGet Organization
Search the full API reference Esc to close

Get Organization

Organization · REST API reference

Get support
GET/v1/organization
The org's own identity: name, plan, logos.

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request example

Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.

cURL
curl --request GET \
  --url 'https://api.staging.facily.ai/v1/organization' \
  --header "Authorization: Bearer $FACILY_API_KEY"
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Try a request

Staging · read-only

Explore your organization with a read-only request to staging.

Kept in this tab only. Sent directly to api.staging.facily.ai.

GET

GET requests only. Your key’s permissions and facility scope still apply.

Response
Your response will appear here.

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

200Successful Response
JSON · generated example
{
  "data": {
    "accent_color": "string",
    "created_at": "2026-10-29T12:00:00Z",
    "id": "00000000-0000-4000-8000-000000000001",
    "logo_url": "string",
    "max_facilities": 0,
    "name": "string",
    "plan": {
      "display_name": "string",
      "id": "00000000-0000-4000-8000-000000000001",
      "name": "string"
    },
    "primary_domain": "string",
    "updated_at": "2026-10-29T12:00:00Z",
    "logo_dark_url": "string",
    "wide_logo_dark_url": "string",
    "wide_logo_url": "string"
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataOrganizationResponserequired
Show data schema
accent_colorstring | nullrequired

Brand accent colour, as a hex code, applied to tenant-facing documents and messages.

Show accent_color schema
string | null

Brand accent colour, as a hex code, applied to tenant-facing documents and messages.

Variant 1: string
string
Variant 2: null
null
created_atstringrequired

When the organization was created.

Format: date-time

idstringrequired

Unique identifier for this organization.

Format: uuid

logo_dark_urlstring | null

Public URL of the dark-mode version of the square logo, or null when none has been uploaded. A client on a dark surface should fall back to `logo_url`; a client on a light surface should never use it.

Show logo_dark_url schema
string | null

Public URL of the dark-mode version of the square logo, or null when none has been uploaded. A client on a dark surface should fall back to `logo_url`; a client on a light surface should never use it.

Variant 1: string
string
Variant 2: null
null
logo_urlstring | nullrequired

Public URL of the organization's square logo. Null when no logo has been uploaded.

Show logo_url schema
string | null

Public URL of the organization's square logo. Null when no logo has been uploaded.

Variant 1: string
string
Variant 2: null
null
max_facilitiesintegerrequired

How many facilities the current plan permits.

namestringrequired

The storage company's name.

planOrganizationPlanResponserequired
Show plan schema
display_namestringrequired
idstringrequired

Format: uuid

namestringrequired
primary_domainstring | nullrequired

The organization's main web domain.

Show primary_domain schema
string | null

The organization's main web domain.

Variant 1: string
string
Variant 2: null
null
updated_atstringrequired

When the organization was last modified.

Format: date-time

wide_logo_dark_urlstring | null

Public URL of the dark-mode version of the wide logo, or null when none has been uploaded. A client on a dark surface should fall back to `wide_logo_url`; a client on a light surface should never use it.

Show wide_logo_dark_url schema
string | null

Public URL of the dark-mode version of the wide logo, or null when none has been uploaded. A client on a dark surface should fall back to `wide_logo_url`; a client on a light surface should never use it.

Variant 1: string
string
Variant 2: null
null
wide_logo_urlstring | null

Public URL of the organization's wide/horizontal logo, for slots a square mark suits badly (the sign-in screen, email headers). Independent of `logo_url`: either, both or neither may be set, so a client wanting one must not fall back to the other silently.

Show wide_logo_url schema
string | null

Public URL of the organization's wide/horizontal logo, for slots a square mark suits badly (the sign-in screen, email headers). Independent of `logo_url`: either, both or neither may be set, so a client wanting one must not fall back to the other silently.

Variant 1: string
string
Variant 2: null
null
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

Get Organization | Facily Developers