v1

latestOpenAPI 3.0.02026-07-14800227.2 KB

Employees

Return a list of employee addresses.

This endpoint returns a list with the address sections of the existing employees. Additionally, custom fields from this section will also be included.

get/employees/addresses

Query parameters

streetstring

Example: Calle Enrique San Francisco 13

The name of the street.

postalCodestring

Example:28080

The postal code.

citystring

Example:Madrid

The city.

countrystring

Example:ES

The country code in ISO 3166-1 alpha-2.

houseNumberstring

Example:1-F

The house number.

additionalAddressstring

Example:Calle Henry Francisco 12

The additional address.

Headers

Authorizationstring required

Example:Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2FwaS5rZW5qby5pbyIsInN1YiI6IjYwZjBhOTE2MjE0OTg3MjU2YmU5YzhmZiIsImF1ZCI6Imh0dHBzOi8vYXBpLmtlbmpvLmlvIiwiaWF0IjoxNjI2Mzg1MTE1LCJuYmYiOjE2MjYzODUxMTUsImV4cCI6MTYyNjU1NzkxNSwiYWNjZXNzVHlwZSI6IkFwaUFjY2VzcyIsInNfb3JnSWQiOiI2MGYwNGVhN2RmN2JhMjFlY2U0YmYzYzIifQ.cxG_7dIS-VbmDXdJuLkekoyuyCIzQG2fMcgc0nkfbWE8cihhcb5FnALbQkjU9b5-qVcEoMHZlSuUA-jMEBMMVQ

A valid bearer token.

Response

Example response

{
  "data": [
    {
      "_id": "80a2db290da29e126a18789a",
      "street": "Calle Enrique San Francisco 13",
      "postalCode": "28080",
      "city": "Madrid",
      "country": "ES",
      "houseNumber": "1-F",
      "additionalAddress": "Calle Henry Francisco 12"
    },
    {
      "_id": "80a2db290da29e126a18789a",
      "street": "Marlon Brando St, 23-11",
      "postalCode": "34212",
      "city": "Paris",
      "country": "FR"
    },
    {
      "_id": "80a2db290da29e126a18789a",
      "street": "James Gandolfini St, 34",
      "postalCode": "34213",
      "city": "New Jersey",
      "country": "US"
    }
  ]
}