Skip to main content

Get entities from CrmContacts

GET 
/CrmContacts

Get entities from CrmContacts

Request​

Query Parameters

    $top integer

    Show only the first n items

    $skip integer

    Skip the first n items

    $search string

    Search items by search phrases

    $filter string

    Filter items by property values

    $count boolean

    Include count of items

    $orderby string[]

    Possible values: [salutation, salutation desc, firstName, firstName desc, lastNamePrefix, lastNamePrefix desc, lastName, lastName desc, companyName, companyName desc, email, email desc, phone1, phone1 desc, phone2, phone2 desc, streetName, streetName desc, houseNumber, houseNumber desc, postalCode, postalCode desc, state, state desc, city, city desc, useParentAddress, useParentAddress desc, countryIso, countryIso desc, crmAccountId, crmAccountId desc, contactReference, contactReference desc, id, id desc, createdDate, createdDate desc, updatedDate, updatedDate desc, organizationId, organizationId desc, reference, reference desc, creatorId, creatorId desc, customField1, customField1 desc, customField2, customField2 desc, customField3, customField3 desc, customField4, customField4 desc, customField5, customField5 desc]

    Order items by property values

    $select string[]

    Possible values: [salutation, firstName, lastNamePrefix, lastName, companyName, email, phone1, phone2, streetName, houseNumber, postalCode, state, city, useParentAddress, countryIso, crmAccountId, contactReference, id, createdDate, updatedDate, organizationId, reference, creatorId, customField1, customField2, customField3, customField4, customField5, organization]

    Select properties to be returned

    $expand string[]

    Possible values: [*, organization]

    Expand related entities

Responses​

Retrieved entities

Schema

    value

    object[]

  • Array [

    • salutation string
    firstName string
    lastNamePrefix string
    lastName string
    companyName string

    This property are no longer synced from the contact.

    email string
    phone1 string
    phone2 string
    streetName string
    houseNumber string
    postalCode string
    state string
    city string
    useParentAddress boolean

    This property are no longer synced from the contact.

    countryIso string

    Possible values: <= 2 characters

    crmAccountId uuid
    contactReference string
    id uuid
    createdDate date-time
    updatedDate date-time
    organizationId uuid
    reference string
    creatorId uuid
    customField1 string
    customField2 string
    customField3 string
    customField4 string
    customField5 string
    organization

  • ]

Loading...