Customer
Search for Customers
Returns customers filtered by query string parameters. Atleast one variable must be provided to do the search. All the customers meeting the search criteria will be returned
GET
/
v1
/
c
/
customer
Authorizations
wb-key
string
headerrequiredQuery Parameters
id
string
Unique identifier of an object. Consists of object class prefix and a UUID
email
string | null
customer_reference
string | null
plan
string
Unique identifier of an object. Consists of object class prefix and a UUID
status
string | null
listed
string | null
search
string | null
contract_plan_name
string | null
payment_status
enum<string>
Status of the invoice:
- PendingValidation - Invoice awaits manual review
- ReadyForPayment - invoice can be paid
- Paid - invoice was paid
Available options:
pending_validation
, ready_for_payment
, paid
limit
integer
offset
string | null
direction
enum<string>
Pagination direction:
- Forward - from first entry to last
- Backward - from last entry to first
Available options:
forward
, backward
Response
200 - application/json
backward
string
Index of the previous page in the result set
current_page
integer
requiredNumber of the current page
first
string
Index of the first element in the result set
forward
string
Index of the next page in the result set
hits
object[]
requiredlast
string
Index of the last element in the result set
total
integer
requiredTotal number of results
total_pages
integer
requiredNumber of pages in the result