1MSG
ReferenceInbox API

List inbox contacts for copy into a campaign segment

GET
/api/v1/inbox/contacts

Read-only. Returns name, phone, bsuid, and username. Does not send messages.

Authorization

bearer
headerAuthorizationBearer <token>

Key issued in Settings → Developer → API key. Inbox methods need the Inbox scope. Campaigns methods need the Campaigns scope.

Query Parameters

status?string
Value in"OPEN""CLOSED"
assignee?string

Conversation assignee user id

lastMessageFrom?string

Inclusive ISO-8601 lower bound on last message time

lastMessageTo?string

Inclusive ISO-8601 upper bound on last message time

fields?string

Comma-separated subset of name, phone, bsuid, username

limit?number

Page size. Defaults to 50, maximum 100.

Default50
cursor?string

Page cursor returned by the previous response. Leave empty for the first page.

Response Body

application/json
  1. response
items*array<>
nextCursor*string|null
curl -X GET 'https://api.1msg.io/api/v1/inbox/contacts'
{  "items": [    {      "name": "string",      "phone": "string",      "bsuid": "string",      "username": "string"    }  ],  "nextCursor": "string"}