Skip to main content

Get List of customers

Get List of customers

Query Parameters
offset string

Possible values: Value must match regular expression \d+

Index of beginning of pagination

limit string

Possible values: Value must match regular expression \d+

Number of items to display

type string

Possible values: Value must match regular expression 0|1

Type of customer (particular = 0 , profissional = 1)

enabled string

Possible values: Value must match regular expression true|false

Customer state

in-debt string

Possible values: Value must match regular expression true|false

Customer in debt (true or false)

query string

Search customers according to query (by name, reference, email)

Responses
200

Returns a collection of customers

Schema OPTIONAL
count integer OPTIONAL
countArchived integer OPTIONAL
countEnabled integer OPTIONAL
rows object[] OPTIONAL
id integer OPTIONAL
name string OPTIONAL
phone1 string OPTIONAL
phone2 string OPTIONAL
phone3 string OPTIONAL
type integer OPTIONAL
email string OPTIONAL
contact_address object[] OPTIONAL
id integer OPTIONAL
address object OPTIONAL
id integer OPTIONAL
address string OPTIONAL
zip_code string OPTIONAL
region string OPTIONAL
country string OPTIONAL
type integer OPTIONAL
is_default boolean OPTIONAL
fax string OPTIONAL
registration string OPTIONAL
company_name string OPTIONAL
reference string OPTIONAL
enabled boolean OPTIONAL
debt string OPTIONAL
turnover string OPTIONAL
debit string OPTIONAL
credit string OPTIONAL
balance string OPTIONAL
contact_phones object[] OPTIONAL
id integer OPTIONAL
type integer OPTIONAL
country string OPTIONAL
value string OPTIONAL
is_default boolean OPTIONAL
display_in_doc boolean OPTIONAL