Skip to content
BoxBilling

List customers

GET
/v1/customers/

List all customers with pagination.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
skip
Skip
integer
0
limit
Limit
integer
default: 100 >= 1 <= 1000
order_by
Any of:
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Response List Customers V1 Customers Get
Array<object>
CustomerResponse
object
id
required
Id
string format: uuid
external_id
required
External Id
string
name
required
Name
string
email
required
Any of:
string
currency
required
Currency
string
timezone
required
Timezone
string
billing_metadata
required
Billing Metadata
object
key
additional properties
any
invoice_grace_period
required
Invoice Grace Period
integer
net_payment_term
required
Net Payment Term
integer
billing_entity_id
Any of:
string format: uuid
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

401

Section titled “401 ”

Unauthorized – invalid or missing API key

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object