You can authenticate to the Cheqroom API using API tokens. API tokens can be managed through Settings > Integrations > API.
Make sure to authenticate each API request by sending the API token in the Authorization header of the request.
For all upcoming requests, when there is some text (parameter) between [] in blue, you must replace the entire word with the requested input.
[[email protected]] needs to be replaced with [email protected][token] needs to be replaced with API Key[user-id] needs to be replaced with User ID associated with the API Key.itieWhen asking for a resource the following parameters always return:
pagination is done by: _limit and _skip. We ask for 50 items without skipping any (0) in this example.
They are sorted by name through the _sort query parameter.
_fields tell the server which data to return on a resource. It’s not possible to request every piece of information on a resource. Almost all fields on an item resource are provided in the example below. It’s impossible to request a “reservation” resource on an item resource, only order (check-out) information.
curl --request POST \\
--url <https://app.cheqroom.com/api/v2_5/[user-id]/null/jwt/items/search> \\
--header 'Authorization: Bearer [token]' \\
--data '_fields=name,created,expired,fields,status,brand,model,purchasePrice,purchaseDate,warrantyDate,kit.name,cover,codes,barcodes,order._id,order.customer,order.customer.name,order.status,order.started,order.due,order.location.name,category,category.name,location,location.name,flag,custody,residualValue,depreciatedValue,canReserve,canOrder,canCustody,allowReserve,allowOrder,allowCustody,address' \\
--data listName=active \\
--data _sort=name \\
--data _limit=50 \\
--data _skip=0
<aside> 💡
You may notice a null parameter in all API request URLs.
This null parameter is not needed for external requests.
Your API key, which is a JWT token included in the request header, contains all the necessary authentication details.
</aside>