Get Agency Id By Id

Gets an agency by its id

GET /api/v1/agency/{agency_id}

Get Agency Id By Id

cURL

curl --request GET \
  --url 'https://api.example.com/api/v1/agency/{agency_id}?api_key='

200

{
  "message": "Data retrieved successfully",
  "meta": {},
  "data": {
    "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "branding": {},
    "domain": {},
    "billing_plan": {},
    "user_auth": {}
  }
}

Authorizations

Your API KeyHTTPBearer

api_key · string · query · required

Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.

Path Parameters

agency_id · string<uuid> · required

Response

200

application/json

Successful Response

message · string | null · default: Data retrieved successfully

meta · Meta · object

data · IAgencyRead · object

Show child attributes