GET
/
v1
/
messages

Authorizations

Authorization
string
headerrequired

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.

userId
string

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

participants
string[]
required

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

since
string
deprecated

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

createdAfter
string

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

createdBefore
string

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

maxResults
integer
default: 10required

Maximum number of results to return per page.

pageToken
string

Response

200 - application/json
data
object[]
required

Array of items

totalItems
integer
required

Total number of items available.

nextPageToken
string | null
required