Booqable

Booqable integration (Productivity, Data). Imported from open-connector.

API key10 toolshttps://{company_slug}.booqable.com/api/4

GET

booqable_get_current_company

Fetch the current Booqable company connected to the access token.

/companies/current

2 parameters

Param	Type	Required	Description
fields	object	optional	Booqable fields keyed by resource type, for example { customers: "id,name" }.
extraFields	object	optional	Booqable extra fields keyed by resource type, for example { companies: "subscri…

GET

booqable_list_customers

List Booqable customers with optional fields, filters, includes, and paging.

/customers

7 parameters

Param	Type	Required	Description
fields	object	optional	Booqable fields keyed by resource type, for example { customers: "id,name" }.
filter	object	optional	Booqable filter object. Nested operators are encoded as filter[field][operator].
include	string	optional	Comma-separated Booqable relationships to sideload.
meta	object	optional	Booqable meta aggregation object. Arrays are encoded with bracket query paramet…
pageNumber	integer	optional	The Booqable page number to request.
pageSize	integer	optional	The number of Booqable records to request per page.
sort	string	optional	Booqable sort expression such as created_at or -created_at.

POST

booqable_search_customers

Run a Booqable advanced search over customers.

/customers/search

1 parameter

Param	Type	Required	Description
search	object	optional	The Booqable advanced-search JSON body, usually containing filter.conditions an…

GET

booqable_get_customer

Fetch one Booqable customer by id.

/customers/{customerId}

3 parameters

Param	Type	Required	Description
customerId	string	required	The Booqable customer id.
fields	object	optional	Booqable fields keyed by resource type, for example { customers: "id,name" }.
include	string	optional	Comma-separated Booqable relationships to sideload.

GET

booqable_list_orders

List Booqable orders with optional fields, filters, includes, and paging.

/orders

7 parameters

Param	Type	Required	Description
fields	object	optional	Booqable fields keyed by resource type, for example { customers: "id,name" }.
filter	object	optional	Booqable filter object. Nested operators are encoded as filter[field][operator].
include	string	optional	Comma-separated Booqable relationships to sideload.
meta	object	optional	Booqable meta aggregation object. Arrays are encoded with bracket query paramet…
pageNumber	integer	optional	The Booqable page number to request.
pageSize	integer	optional	The number of Booqable records to request per page.
sort	string	optional	Booqable sort expression such as created_at or -created_at.

POST

booqable_search_orders

Run a Booqable advanced search over orders.

/orders/search

1 parameter

Param	Type	Required	Description
search	object	optional	The Booqable advanced-search JSON body, usually containing filter.conditions an…

GET

booqable_get_order

Fetch one Booqable order by id.

/orders/{orderId}

3 parameters

Param	Type	Required	Description
orderId	string	required	The Booqable order id.
fields	object	optional	Booqable fields keyed by resource type, for example { customers: "id,name" }.
include	string	optional	Comma-separated Booqable relationships to sideload.

GET

booqable_list_product_groups

List Booqable product groups with optional fields, filters, includes, and paging.

/product_groups

7 parameters

Param	Type	Required	Description
fields	object	optional	Booqable fields keyed by resource type, for example { customers: "id,name" }.
filter	object	optional	Booqable filter object. Nested operators are encoded as filter[field][operator].
include	string	optional	Comma-separated Booqable relationships to sideload.
meta	object	optional	Booqable meta aggregation object. Arrays are encoded with bracket query paramet…
pageNumber	integer	optional	The Booqable page number to request.
pageSize	integer	optional	The number of Booqable records to request per page.
sort	string	optional	Booqable sort expression such as created_at or -created_at.

POST

booqable_search_product_groups

Run a Booqable advanced search over product groups.

/product_groups/search

1 parameter

Param	Type	Required	Description
search	object	optional	The Booqable advanced-search JSON body, usually containing filter.conditions an…

GET

booqable_get_product_group

Fetch one Booqable product group by id.

/product_groups/{productGroupId}

3 parameters

Param	Type	Required	Description
productGroupId	string	required	The Booqable product group id.
fields	object	optional	Booqable fields keyed by resource type, for example { customers: "id,name" }.
include	string	optional	Comma-separated Booqable relationships to sideload.