List inboxes you can query
Returns the email and phone/SMS inboxes available to the credential, for use as the channelId on the messages and analytics endpoints.
With delegate-token auth (inboxes:* scope) results are limited to inboxes the authenticated user can reach, and each entry carries access: owned when the user is a member of the inbox (directly or through a team), monitored when it is another user's private inbox that the caller is permitted to monitor. scope filters on that value.
Monitoring requires the conversations.monitor_admin permission on the caller and conversations.monitor_access on the inbox owner's role, so a caller without those permissions sees only owned inboxes.
API keys and partner tokens are company-scoped and carry no user identity, so they return every inbox in the company, omit access, and reject scope with a 400.
Request
- Base URLhttps://core-api.getaptly.com
- Auth
- API key in header x-token
- or API key in header Authorization
- or HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Filter by access type. Delegate-token auth only — rejected for company-scoped credentials.
Response
Inboxes available to the credential.
Changes
No recorded changes to this operation across all 1 revision of this API.