Skip to main content
GET
/
accounting
/
contacts
cURL
curl --request GET \
  --url https://api.maesn.dev/accounting/contacts \
  --header 'X-ACCOUNT-KEY: <x-account-key>' \
  --header 'X-API-KEY: <x-api-key>'
{
  "meta": {
    "warnings": [
      "Field not used by target system"
    ],
    "pagination": {
      "total": 123,
      "perPage": 123,
      "currentPage": 123,
      "totalPages": 123
    }
  },
  "data": [
    {
      "id": "92c4f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b",
      "addresses": [
        {
          "addressLine1": "Lucky street 1",
          "addressLine2": "2nd floor",
          "city": "Berlin",
          "countryCode": "DE",
          "postalCode": "10243",
          "type": "BILLING"
        }
      ],
      "companyName": "maesn",
      "contactType": "CONTACT_PERSON",
      "contactPersons": [
        {
          "emailAddresses": [
            {
              "email": "john.doe@company.com",
              "type": "BUSINESS"
            }
          ],
          "firstName": "John",
          "lastName": "Doe",
          "phoneNumbers": [
            {
              "number": "+49 7163307056",
              "type": "MOBILE"
            }
          ],
          "salutation": "Mr"
        }
      ],
      "documentId": "Z1248601M",
      "emailAddresses": [
        {
          "email": "john.doe@company.com",
          "type": "BUSINESS"
        }
      ],
      "number": "1042",
      "phoneNumbers": [
        {
          "number": "+49 7163307056",
          "type": "MOBILE"
        }
      ],
      "projectId": "3",
      "updatedDate": "2018-01-01T13:00:00.000Z",
      "vatId": "DE123456789"
    }
  ]
}

Field support per integration

Please ensure the query parameter environmentName is accurately populated with the appropriate environment. You can obtain this value by using the GET Environments endpoint available under the Authentication section.
Supported filters: noneSupport pagination: trueSupport rawData: true
Supported Response Fields:
id
string
contactType
enum
Available options: CONTACT_PERSON, COMPANY
companyName
string
contactPersons
ContactPerson[]
addresses
Address[]
emailAddresses
EmailAddress[]
phoneNumbers
PhoneNumber[]
updatedDate
string
Supported filters:
  • lastModifiedAt
Support pagination: trueSupport rawData: true
Supported Response Fields:
id
string
contactType
enum
Available options: CONTACT_PERSON, COMPANY
companyName
string
contactPersons
ContactPerson[]
addresses
Address[]
emailAddresses
EmailAddress[]
number
string
phoneNumbers
PhoneNumber[]
updatedDate
string
Supported filters: noneSupport pagination: trueSupport rawData: true
Supported Response Fields:
id
string
contactType
enum
Available options: CONTACT_PERSON, COMPANY
companyName
string
contactPersons
ContactPerson[]
addresses
Address[]
emailAddresses
EmailAddress[]
phoneNumbers
PhoneNumber[]
If you’re not using the Interactive Authentication Flow, make sure the query parameter companyId is correctly populated. You can obtain this value by using the GET Companies endpoint available under the Authentication section.
Supported filters:
  • lastModifiedAt
Support pagination: trueSupport rawData: true
Supported Response Fields:
id
string
contactType
enum
Available options: CONTACT_PERSON, COMPANY
companyName
string
contactPersons
ContactPerson[]
addresses
Address[]
emailAddresses
EmailAddress[]
phoneNumbers
PhoneNumber[]
updatedDate
string
Supported filters:
  • lastModifiedAt
Support pagination: trueSupport rawData: true
Supported Response Fields:
id
string
contactType
enum
Available options: UNDEFINED
companyName
string
contactType
enum
Available options: CONTACT_PERSON, COMPANY
addresses
Address[]
emailAddresses
EmailAddress[]
phoneNumbers
PhoneNumber[]
updatedDate
string
vat
string
Xero allows up to six contact persons per company.
Supported filters:
  • lastModifiedAt
Support pagination: trueSupport rawData: true
Supported Response Fields:
id
string
contactType
enum
Available options: UNDEFINED
companyName
string
contactPersons
ContactPerson[]
addresses
Address[]
phoneNumbers
PhoneNumber[]
updatedDate
string

Headers

X-API-KEY
string
required

API key

X-ACCOUNT-KEY
string
required

Account key

Query Parameters

page
number
limit
enum<number>
Available options:
5,
10,
20,
50,
100
companyId
string
environmentName
string
lastModifiedAt
string
rawData
boolean

Response

200 - application/json
meta
object
data
object[]
I