GET
/
v1
/
conversations
curl --request GET \
  --url https://api.openphone.com/v1/conversations \
  --header 'Authorization: <api-key>'
{
  "data": [
    {
      "assignedTo": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "lastActivityAt": "2023-11-07T05:31:56Z",
      "lastActivityId": "<string>",
      "mutedUntil": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "participants": [
        "+15555555555"
      ],
      "phoneNumberId": "<string>",
      "snoozedUntil": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "totalItems": 123,
  "nextPageToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
phoneNumber
deprecated

DEPRECATED, use phoneNumbers instead. If both phoneNumber and phoneNumbers are provided, phoneNumbers will be used. Filters results to only include conversations with the specified OpenPhone phone number. Can be either your OpenPhone phone number ID or the full phone number in E.164 format.

Example:

"+15555555555"

​
phoneNumbers
string[]

Filters results to only include conversations with the specified OpenPhone phone numbers. Each item can be either an OpenPhone phone number ID or a full phone number in E.164 format.

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

Example:
["+15555555555", "PN123abc"]
​
userId
string

The unique identifier of the user the making the request. Used to filter results to only include the user's conversations.

Example:

"US123abc"

​
createdAfter
string

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

Example:

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

​
createdBefore
string

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

Example:

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

​
excludeInactive
boolean

Exclude inactive conversations from the results.

Example:

true

​
updatedAfter
string

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

Example:

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

​
updatedBefore
string

Filter results to only include conversations updated 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?