← All action domains

Accounts

2 operations. Call each with POST https://app.chirply.io/api/v1/actions/<name> and a bearer token; the response is { "data": { "action", "summary", "result" } }. A read badge means the operation changes nothing; write requires the credential’s write scope.

Which account am I in

accounts.currentread

Report the workspace this call is running in: its id, name, whether it is an agency or a client account, and — for an agency — whether this credential can also reach the client accounts underneath it. Call it when you are unsure which workspace you are about to write to. Read-only; changes nothing.

Also answers to whoami, which workspace, current account, what org am I in.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/accounts.current \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'
Test with your API key

Over MCP the same operation is the tool accounts_current at https://app.chirply.io/api/mcp, same bearer token, same input.

Client accounts you can work in

accounts.listread

List the client accounts this credential can act inside — the separate workspaces an agency runs for each of its clients. Returns each one's id, name, slug and status. To run any other action inside one of them, send the account's id in the 'X-Chirply-Account' header (REST) or as the 'account' argument (MCP); leave it out and you act in your own workspace. Returns an empty list for a workspace that has no client accounts, and for a credential deliberately restricted to its own workspace. Read-only; changes nothing.

Also answers to list sub-accounts, list client workspaces, which accounts can I manage, locations, child accounts.

Parameters

FieldTypeRequiredDescription
include_inactivebooleanoptionalInclude client accounts that are suspended, cancelled or archived. Defaults to false — those accounts exist but refuse machine calls, so acting in one will fail.

Example

curl -X POST https://app.chirply.io/api/v1/actions/accounts.list \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "include_inactive": true
  }'
Test with your API key

Over MCP the same operation is the tool accounts_list at https://app.chirply.io/api/mcp, same bearer token, same input.

The machine-readable version of this page is GET https://app.chirply.io/api/v1/actions?domain=accounts — same operations, with full JSON Schemas. Authentication, errors and rate limits are covered in the API documentation home.