GET
/
v1
/
messages
curl --request GET \
  --url https://api.openphone.com/v1/messages \
  --header 'Authorization: <api-key>'
{
  "data": [
    {
      "id": "AC123abc",
      "to": [
        "+15555555555"
      ],
      "from": "+15555555555",
      "text": "Hello, world!",
      "phoneNumberId": "PN123abc",
      "direction": "incoming",
      "userId": "US123abc",
      "status": "sent",
      "createdAt": "2022-01-01T00:00:00Z",
      "updatedAt": "2022-01-01T00:00:00Z"
    }
  ],
  "totalItems": 123,
  "nextPageToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
phoneNumberId
string
required

The unique identifier of the OpenPhone number used to send or receive the messages. PhoneNumberID can be retrieved via the Get Phone Numbers endpoint.

Example:

"OP123abc"

​
userId
string

The unique identifier of the user the message was sent from.

Example:

"US123abc"

​
participants
string[]
required

Array of phone numbers involved in the conversation, excluding your OpenPhone number, in E.164 format.

A phone number in E.164 format, including the country code.

Example:

"+15555555555"

​
since
string
deprecated

DEPRECATED, use "createdAfter" or "createdBefore" instead. "since" currently behaves as "createdBefore" and will be removed in an upcoming release.

Example:

"2022-01-01T00:00:00Z"

​
createdAfter
string

Filter results to only include messages created after the specified date and time, in ISO_8601 format.

Example:

"2022-01-01T00:00:00Z"

​
createdBefore
string

Filter results to only include messages created before the specified date and time, in ISO_8601 format.

Example:

"2022-01-01T00:00:00Z"

​
maxResults
integer
default:10
required

Maximum number of results to return per page.

Required range: 1 <= x <= 100
​
pageToken
string

Response

200
application/json
Success
​
data
object[]
required
​
totalItems
integer
required

Total number of items available. ⚠️ Note: totalItems is not accurately returning the total number of items that can be paginated. We are working on fixing this issue.

​
nextPageToken
string | null
required

Was this page helpful?