Skip to main content
GET
/
contacts
/
stage-changes
Get contacts with changed stage
curl --request GET \
  --url https://api.reply.io/v3/contacts/stage-changes \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "contactId": "<string>",
      "previousStage": 3,
      "newStage": 3,
      "changedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "limit": 123
  }
}

Authorizations

​
X-API-Key
string
header
required

API key passed in the X-API-Key header

Query Parameters

​
fields
string

Comma-separated list of fields to include in the response. If not provided, all fields will be returned. For better performance, we recommend specifying only the fields you need.

Example:

"id,name,stage,previousStage"

​
since
string<date-time>

Retrieve stage changes since a specific timestamp

​
limit
integer
default:50

Number of records to return per page

Required range: x <= 500
​
offset
integer
default:0

Page number for pagination

Required range: x >= 0
​
fromStage
integer

Filter contacts that transitioned from a specific stage. Available stages:

1 = New 2 = Engaging 3 = Replied 4 = Interested 5 = Not interested 6 = Unresponsive 7 = Do not contact 8 = Bad contact info

​
toStage
integer

Filter contacts that transitioned to a specific stage. Available stages:

1 = New 2 = Engaging 3 = Replied 4 = Interested 5 = Not interested 6 = Unresponsive 7 = Do not contact 8 = Bad contact info

Response

Successfully retrieved stage history

​
data
object[]
​
pagination
object