Skip to main content
GET
/
v1
/
addresses
List Addresses
curl --request GET \
  --url https://live.copilot.fabric.inc/data-customer/v1/addresses \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'
{
  "query": {
    "offset": 0,
    "limit": 10,
    "count": 45
  },
  "data": [
    {
      "_id": "61604a30fdfacd0009816e44",
      "globalAddressId": 1234,
      "type": "M",
      "addressLine1": "street 1",
      "addressLine2": "street 2",
      "addressLine3": "street 3",
      "addressLine4": "street 4",
      "county": "San Diego",
      "city": "Boston",
      "state": "Texas",
      "zipCode": 12345,
      "postalCode": "ABC-123",
      "country": "USA",
      "latitude": 38.8951,
      "longitude": -77.0364,
      "additionalAttributes": {},
      "isDeleted": false,
      "createdAt": "2021-08-30T23:20:42.822Z",
      "updatedAt": "2021-08-30T23:20:42.822Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Headers

​
x-site-context
string
required
Example:

Query Parameters

​
offset
integer
Example:
​
limit
integer
Example:
​
id
string
Example:
​
globalAddressId
string
Example:
​
type
enum<string>
Available options:
M,
E,
P
Example:
​
filterField
string
Example:
​
filterValue
string
Example:

Response

​
query
object
​
data
FlatAddressResponse · object[]