Organization | Addresses

Retrieve a single address by its id.

get

Authorizations

ApiKey

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

addressIdinteger · int32Required

The identifier of the address.

Responses

200

OK: The requested address.

application/json

Postal address for the shipment of goods or invoices.

line1string · max: 100 · nullableOptional

First line of the address. e.g. company name or P.O. box.

Example: equipme GmbH

streetstring · max: 100 · nullableOptional

The street name of the address.

Example: W 55th St

numberstring · max: 30 · nullableOptional

The alphanumeric house number in the street.

Example: 240

additionstring · max: 1500 · nullableOptional

Addition to the address (line 3) to provide further information for delivery.

Example: 3rd floor

citystring · max: 100 · nullableOptional

The city name of the address.

Example: New York

postalCodestring · max: 30 · nullableOptional

The alphanumeric postal code or zip of the address.

Example: 10019

countryCodestring · max: 2 · nullableOptional

ISO-3166-1 code of the country.

Example: US

regionCodestring · max: 10 · nullableOptional

ISO-3166-2 code of the region / administrative area. Required e.g. in USA, Canada, Australia or Italy.

Example: NY

regionNamestring · max: 100 · nullableOptional

Name of the region / administrative area (if no ISO code is given/existing).

Example: New York

dependentLocalitystring · max: 200 · nullableOptional

A dependent locality is an address element that distinguishes a premise when an address thoroughfare appears more than once in the same post town. PAF holds details of approximately 30,000 localities within the UK.

Example: Chilmington Green

phoneNumberstring · max: 50 · nullableOptional

Phone number of the address. Used primarily for delivery purposes.

Example: [phone]

idinteger · int64Required

The id to identify the address in the system.

Example: 83

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid api key.

application/json

403

Forbidden: Resource access denied or resource does not exist anymore.

application/json

404

NotFound: Requested resource could not be found.

application/json

get/v1/organization/addresses/{addressId}

HTTPcURLJavaScriptPython

GET /v1/organization/addresses/{addressId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "line1": "equipme GmbH",
  "street": "W 55th St",
  "number": 240,
  "addition": "3rd floor",
  "city": "New York",
  "postalCode": 10019,
  "countryCode": "US",
  "regionCode": "NY",
  "regionName": "New York",
  "dependentLocality": "Chilmington Green",
  "phoneNumber": "[phone]",
  "id": 83,
  "self": {
    "href": "text",
    "method": "text"
  }
}