Skip to main content
Your Heymarket account is organized around inboxes — each inbox has one or more phone numbers and a set of assigned team members. You need an inbox_id whenever you send a message, so fetching your inboxes is often the first step in an integration.

​
Get inboxes

GET /v1/inboxes Returns an array of all inboxes your API key has access to. No request body is required.

​
Inbox object

​
id
integer
Unique identifier for the inbox. Pass this as inbox_id when sending messages.
​
name
string
Display name of the inbox.
​
team
integer
ID of the team this inbox belongs to.
​
members
integer[]
Array of user IDs assigned to this inbox.
​
phones
string[]
All phone numbers associated with this inbox.
​
phone
string
The primary phone number for this inbox.
​
auto_assignable
boolean
Whether new conversations are automatically assigned to inbox members.
​
forward_number
string
Phone number to which calls are forwarded, if configured.
​
widget_code
string
Embeddable widget code for this inbox.
​
widget_settings
object
Configuration settings for the web widget.
​
allowed_domains
string[]
Domains allowed to embed the web widget.
​
invited
boolean
Whether the current user has been invited to this inbox.
curl --request GET \
  --url https://api.heymarket.com/v1/inboxes \
  --header 'Authorization: Bearer YOUR_API_KEY'

[
  {
    "id": 413,
    "name": "Support",
    "team": 7,
    "members": [1, 2, 5],
    "phones": ["14155550100"],
    "phone": "14155550100",
    "auto_assignable": true,
    "forward_number": null,
    "widget_code": "abc123",
    "allowed_domains": ["example.com"],
    "invited": true
  }
]

​
Get your team

GET /v1/team Returns your team object, including all members with their IDs and roles.

​
Team object

​
id
integer
Unique team identifier.
​
name
string
Team display name.
​
list_size
integer
Maximum number of contacts allowed per list.
​
members
object[]
Array of team member objects.
curl --request GET \
  --url https://api.heymarket.com/v1/team \
  --header 'Authorization: Bearer YOUR_API_KEY'

{
  "id": 7,
  "name": "Acme Support",
  "list_size": 10000,
  "members": [
    {"id": 1, "name": "Alice Smith", "role": "admin"},
    {"id": 2, "name": "Bob Jones", "role": "member"}
  ]
}
The inbox_id from Get Inboxes is required for sending messages. Use member id values from Get Inboxes or Get Team as creator_id to attribute messages to specific agents.