Skip to main content
GET
/
public
/
v2
/
contacts
/
lookup-by-custom-field
cURL
curl --request GET \
  --url https://api.example.com/public/v2/contacts/lookup-by-custom-field
{
  "count": 123,
  "total_pages": 123,
  "current_page": 123,
  "page_size": 123,
  "results": [
    {
      "id": 123,
      "updated_time": "2023-11-07T05:31:56Z",
      "contact_custom_fields": "<string>",
      "first_campaign_email_sent": "2023-11-07T05:31:56Z",
      "last_campaign_email_sent": "2023-11-07T05:31:56Z",
      "last_reply_received": "2023-11-07T05:31:56Z",
      "previous_status": "<string>",
      "status_changed_at": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "linkedin_url": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "company_id": 123,
      "origin": "<string>",
      "contact_status": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.revyops.com/llms.txt

Use this file to discover all available pages before exploring further.

Query Parameters

​
field_name
string
required

Name of the custom field to search for

​
field_value
string
required

Value of the custom field to search for

​
page
integer

Page number (1-based)

​
page_size
integer

Number of contacts per page (max 100)

​
structure
enum<string>
default:NESTED

Format of custom fields in response. NESTED returns array of objects with id, field_name, field_value. FLAT returns object with field names as keys.

Available options:
FLAT,
NESTED

Response

Paginated list of contacts

​
count
integer
required
​
total_pages
integer
required
​
current_page
integer
required
​
page_size
integer
required
​
results
object[]
required