Skip to main content
GET
List your client firms + connection state
Every client firm on your desk with its current connection state, cursor-paginated (limit default 100, max 500). Requires the firms scope. This is the read your onboarding dashboard polls.

Request example

Response example

The state vocabulary is documented on Register a firm.

Errors

Terms used here: IEC, API key, scope, pagination. Full list in the terminology annexure.

Next steps

Authorizations

X-ScripX-Key
string
header
required

Your API key, e.g. scripx_live_…. Bound to one firm; tenant isolation is enforced.

Query Parameters

limit
integer
default:100
Required range: x <= 500
cursor
string

opaque offset from a prior response's next_cursor

Response

OK

firms
object[]
count
integer