Skip to main content

List contacts

GET 
/contacts

List contacts

Request​

Query Parameters

    include_raw_data boolean

    Whether to include raw data fetched from the 3rd party provider.

    Example: true
    read_from_cache boolean

    Whether to read from Supaglue's Managed Destination cache or to read directly from the provider.

    NOTE: read_from_cache=true requires you to have the object synced to the Supaglue Managed Destination.

    Example: true
    modified_after date-time

    If provided, will only return objects modified after this datetime. Datetime must be in ISO 8601 format and URI encoded.

    Example: 2023-02-23T00:00:00Z
    page_size string

    Number of results to return per page. (Max: 1000)

    Example: 123
    cursor string

    The pagination cursor value

    Example: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
    associations_to_fetch string[]

    List of associated objects to attempt to fetch associations for. Only relevant for hubspot and when read_from_cache is false.

Header Parameters

    x-customer-id stringrequired

    The customer ID that uniquely identifies the customer in your application

    Example: my-customer-1
    x-provider-name stringrequired

    The provider name

    Example: salesforce

Responses​

Paginated Contacts

Schema
    pagination objectrequired
    next stringnullablerequired
    previous stringnullablerequired
    total_count number
    records object[]required
  • Array [
    • account_id stringnullablerequired
    owner_id stringnullablerequired
    addresses object[]required
  • Array [
    • address_type stringrequired

    Possible values: [primary, mailing, other, billing, shipping]

    city stringnullablerequired
    country stringnullablerequired
    postal_code stringnullablerequired
    state stringnullablerequired
    street_1 stringnullablerequired
    street_2 stringnullablerequired
  • ]
    • email_addresses object[]required
  • Array [
    • email_address stringrequired
    email_address_type stringrequired

    Possible values: [primary, work, other]

  • ]
    • first_name stringnullablerequired
    id stringrequired
    last_activity_at date-timenullablerequired
    last_name stringnullablerequired
    phone_numbers object[]required
  • Array [
    • phone_number stringnullablerequired
    phone_number_type stringrequired

    Possible values: [primary, mobile, fax, other]

  • ]
    • lifecycle_stage lifecycle_stagenullablerequired

    Possible values: [subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer, evangelist, other]

    created_at date-timenullablerequired
    updated_at date-timenullablerequired
    is_deleted booleanrequired
    last_modified_at date-timerequired
    raw_data object
    property name* any
  • ]
Loading...