Client Addresses

Read Client Address

Reads a client address.

GET

/client-addresses/{id}

Read Client Address

curl --request GET \
  --url https://api.operating.app/v1/client-addresses/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "address1": "<string>",
    "address2": "<string>",
    "archivedAt": "<string>",
    "city": "<string>",
    "clientId": "<string>",
    "country": "<string>",
    "createdAt": "<string>",
    "description": "<string>",
    "externalAddresses": [
      {
        "createdAt": "<string>",
        "externalId": "<string>",
        "externalSystemName": "<string>",
        "name": "<string>",
        "updatedAt": "<string>"
      }
    ],
    "id": "<string>",
    "name": "<string>",
    "postalCode": "<string>",
    "state": "<string>",
    "updatedAt": "<string>"
  },
  "meta": {}
}

Client addresses represent addresses for a client.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

idstringrequired

Response

Successful response

dataobjectrequired

Show child attributes

metaobjectrequired

Still need help? Ask the team