Skip to main content
GET
/
v1
/
organization
/
sms
/
messages
cURL
curl --request GET \
  --url https://api.buildwithchirp.com/v1/organization/sms/messages \
  --header 'Authorization: Bearer <token>'
{
  "messages": [
    {
      "id": "msg_sms_2DbBs7GWhGvVNJGrDXr5RG0mBWI",
      "systemPhoneNumberId": "ph_2DbBs7GWhGvVNJGrDXr5RG0mBWI",
      "systemPhoneNumber": "<string>",
      "fromPhoneNumber": "<string>",
      "text": "<string>",
      "subject": "<string>",
      "type": "SMS",
      "transport": "sms",
      "direction": "INBOUND",
      "receivedAt": "2023-11-07T05:31:56Z",
      "sentAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "recipients": [
        {
          "id": "rcpt_2DbBs7GWhGvVNJGrDXr5RG0mBWI",
          "phoneNumber": "<string>",
          "status": "QUEUED",
          "carrier": "<string>",
          "lineType": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "nextCursor": "msg_sms_2DbBs7GWhGvVNJGrDXr5RG0mBWI",
  "totalCount": 100
}

Authorizations

​
Authorization
string
header
required

Admin API key (format: sk_admin_*) for organization-level operations

Query Parameters

​
limit
string

Maximum number of items to return (default: 20)

Example:

"20"

​
cursor
string

KSUID-based cursor for pagination

Minimum string length: 27
Example:

"msg_sms_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

​
offset
string

Offset for pagination (fallback when cursor is not available)

Example:

"40"

​
direction
enum<string>
Available options:
INBOUND,
OUTBOUND
​
appId
string

Unique identifier for a App. Format: app_[test_]{ksuid}

Example:

"app_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

Response

List all SMS messages

​
messages
object[]
required
​
nextCursor
string | null
required

Cursor for the next page, or null if no more results

Minimum string length: 27
Example:

"msg_sms_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

​
totalCount
integer
required

Total number of items matching the query

Example:

100