Addresses

get

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.

Authorizations

Query parameters

address_typestringOptional

Query parameter address_type used to filter results based on specific conditions.

cityintegerOptional

Query parameter city used to filter results based on specific conditions.

company_namestringOptional

Query parameter company_name used to filter results based on specific conditions.

countryintegerOptional

Query parameter country used to filter results based on specific conditions.

created_datestring · date-timeOptional

Query parameter created_date used to filter results based on specific conditions.

districtintegerOptional

Query parameter district used to filter results based on specific conditions.

e_bill_taxpayerbooleanOptional

Query parameter e_bill_taxpayer used to filter results based on specific conditions.

emailstringOptional

Query parameter email used to filter results based on specific conditions.

extra_fieldany | nullableOptional

Query parameter extra_field used to filter results based on specific conditions.

first_namestringOptional

Query parameter first_name used to filter results based on specific conditions.

hash_datastringOptional

Query parameter hash_data used to filter results based on specific conditions.

idintegerOptional

Query parameter id used to filter results based on specific conditions.

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

Filters records where id is greater than or equal to the given value.

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

Filters records where id is less than or equal to the given value.

identity_numberstringOptional

Query parameter identity_number used to filter results based on specific conditions.

is_activebooleanOptional

Query parameter is_active used to filter results based on specific conditions.

last_namestringOptional

Query parameter last_name used to filter results based on specific conditions.

limitintegerOptional

Limits the number of results returned in the response.

linestringOptional

Query parameter line used to filter results based on specific conditions.

modified_datestring · date-timeOptional

Query parameter modified_date used to filter results based on specific conditions.

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

Filters records where modified_date is greater than or equal to the given value.

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

Filters records where modified_date is less than or equal to the given value.

notesstringOptional

Query parameter notes used to filter results based on specific conditions.

pageintegerOptional

Query parameter page used to filter results based on specific conditions.

phone_numberstringOptional

Query parameter phone_number used to filter results based on specific conditions.

postcodestringOptional

Query parameter postcode used to filter results based on specific conditions.

primarybooleanOptional

Query parameter primary used to filter results based on specific conditions.

remote_idstringOptional

Query parameter remote_id used to filter results based on specific conditions.

retail_storeintegerOptional

Query parameter retail_store used to filter results based on specific conditions.

sortstringOptional

Query parameter sort used to filter results based on specific conditions.

tax_nostringOptional

Query parameter tax_no used to filter results based on specific conditions.

tax_officestringOptional

Query parameter tax_office used to filter results based on specific conditions.

titlestringOptional

Query parameter title used to filter results based on specific conditions.

townshipintegerOptional

Query parameter township used to filter results based on specific conditions.

userintegerOptional

Query parameter user used to filter results based on specific conditions.

Responses

200

Successful response for status code 200.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/remote/1/data-warehouse/addresses/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

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-06-27T08:36:10.472Z",
      "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-06-27T08:36:10.472Z",
      "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
    }
  ]
}

get

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.

Authorizations

Path parameters

idintegerRequired

A unique integer value identifying this address.

Responses

200

Successful response for status code 200.

application/json

404

Object not found.

application/json

get

HTTPcURLJavaScriptPython

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-06-27T08:36:10.472Z",
  "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-06-27T08:36:10.472Z",
  "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
}