Skip to main content

Get a list of contacts​

Retrieve a paged collection of contacts (required scope contacts:read)

Query Parameters
    sortBy ContactSortOptions

    Possible values: [name, createdAt]

    The field to sort items in the page by

    direction SortDirection

    Possible values: [ascending, descending]

    The direction to apply the sort

    status AccountStatus

    Possible values: [normal, contactOnStop, creditLimitOnStop]

    Only return contacts where status matches the value provided

    name string

    Only return contacts where name matches or starts with the value provided

    reference string[]

    Only return contacts where reference matches the value(s) provided

    id int64[]

    Only return contacts where id matches the value(s) provided

    parentId int64[]

    Only return contacts where parentId matches the value(s) provided

    groupId int64[]

    Only return contacts where groupId matches the value(s) provided

    pageNumber int32

    Possible values: >= 1 and <= 2147483

    The page number being requested (minimum: 1, maximum: 2147483)

    pageSize int32

    Possible values: >= 1 and <= 1000

    The page size being requested (minimum: 1, maximum: 1000)

Header Parameters
    Customer-Id int64 required

    The customer identifier

Responses

Success

Schema
    items object[]

    The items returned for the requested page

  • Array [
    • id int64

    The unique identifier of the contact

    createdAt date-time

    The UTC timestamp of when this contact was created

    modifiedAt date-time

    The UTC timestamp of when this contact was modified

    reference string

    The internal reference of the contact - should usually be unique

    name string

    The name of the contact

    groupId int64

    The unique identifier of the group this contact belongs to

    parentId int64 nullable

    The unique identifier of the parent contact of this contact

    extraInformation string

    A free text description about the contact

    street string

    The contact street address

    town string

    The contact address town / city / village / locality

    postalCode string

    The contact address postcode or zipcode

    country string

    The textual name of the contact address country

    location object

    Represents a geographical location

    latitude double required

    Latitude of the center of the location

    longitude double required

    Longitude of the center of the location

    accountStatus AccountStatus

    Possible values: [normal, contactOnStop, creditLimitOnStop]

    The status of the contact (if they are on stop)

    Possible values:

    • normal: Normal
    • contactOnStop: Contact is on stop
    • creditLimitOnStop: Credit limit is on stop

    stopReason string

    If the contact status has been set to on stop, a textual description explaining why

    stoppedAt date nullable

    The date that this contact was placed on stop

    customFields object[]

    Custom fields associated with the contact

  • Array [
    • definitionId int64

    The unique identifier of the associated custom field definition

    value string nullable

    The current value set for the custom field

    definition object

    Represents the definition of a custom field

    caption string

    The caption of a custom field

    type CustomFieldType

    Possible values: [boolean, integer, decimal, text, list, statement, date, note, time, systemList]

    The type of the custom field. New field types may be added in the future, so integrations should be resilient to this

    Possible values:

    • boolean: Indicates a boolean field (Example: "false")
    • integer: Indicates an integer numeric field (Example: "1001")
    • decimal: Indicates a floating point numeric field (Example: "1.42")
    • text: Indicates an editable text field (Example: "Purple")
    • list: Indicates a field with a single value from a predefined list of options (Example: "Purple")
    • statement: Indicates a text field that cannot be edited. The value is always equal to the default value (Example: "By signing this you agree to the following...")
    • date: Indicates a date field, which will be represented as an RFC3339 formatted date string. The default value is not supported for this type and will always be null (Example: "2024-01-31")
    • note: Indicates a multiline, editable text field. Lines are seperated with a line feed character (Example: "This is a note.")
    • time: Indicates a time field, formatted as HH:mm. The default value is not supported for this type and will always be null (Example: "10:30")
    • systemList: Indicates the ID of a related resource, vehicle or web user (Example: "228007")

    listOptions string[] nullable

    Shows the possible values for a list type custom field. Value will be null if type is not list

    isRequired boolean

    Indicates if the field is required in the UI. This is NOT enforced in the API

    isEditable boolean

    Indicates if the field is editable

    default string nullable

    The default value of a custom field. Formatted in accordance with the rules of the field type

    systemListValueMetadata object

    Represents details of custom field value of type system list

    label string nullable

    A descriptive label for the specific resource, vehicle or web user that this system list value relates to

    entityType CustomFieldSystemListType

    Possible values: [resource, vehicle, webUser]

    The type of entity used for custom field value of type system list

    Possible values:

    • resource
    • vehicle
    • webUser

  • ]
  • ]
    • pageNumber int32

    The page number of the response where 1 is the first page

    pageSize int32

    The number of items requested for the current page

    pageItemCount int32

    The number of items returned in the current page

Loading...