Skip to main content
GET
A customer's addresses: where they are billed, where their goods are delivered, and the GSTIN registered at each.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

id
string
customer_id
string
code
string
name
string
address_line1
string
address_line2
string
city
string
postal_code
string
state_province_id
string
state_province
string
gst_state_code
string
country_id
string
country
string
access_notes
string
contact_phone
string
is_delivery_address
string
is_billing_address
string
gstin
string
is_active
string
one_line
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

access_notes
string<text>
address_line1
string<character varying>
Maximum string length: 200
address_line2
string<character varying>
Maximum string length: 200
city
string<character varying>
Maximum string length: 120
code
string<character varying>
Maximum string length: 60
contact_phone
string<character varying>
Maximum string length: 40
country
string<character varying>
Maximum string length: 150
country_id
string<uuid>
customer_id
string<uuid>
gst_state_code
string<character varying>
Maximum string length: 2
gstin
string<character varying>
Maximum string length: 15
id
string<uuid>

Note: This is a Primary Key.

is_active
boolean<boolean>
is_billing_address
boolean<boolean>
is_delivery_address
boolean<boolean>
name
string<character varying>
Maximum string length: 200
one_line
string<text>
postal_code
string<character varying>
Maximum string length: 30
state_province
string<character varying>
Maximum string length: 150
state_province_id
string<uuid>