Skip to main content

query contacts

GET 
/org/:orgId/contact/query

Query contacts with advanced filtering, sorting, and pagination using CRUD query language. Supports complex filters, sorting by multiple fields, and pagination.

Request​

Path Parameters

    orgId stringrequired

    Organization ID

Query Parameters

    page_size integer

    Number of items per page (default 20, max 1000)

    page_number integer

    Page number (default 1)

    q string

    LISP-style filter expression (e.g., '(= name \

    s string

    Sort fields: 'field:asc,field2:desc' or '-field,field2' format (e.g., 'creation_time:desc,name:asc' or '-creation_time,name')

Responses​

Paginated list of contacts

Schema

    data

    object[]

  • Array [

    • companyContactId string

    CompanyContactID holds the value of the "company_contact_id" field.

    creationTime date-time

    CreationTime holds the value of the "creation_time" field.

    emailAddress string

    EmailAddress holds the value of the "email_address" field.

    id string

    ID of the ent.

    info

    object

    companyLocation string
    companyName string

    enrichedContactInfo

    object

    Enriched contact information from enrichment service

    city string
    companyDomain string
    companyName string

    Company information

    country string

    Location information

    creationTime string

    Timestamps

    email string

    Contact information

    firstName string
    id string

    Core identification fields

    info

    object

    Additional structured information

    workExperiences

    object[]

  • Array [

    • current boolean

    true if the work experience is current

    endDate string
    organizationName string
    startDate string
    title string

  • ]

    • jobFunction string
    jobTitle string

    Professional information

    lastName string
    lastUpdateTime string
    linkedIn string
    name string
    phone string
    s3KeyPicture string

    Media and social

    status EnrichmentDataStatus (string)

    Possible values: [active, stale, archived]

    active/stale/archived

    twitter string
    lastModifiedBy string
    partner Partner (string)

    Possible values: [``, ADYEN, ALIBABA, ANTHROPIC, AWS, AWS_CHINA, AZURE, CHARGEBEE, DATABRICKS, DOCUSIGN, GCP, GOOGLE, HUBSPOT, INTUIT, LAGO, MARKETO, METRONOME, MICROSOFT, OPENAI, ORACLE, ORB, REDHAT, SALESFORCE, SLACK, SNOWFLAKE, STRIPE, ZOHO]

    phoneNumber string
    role string
    lastUpdateTime date-time

    LastUpdateTime holds the value of the "last_update_time" field.

    name string

    Name holds the value of the "name" field.

    organizationID string

    OrganizationID holds the value of the "organization_id" field.

  • ]

    • page_number integer
    page_size integer
    total_count integer
Loading...