Skip to main content
GuidesAPI Reference

List Contacts

GET 
/crm/contacts

List contacts based on a given criteria

Request​

Query Parameters

    credentialId stringrequired

    The ID of the credential.

    pageNumber string

    The page number of the results. Default is 1.

    pageSize int32

    The maximum number of results to show on a page. Default is 50. Maximum is 100.

    firstName string

    Filter contacts by the exact first name.

    firstNameContains string

    Filter contacts whose first name contains the specified string.

    firstNameNotEquals string

    Filter contacts whose first name is not the specified string.

    lastName string

    Filter contacts by the exact last name.

    lastNameContains string

    Filter contacts whose last name contains the specified string.

    lastNameNotEquals string

    Filter contacts whose last name is not the specified string.

    account string

    Filter contacts associated with a specific account by the exact account name or ID.

    accountContains string

    Filter contacts associated with an account whose name or ID contains the specified string.

    accountNotEquals string

    Filter contacts not associated with the account specified by name or ID.

    lastActivityAt string

    Filter accounts based on the timestamp of the last activity. Typically, this would be a date string or timestamp.

    remoteCreatedAtMin date

    Filter objects created in the third-party application after a specified date.

    remoteCreatedAtMax date

    Filter objects created in the third-party application before a specified date.

    remoteUpdatedAtMin date

    Filter objects last updated in the third-party application after a specified date.

    remoteUpdatedAtMax date

    Filter objects last updated in the third-party application before a specified date.

    createdAtMin date

    Filter objects created after a specified date.

    createdAtMax date

    Filter objects created before a specified date.

    updatedAtMin date

    Filter objects last updated after a specified date.

    updatedAtMax date

    Filter objects last updated before a specified date.

Header Parameters

    Authorization stringrequired

    Default value: bearer YOUR_API_KEY

Responses​

200

Schema

    contacts

    object[]

  • Array [

    • remoteId string
    firstName string
    lastName string
    account

    addresses

    object[]

  • Array [

    • addressType string

  • ]

    • emailAddresses array
    phoneNumbers array
    lastActivityAt string
    id string
    remoteCreatedAt string
    remoteUpdatedAt string
    remoteDeleted boolean

    Default value: true

    createdAt string
    updatedAt string

  • ]

Loading...