Skip to main content
POST
/
v3
/
contacts
/
filter
Filter contacts
curl --request POST \
  --url https://api.reply.io/v3/contacts/filter \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rules": [
    {
      "property": "<string>",
      "condition": "<string>",
      "value": "<string>"
    }
  ],
  "listId": 123,
  "sequenceId": 123,
  "sequenceStepId": 123,
  "searchTerm": "<string>",
  "sortBy": "<string>",
  "sortDirection": "<string>"
}
'
{
  "items": [
    {
      "id": 12345,
      "email": "john.doe@company.com",
      "firstName": "John",
      "lastName": "Doe",
      "title": "Senior Product Manager",
      "company": "Tech Solutions Inc",
      "domain": "company.com",
      "companySize": "oneThousand",
      "city": "San Francisco",
      "state": "CA",
      "country": "United States",
      "timeZoneId": "America/Los_Angeles",
      "phone": "+1-415-555-0123",
      "phoneStatus": "valid",
      "linkedInUrl": "https://www.linkedin.com/in/johndoe",
      "linkedInSalesNavigatorUrl": "https://www.linkedin.com/sales/profile/123456",
      "linkedInRecruiterUrl": "https://www.linkedin.com/recruiter/profile/789012",
      "industry": "Software & Technology",
      "notes": "Met at SaaS Conference 2024",
      "ownerUserId": 42,
      "accountId": 100,
      "isOptedOut": false,
      "callStatus": "toCall",
      "meetingStatus": "none",
      "addingDate": "2024-03-08T10:00:00+00:00",
      "createdAt": "2024-03-08T10:00:00",
      "lastModifiedAt": "2024-03-10T15:30:00",
      "customFields": [
        {
          "key": "leadSource",
          "value": "Conference"
        },
        {
          "key": "budget",
          "value": "100k-250k"
        }
      ],
      "sequences": [
        {
          "sequenceId": 100,
          "sequenceName": "Sales Outreach",
          "status": "active",
          "currentStep": 2,
          "addingDate": "2024-03-08T10:00:00+00:00",
          "emailAccountId": 101,
          "linkedInAccountId": null
        }
      ],
      "lists": [
        {
          "listId": 10,
          "listName": "Hot Leads",
          "isShared": false
        }
      ]
    }
  ],
  "hasMore": true
}

Authorizations

​
Authorization
string
header
required

Authenticate every request with a Bearer token. Pass your Reply API key in the Authorization header:

Authorization: Bearer <your-api-key>

Get your API key from the Reply dashboard: Settings → API Key.

Query Parameters

​
top
integer

Maximum number of contacts to return (default 25, max 1000)

​
skip
integer

Number of contacts to skip

Body

application/json
​
rules
object[]
​
listId
integer | null

Filter by contact list ID

​
sequenceId
integer | null

Filter by sequence ID

​
sequenceStepId
integer | null

Filter by sequence step ID

​
searchTerm
string | null

Free-text search term

​
sortBy
string | null

Field to sort by

​
sortDirection
string | null

Sort direction (asc or desc)

Response

Filtered contacts retrieved successfully

​
items
Contact · object[]
​
hasMore
boolean

Indicates if there are more items to fetch