Addresses
This method is used to fetch address details associated with user profiles. An address entry contains information like address type, creation and modification dates, contact details, and geographical identifiers such as country, city, and district.
Token-based authentication with required prefix "Token"
Query parameter address_type used to filter results based on specific conditions.
Query parameter city used to filter results based on specific conditions.
Query parameter company_name used to filter results based on specific conditions.
Query parameter country used to filter results based on specific conditions.
Query parameter created_date used to filter results based on specific conditions.
Query parameter district used to filter results based on specific conditions.
Query parameter e_bill_taxpayer used to filter results based on specific conditions.
Query parameter email used to filter results based on specific conditions.
Query parameter extra_field used to filter results based on specific conditions.
Query parameter first_name used to filter results based on specific conditions.
Query parameter hash_data used to filter results based on specific conditions.
Query parameter id used to filter results based on specific conditions.
Filters records where id is greater than the given value.
Filters records where id is greater than or equal to the given value.
Filters records where id is less than the given value.
Filters records where id is less than or equal to the given value.
Query parameter identity_number used to filter results based on specific conditions.
Query parameter is_active used to filter results based on specific conditions.
Query parameter last_name used to filter results based on specific conditions.
Limits the number of results returned in the response.
Query parameter line used to filter results based on specific conditions.
Query parameter modified_date used to filter results based on specific conditions.
Filters records where modified_date is greater than the given value.
Filters records where modified_date is greater than or equal to the given value.
Filters records where modified_date is less than the given value.
Filters records where modified_date is less than or equal to the given value.
Query parameter notes used to filter results based on specific conditions.
Query parameter page used to filter results based on specific conditions.
Query parameter phone_number used to filter results based on specific conditions.
Query parameter postcode used to filter results based on specific conditions.
Query parameter primary used to filter results based on specific conditions.
Query parameter remote_id used to filter results based on specific conditions.
Query parameter retail_store used to filter results based on specific conditions.
Query parameter sort used to filter results based on specific conditions.
Query parameter tax_no used to filter results based on specific conditions.
Query parameter tax_office used to filter results based on specific conditions.
Query parameter title used to filter results based on specific conditions.
Query parameter township used to filter results based on specific conditions.
Query parameter user used to filter results based on specific conditions.
Successful response for status code 200.
GET /api/v1/remote/1/data-warehouse/addresses/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response for status code 200.
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"address_type": "customer",
"city": 1,
"company_name": "text",
"country": 1,
"created_date": "2025-12-01T13:10:09.778Z",
"district": 1,
"e_bill_taxpayer": true,
"email": "[email protected]",
"extra_field": null,
"first_name": "text",
"hash_data": "text",
"id": 1,
"identity_number": "text",
"is_active": true,
"last_name": "text",
"line": "text",
"modified_date": "2025-12-01T13:10:09.778Z",
"notes": "text",
"phone_number": "text",
"postcode": "text",
"primary": true,
"remote_id": "text",
"retail_store": 1,
"tax_no": "text",
"tax_office": "text",
"title": "text",
"township": 1,
"user": 1
}
]
}This method is used to fetch address details associated with user profiles. An address entry contains information like address type, creation and modification dates, contact details, and geographical identifiers such as country, city, and district. This endpoint retrieves a specific record by its unique identifier.
Token-based authentication with required prefix "Token"
A unique integer value identifying this address.
Successful response for status code 200.
Object not found.
GET /api/v1/remote/1/data-warehouse/addresses/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"address_type": "customer",
"city": 1,
"company_name": "text",
"country": 1,
"created_date": "2025-12-01T13:10:09.778Z",
"district": 1,
"e_bill_taxpayer": true,
"email": "[email protected]",
"extra_field": null,
"first_name": "text",
"hash_data": "text",
"id": 1,
"identity_number": "text",
"is_active": true,
"last_name": "text",
"line": "text",
"modified_date": "2025-12-01T13:10:09.778Z",
"notes": "text",
"phone_number": "text",
"postcode": "text",
"primary": true,
"remote_id": "text",
"retail_store": 1,
"tax_no": "text",
"tax_office": "text",
"title": "text",
"township": 1,
"user": 1
}Was this helpful?