Get an organization by ID

Returns a single organization by its unique identifier.

GET /organizations/{organizationId}

Get an organization by ID

cURL

curl --request GET \
  --url https://app.dynamicauth.com/api/v0/organizations/{organizationId} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "name": "Acme Corp",
  "description": "An example name",
  "websiteUrl": "https://website-sample.com",
  "address": {
    "addressLine1": "An example name",
    "addressLine2": "An example name",
    "city": "An example name",
    "region": "An example name",
    "postalCode": "An example name",
    "country": "US"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationId · string · required

ID of organization

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Response

200

application/json

Organization response

id · string · required

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

name · string · required

Organization display name

Example:

"Acme Corp"

description · string

Pattern: ^$|^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$

Example:

"An example name"

websiteUrl · string

Pattern: ^$|^(https?:\/\/)?[a-z0-9]+([-.]+[a-z0-9]+)*\.[a-z]{2,10}([0-9]{1,5})?(\/.*)?$

Example:

"https://website-sample.com"

address · object

Show child attributes

role · enum<string>

Available options: owner, admin, developer, viewer