Index all bookings

Request

Query Params

q

string

optional

Search query

overdue

boolean

optional

Filter by overdue return

with_insurance

boolean

optional

Filter booking with insurance

customer_ids[]

array[number]

optional

Filter by customer ids

item_ids[]

array[number]

optional

Filter by item ids

status[]

array[string]

optional

Filter by booking status

Allowed values:

draftingnegotiatingreservedongoingcompletedcanceled

payment_rental_status[]

array[string]

optional

Filter by payment rental status

Allowed values:

payment_rental_paidpayment_rental_unpaidpayment_rental_partially_paidpayment_rental_overpaid

payment_deposit_status[]

array[string]

optional

Filter by payment deposit status

Allowed values:

payment_deposit_no_depositpayment_deposit_to_collectpayment_deposit_collectedpayment_deposit_to_returnpayment_deposit_returned

limit

number

optional

Number of search results returned

offset

number

optional

Number of results to offset

order

enum<string>

optional

Order of the results

Allowed values:

ascdesc

sort

enum<string>

optional

Sort the results

Allowed values:

idstart_atcustomer_name

from

string <date>

optional

Filter booking duration from a date

to

string <date>

optional

Filter booking duration up to a date

Header Params

Authorization

string

optional

Bearer token from Auth0. required for accessing the endpoint.

Auth0-IdToken

string

optional

Id token from Auth0, optional for endpoint access.

Accept-Language

string

optional

Preferred language for the response content.

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

Filter bookings by with insurance

This response does not have a body.