List agents scoped to the authenticated account

View as Markdown

Returns all registered Mac agents for the account, optionally filtered by status (online, offline, or blocked). Agents only appear after they are assigned to the account (via POST /agents/{phoneNumber}/assign or first successful ownership claim).

Authentication

X-App-Idstring

Your MessageBlue App ID, sent in clear on every request. It is paired with request signing: each request is also signed with your App Secret (see the Authentication tag). The App Secret itself is NEVER transmitted — it is only the HMAC signing key.

Query parameters

statusenumOptional
Allowed values:

Response

OK
okboolean
dataobject

Endpoint-specific payload wrapped in a standard success envelope.

metaobject

Errors

401
Unauthorized Error
500
Internal Server Error