API

API explorer

Pick a resource or action, fill in the parameters and run it against built-in sample data, no API key required.

Everything below runs inside this page. Responses come from built-in sample data that mirrors the real gateway envelopes, so nothing is sent anywhere and no credentials are needed. Switch the credential dropdown to see the 401 and 403 shapes, or clear a required field to see the 400.

Sample credentials only

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

GET$AISOIQ_API_BASE?resource=clients&limit=25&offset=0 Sample mode

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

Every endpoint succeeds. Requests are answered inside this page from built-in sample data, the fake key sk_agx_sample_0000000000000000000000 reaches nothing. For real calls, create a key as described in Authentication.

Parameters

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

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

Whitelisted column to filter on.

Value the `filter_field` column must equal.

Press “Send request” to see the sample response for this endpoint.

Was this page helpful?