Substy Developers
Account and agency

Get agency profile

Read the selected agency’s ID, name, slug and imageUrl. Use its exact name as confirmation when requesting agency deletion.

GET/v1/agencies/{agencyId}/profile

Read the selected agency’s ID, name, slug and imageUrl. Use its exact name as confirmation when requesting agency deletion.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/agencies/string/profile" \  -H "Authorization: Bearer YOUR_API_KEY"
{  "data": {    "id": "string",    "name": "string",    "slug": "string",    "imageUrl": "string"  },  "meta": {    "requestId": "string"  }}

Get account action status GET

Check an actionId returned by request_account_action after the user completes verification. Returns its status, expiry and recorded outcome. PENDING or RUNNING does not confirm the requested account change; an expired action requires a new request.

Rename agency PATCH

Replace the selected agency’s name and return its updated profile. Requires current permission to edit agency settings; this does not select or rename another agency.