Core API
...
Core API Docs
Customers
List Customer Addresses
GET
PATH PARAMETERS
id
string
*Either the Internal or External ID
HEADER PARAMETERS
Site-Id
string
*Example: jones-climbing
Spark Layer Site ID
RESPONSES
200
Successful response
Address-2[]
id
string
Example: ca_123
Address ID (always prefixed with ca_)
title
string
Example: Mr
Title
first_name
string
Example: Bob
First Name
last_name
string
Example: Jones
Last Name
company
string
Example: Tom Jones Climbing Ltd
Company
address_line1
string
*Example: Example Industrial Estate
Address Line 1
address_line2
string
Example: North Country
Address Line 2
city
string
*Example: Cityland
City
region_code
string
Example: CA
Region
postal_code
string
Example: 12345
Postal Code
country_code
string
*Example: USA
Country Code
phone
string
Example: +44 (0) 123456789
Phone
mobile
string
Example: +44 (0) 723456789
Phone - Mobile
external_id
string
Example: ADD1234567
External ID (cannot start with ca_ and must be unique)
nickname
string
Example: Warehouse - Cityland
Nickname
default
Error Response
Updated 18 Sep 2023
Did this page help you?