List contacts

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

Query parameters

NameDescription
fields string

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).

Default value is name,contactGuid

queryFilter string

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.

changesSince string

[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'.

deletedOnly boolean

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

Default value is False

page integer

The 0-based page number

Default value is 0

pageSize integer

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

Default value is 100

organizationId string

Returns

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

NameDescription
Collection Contact[] Show model
NameDescription
Name string

Name of the contact person or the company name

Email string

Email address

Phone string

Phone number

IsPerson boolean

Boolean to indicate whether the contact is a private person or a company. If true, the contact is a person.

ContactGuid globally unique identifier

Our Guid

ExternalReference string

Your external id This can be used for ID'ing in external apps/services e.g. a web shop. The maximum length is 128 characters

CountryKey string

Country key Two character string e.g. DK for Denmark, DE for Germany or SE for Sweden

CreatedAt date

Time at which the Contact was created

UpdatedAt date

Time at which the Contact was last updated

DeletedAt date

Time at which the Contact was deleted

IsDebitor boolean

Is the contact a debitor

IsCreditor boolean

Is the contact a creditor

Street string

Street name

ZipCode string

Zip code

City string

City

Webpage string

Webpage address

AttPerson string

Name of the att. person in cases here the contact is a company. If IsPerson this should be NULL.

VatNumber string

VAT number. If IsPerson this should be NULL.

EanNumber string

EAN number. This number is used for digital invoicing. If IsPerson this should be NULL.

PaymentConditionType string

Type of the payment condition for the contact. Netto, NettoCash or CurrentMonthOut. If NettoCash, then PaymentConditionNumberOfDays should be null. Defaults to Netto.

PaymentConditionNumberOfDays integer

Number of days for payment for the contact. E.g. that the contact has 7 days until payment has to be made. This field depends on PaymentConditionType. If left empty, defaults to 8 for all other payment types then NettoCash.

UseCvr boolean

Boolean to indicate whether the contacts name and addres should be updated with data from CVR.

CompanyTypeKey string

String with the key of the company type. The following keys are allowed: EmptyCompanyType, SoleProprietorship, PrivateLimitedCompany, PublicLimitedCompany, GeneralPartnership, LimitedPartnership, LimitedLiabilityCooperative, LimitedLiabilityVoluntaryAssociation, LimitedLiabilityCompany, EntreprenurLimitedCompany, Union, VoluntaryUnion, SmallPersonallyOwnedCompany, TrustFund and Others.

Collection containing the result of the request.

Pagination PaginationDetails Show model
NameDescription
MaxPageSizeAllowed integer

Maximum number of result pr. page.

PageSize integer

Number of result pr. page.

Result integer

Number of results returned in the collection.

ResultWithoutFilter integer

Result count before pagination.

Page integer

The 0-based page number.

Pagination information.

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

Response Formats

{
  "Collection": [
    {
      "ContactGuid": "20571c2b-60c7-4003-9647-1d6a1d631f85",
      "CreatedAt": "2019-04-23T22:28:29.8065628+00:00",
      "UpdatedAt": "2019-04-23T22:28:29.8065628+00:00",
      "DeletedAt": "2019-04-23T22:28:29.8065628+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,
      "UseCvr": false,
      "CompanyTypeKey": "PrivateLimitedCompany"
    },
    {
      "ContactGuid": "20571c2b-60c7-4003-9647-1d6a1d631f85",
      "CreatedAt": "2019-04-23T22:28:29.8065628+00:00",
      "UpdatedAt": "2019-04-23T22:28:29.8065628+00:00",
      "DeletedAt": "2019-04-23T22:28:29.8065628+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,
      "UseCvr": false,
      "CompanyTypeKey": "PrivateLimitedCompany"
    }
  ],
  "Pagination": {
    "MaxPageSizeAllowed": 0,
    "PageSize": 0,
    "Result": 0,
    "ResultWithoutFilter": 0,
    "Page": 0
  }
}