Skip to main content
Get Subdomain

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

subdomain_external_id
string
required

The unique Subdomain ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Query Parameters

include
enum<string>[]

Additional Subdomain attributes that will be included in the response body. This query parameter can be added multiple times to include more attributes.

Available options:
custom_properties

Response

OK

Default structure for Subdomain.

external_id
string<uuid>
required

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100
Pattern: [a-zA-Z0-9_-]+
Example:

"a3903505-eb84-42dc-a79f-5e7b1fe897b7"

domain_id
string<uuid>
required

The unique ID of a Domain to which this Subdomain is linked, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100
Pattern: [a-zA-Z0-9_-]+
Example:

"a3903505-eb84-42dc-a79f-5e7b1fe897b7"

subdomain_name
string
required

Name of the Subdomain.

Required string length: 1 - 255
Example:

"Database Management"

last_updated
string<date-time>
required

Timestamp of the last update to this entity.

Example:

"2021-01-21T17:32:28Z"