List addresses

List addresses

GET https://api.complycube.com/v1/addresses?clientId=:id

This endpoint allows you to list all existing addresses for a given client. The addresses are returned sorted by creation date, with the most recent addresses appearing first.

Query Parameters

Name	Type	Description
clientId	string	The ID of the client.
<pagination>	string	The number of items to return and the number of pages to offset.
<filtering>	string	Filter the results.

Headers

Name	Type	Description
Authorization	string	The live or sandbox API key.

200 Addresses successfully retrieved.

{
    "page": 1,
    "pageSize": 100,
    "totalItems": 1,
    "pages": 1,
    "items": [
        {
            "id": "5eb1276f96be4a0008713af6",
            "clientId": "5eb1276d96be4a0008713af5",
            "type": "main",
            "propertyNumber": "Flat 57",
            "line": "Common street",
            "city": "Aldgate",
            "state": "London",
            "postalCode": "W10 11L",
            "country": "GB",
            "fromDate": "2007-09-01",
            "toDate": "2020-01-01",
            "createdAt": "2020-01-04T17:24:29.146Z",
            "updatedAt": "2020-01-04T17:13:10.712Z"
        }
    ]
}

400 An example of a Bad Request response, when the clientId is not provided.

{
    "type": "invalid_request",
    "message": "The query parameter 'clientId' is required"
}

You can use pagination and address filters for this endpoint.

Example request

cURL

curl -X GET https://api.complycube.com/v1/addresses?clientId={:clientId} \
     -H 'Authorization: <YOUR_API_KEY>'

Node.js

const { ComplyCube } = require("@complycube/api");

const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });

const addresses = await complycube.address.list("CLIENT_ID");

Python

from complycube import ComplyCubeClient
cc_api = ComplyCubeClient(api_key='<YOUR API KEY>')

my_addresses = cc_api.addresses.list('CLIENT_ID')

PHP

use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR API KEY>');
$addresses = $ccapi->address()->list($clientId);