Skip to main content

Get address list

GET 
/api/address/

Retrieves the complete list of addresses associated with a company.

Functionality:

  • Returns all addresses registered for the authenticated company
  • Supports pagination and sorting
  • Automatically marks the primary address (isDefault: true)

Use Cases:

  • Display the address list in user interfaces
  • Select an address for subsequent operations
  • Verify existing addresses before creating new ones

Usage Example:

curl -X GET 'https://api.demo.cargoffer.com/api/address' \
  -H 'X-API-KEY: your_api_key'

Request​

Responses​

List of addresses in paged format