Get a domain

GET

/v2/clients/{client_id}/domains/{domain_id}

const url = 'https://pie.streamline.enterprises/v2/clients/client-1/domains/south_australia';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://pie.streamline.enterprises/v2/clients/client-1/domains/south_australia \
  --header 'Authorization: Bearer <token>'

Authorizations

BearerAuth

Parameters

Path Parameters

client_id

required

string

Example

client-1

domain_id

required

string

Example

south_australia

Responses

200

A domain

application/json

object

client_id

required

string

domain_id

required

string

domain_uuid

required

string format: uuid

status

required

string

Allowed values: not_ready active

created_at

required

string format: date-time

updated_at

required

string format: date-time

Example

{
  "client_id": "client-1",
  "domain_id": "south_australia",
  "domain_uuid": "550e8400-e29b-41d4-a716-446655440000",
  "status": "active",
  "created_at": "2025-01-15T10:00:00Z",
  "updated_at": "2025-01-15T10:00:00Z"
}

400

Validation error — malformed input, invalid path parameters, or request that fails syntactic validation.

application/json

object

success

required

boolean

message

required

Human-readable error message

string

Example

{
  "success": false
}

401

Missing or invalid Authorization bearer token, expired token, or token rejected by the authorization layer (e.g. API Gateway JWT authorizer or application validation).

application/json

object

success

required

boolean

message

required

Human-readable error message

string

Example

{
  "success": false
}

403

Authenticated caller lacks the permission required for this operation.

application/json

object

success

required

boolean

message

required

Human-readable error message

string

Example

{
  "success": false
}

404

Requested resource was not found.

application/json

object

success

required

boolean

message

required

Human-readable error message

string

Example

{
  "success": false
}