Skip to main content

List contacts

GET 
/salesforce/contacts

NOTE: To use the Data Listing API you need to use the Supaglue Managed Destination and select Standard Objects to be synced.

Request​

Query Parameters

    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

Header Parameters

    x-customer-id stringrequired

    The customer ID that uniquely identifies the customer in your application

    Example: my-customer-1

Responses​

Contacts

Schema
    pagination objectrequired
    next stringnullablerequired
    previous stringnullablerequired
    total_count number
    records object[]required
  • Array [
    • Id stringrequired

    The unique identifier for this contact.

    Description stringnullablerequired

    A description of the contact.

    Email stringnullablerequired

    The contact's email address.

    AccountId stringnullablerequired

    ID of the account that's the parent of this contact. This is a relationship field.

    FirstName stringnullablerequired

    The contact's first name up to 40 characters.

    HomePhone stringnullablerequired

    The contact's home phone number.

    IsDeleted booleanrequired

    Indicates whether the object has been moved to the Recycle Bin (true) or not (false).

    LastActivityDate date-timenullablerequired

    The date of the last activity on a contact. The LastActivityDate is set to whichever is more recent -- the LastActivityDate of a related task or event or the LastModifiedDate of a contact's record.

    LastName stringnullablerequired

    The contact's last name. Maximum size is 80 characters.

    LeadSource stringnullablerequired

    The source of the lead.

    MailingCity stringnullablerequired

    The city of the mailing address of this contact.

    MailingCountry stringnullablerequired

    The country of the mailing address of this contact.

    MailingPostalCode stringnullablerequired

    The postal code of the mailing address of this contact.

    MailingState stringnullablerequired

    The state of the mailijng address of this contact.

    MailingStreet stringnullablerequired

    The street of the mailing address of this contact.

    MobilePhone stringnullablerequired

    The contact's mobile phone number.

    OwnerId stringnullablerequired

    ID of the user who owns this contact. This is a relationship field.

    Phone stringnullablerequired

    The contact's phone number.

    Fax stringnullablerequired

    The contact's fax number.

    Title stringnullablerequired

    The contact's title.

    CreatedDate date-timerequired

    The date and time when this contact was created.

    SystemModstamp date-timerequired

    The date and time when this contact was last modified.

    raw_data objectrequired

    The raw data returned by the provider.

    property name* any

    The raw data returned by the provider.

  • ]
Loading...