Find contacts

GET

api

contacts

Find contacts

curl --request GET \
  --url http://localhost:3000/api/v1/contacts

{
  "contacts": [
    {
      "id": "68234731e6074232892d18c4",
      "companyName": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "address": "<string>",
      "postCode": "3700 Spiez",
      "position": "<string>",
      "email": "jsmith@example.com",
      "mobile": "<string>",
      "phone": "<string>",
      "website": "<string>",
      "category": "clients",
      "formOfAddress": "<string>",
      "note": "<string>",
      "vatNumber": "<string>",
      "country": "<string>",
      "secondaryAddressLine": "<string>"
    }
  ]
}

Query Parameters

limit

number

Pagination limit for the results

skip

number

Pagination offset for the results

Response

Successfully returns a list of contacts.

contacts

Contact · object[]

Show child attributes

contacts.id

string

A unique hex identifier for the transaction.

Example:

"68234731e6074232892d18c4"

contacts.companyName

string

The company name associated with this contact.

For contacts which represent companies, this is used as the name of the contact.

Maximum string length: 48

contacts.firstName

string

The given name of this contact.

Maximum string length: 48

contacts.lastName

string

The surname of this contact.

Maximum string length: 48

contacts.address

string

The main address line of the contact.

Maximum string length: 48

contacts.postCode

string

The postal line text for this contact, including a ZIP code and place.

Example:

"3700 Spiez"

contacts.position

string

The position of the contact person within their company.

Maximum string length: 48

contacts.email

string<email>

The email address of the contact person. Must be a valid e-mail address or empty.

Maximum string length: 48

contacts.mobile

string

The mobile phone number of the contact person.

Maximum string length: 24

contacts.phone

string

The phone number of the contact person.

Maximum string length: 24

contacts.website

string

The website of this contact. Must be a valid URL.

Maximum string length: 128

contacts.category

enum<string>

An optional category to associate this contact with.

Available options:

clients,

suppliers,

partners,

team,

leads

contacts.formOfAddress

string

The form of address of the contact person, e.g. “Dr. med.“

Maximum string length: 24

contacts.note

string

A custom plain-text note for this contact. May be multi-line.

Maximum string length: 2000

contacts.vatNumber

string

An optional VAT registry number for this company. Is not validated for any specific format to allow entering values for formats of arbitrary countries.

Maximum string length: 24

contacts.country

string

Display name of the country of this contact.

Maximum string length: 24

contacts.secondaryAddressLine

string

An optional secondary address line for the location of this contact.

Maximum string length: 48

Get specific contactGet a specific contact by contact id.

⌘I

Find contacts

curl --request GET \
  --url http://localhost:3000/api/v1/contacts

{
  "contacts": [
    {
      "id": "68234731e6074232892d18c4",
      "companyName": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "address": "<string>",
      "postCode": "3700 Spiez",
      "position": "<string>",
      "email": "jsmith@example.com",
      "mobile": "<string>",
      "phone": "<string>",
      "website": "<string>",
      "category": "clients",
      "formOfAddress": "<string>",
      "note": "<string>",
      "vatNumber": "<string>",
      "country": "<string>",
      "secondaryAddressLine": "<string>"
    }
  ]
}

For developers

Accounting

Contacts

Query Parameters

Response