Get a client

GET

/v2/clients/{client_id}

const url = 'https://staging-pie.streamline.enterprises/v2/clients/client-1';
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://staging-pie.streamline.enterprises/v2/clients/client-1 \
  --header 'Authorization: Bearer <token>'

Authorizations

BearerAuth

Parameters

Path Parameters

client_id

required

string

Example

client-1

Responses

200

A client

application/json

object

client_id

required

string

client_uuid

required

string format: uuid

name

required

string

status

required

string

Allowed values: active suspended

created_at

required

string format: date-time

updated_at

required

string format: date-time

Example

{
  "client_id": "client-1",
  "client_uuid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
  "name": "Example Client",
  "status": "active",
  "created_at": "2025-01-15T10:00:00Z",
  "updated_at": "2025-01-15T10:00:00Z"
}

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
}