Welcome to the Inbox Enterprise API
The Enterprise API gives you full access to manage the following entities in your team:- Threads: DM conversations on X
- Account links: X accounts connected to your team
- Members: users who can access the team
- Prospects: external profiles on X
- Tags: labels for prospects
- Statuses: pipeline statuses for prospects
- Lists: Saved collections of leads
- Campaigns: Automated DM sequences
Authentication
All API endpoints are authenticated using Bearer tokens. Include your token in theAuthorization header:
Base URL
All API requests should be made to:A quick note on IDs
Inbox stores two types of IDs for objects that relate to X:id— The Inbox ID, which is the ID of the Inbox objectplatformId— The original X ‘platform’ ID, which is the ID of the X user, conversation, etc.
platformId is always the original X ID.
Encoding objects and arrays in query params
Inbox’s API uses bracket notation to denote objects and arrays.Objects
For an endpoint that accepts acursor parameter for instance, with the cursor object being:
Arrays
For an endpoint that accepts anids parameter for instance, with the value being:
- Repeat the parameter for each value:
- Append
[]to explicitly denote an array (useful if there’s only one value):
- Append
[number]to denote the array index. This option is the most flexible and allows for reordering and skipping values: