API

API explorer

Pick a resource or action, fill in the parameters, and copy a request example.

Everything below runs inside this page. The request line and code examples update as you edit parameters. Nothing is sent, and the page never asks for credentials.

Sample credentials only

The key and client IDs here are fake. Copied snippets use $AGENTIX_API_BASE and $AGENTIX_API_KEY so you never paste a dummy key into real code, create a real key under Agency → Automations → API.

Endpoint

Reads

Writes

GET$AGENTIX_API_BASE/platform-api?resource=clients&limit=25&offset=0 Examples only

Every client your API key can reach. The only resource that does not need a client_id.

This builder never sends a request or receives your API key. Copy a generated example and provide secrets through environment variables.

Parameters

limitOptional

Rows per page, 1–1000. Defaults to 50.

offsetOptional

Rows to skip. Loop until `pagination.has_more` is false.

filter_fieldOptional

Whitelisted column to filter on.

filter_valueOptional

Value the `filter_field` column must equal.

cURL

curl -s "$AGENTIX_API_BASE/platform-api?resource=clients&limit=25&offset=0" \
  -H "Authorization: Bearer $AGENTIX_API_KEY"