GET v1/{organizationId}/contacts?fields={fields}&queryFilter={queryFilter}&changesSince={changesSince}&deletedOnly={deletedOnly}&page={page}&pageSize={pageSize}

Retrieve a list of contacts for the organization order by UpdatedAt.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
fields

A comma separated list of fields to include in the response. Possible values are Name, ContactGuid, ExternalReference, IsPerson, Street, Zipcode, City, CountryKey, Phone, Email, Webpage, AttPerson, VatNumber, EanNumber, PaymentConditionType, PaymentConditionNumberOfDays, CreatedAt, UpdatedAt and DeletedAt. Notice that it's not case sensitive, the property name will be returned the way you request it. If left empty it defaults to name and contactGuid (notice small start letter).

string

Default value is name,contactGuid

queryFilter

Filter specific for contacts. Filtering can be applied to following fields: ExternalReference,Name, Email, VatNumber, EanNumber, IsPerson. See API documentation for filtering format. If left empty no filtering is applied.

string

None.

changesSince

[Generic Filter Option] Only return contacts that was created, deleted or updated at or after given time. If left empty, this filter will not be applied, and contacts will be returned regardless of change history. The time must be UTC and in the format 'YYYY-MM-DDTHH:mm:ssZ' example: '2015-08-18T06:36:22Z'.

string

None.

deletedOnly

[Generic Filter Option] Only select deleted contacts. If left empty, will default to false.

boolean

Default value is False

page

The 0-based page number

integer

Default value is 0

pageSize

The maximum number of items to include in a page. Maximum 1000.

integer

Default value is 100

organizationId

string

None.

Body Parameters

Response Information

Resource Description

200 (OK) Returns a collection of contacts (with only the requested fields).

DineroCollectionOfContact
NameDescriptionType
Collection

Collection containing the result of the request.

Collection of Contact
Pagination

Pagination information.

PaginationDetails
Sample:
{
  "Collection": [
    {
      "ContactGuid": "a1f86ce8-a73a-4e73-84b3-66d72725d39f",
      "CreatedAt": "2018-12-19T06:31:28.1111509+00:00",
      "UpdatedAt": "2018-12-19T06:31:28.1111509+00:00",
      "DeletedAt": "2018-12-19T06:31:28.1111509+00:00",
      "IsDebitor": true,
      "IsCreditor": true,
      "ExternalReference": "Fx. WebShopID:42",
      "Name": "John Doe",
      "Street": "Main road 42",
      "ZipCode": "2100",
      "City": "Copenhagen",
      "CountryKey": "DK",
      "Phone": "+45 99 99 99 99",
      "Email": "test@test.com",
      "Webpage": "test.com",
      "AttPerson": "Donald Duck",
      "VatNumber": "12345674",
      "EanNumber": "1111000022223",
      "PaymentConditionType": "Netto",
      "PaymentConditionNumberOfDays": 8,
      "IsPerson": false
    },
    {
      "ContactGuid": "a1f86ce8-a73a-4e73-84b3-66d72725d39f",
      "CreatedAt": "2018-12-19T06:31:28.1111509+00:00",
      "UpdatedAt": "2018-12-19T06:31:28.1111509+00:00",
      "DeletedAt": "2018-12-19T06:31:28.1111509+00:00",
      "IsDebitor": true,
      "IsCreditor": true,
      "ExternalReference": "Fx. WebShopID:42",
      "Name": "John Doe",
      "Street": "Main road 42",
      "ZipCode": "2100",
      "City": "Copenhagen",
      "CountryKey": "DK",
      "Phone": "+45 99 99 99 99",
      "Email": "test@test.com",
      "Webpage": "test.com",
      "AttPerson": "Donald Duck",
      "VatNumber": "12345674",
      "EanNumber": "1111000022223",
      "PaymentConditionType": "Netto",
      "PaymentConditionNumberOfDays": 8,
      "IsPerson": false
    }
  ],
  "Pagination": {
    "MaxPageSizeAllowed": 0,
    "PageSize": 0,
    "Result": 0,
    "ResultWithoutFilter": 0,
    "Page": 0
  }
}