Skip to main content

List vehicle uses

GEThttps://carchost.fieldcontrol.com.br/vehicles-usages

Lists the history of vehicle checkouts and returns by employees, with pagination, filters and sorting.

Requires the X-Api-Key and User-Agent headers. Limit: 1 request per second (learn more).

Request​

Query parameters

limitinteger

Number of items per page.

From 1 to 100.Default: 10.

offsetinteger

Number of items to skip.

From 0 to 200000.Default: 0.

qstring

Filters in the field:value format, separated by spaces (how to filter). The accepted filters are in the table below.

Example: archived:false.

FilterWhat it does
description

Part of the text, case-insensitive. Only returns uses in which the checkout note and the return note contain the text.

archived

true for archived, false for active.

id

Internal identifier (UUID). The id returned by the API is not accepted in this filter and results in a 500 error.

sortstring

Sorting. The - prefix reverses the order.

Accepted values: id, created_at, -created_at.Default: id.

Headers

User-Agentstringrequired

Identification of your application.

Example: MinhaIntegracao/1.0.

Responses

  • 200

    List of uses.

  • 401

    API key missing (Missing API Key) or invalid (Invalid API Key). See Authentication.

  • 403

    Account blocked (Account blocked), expired (Account expired) or on a plan that does not allow integration (Account plan not allowed). See Authentication.

  • 422

    Invalid filter, pagination or sorting (parametersValidationErr).

  • 429

    Limit of 1 request per second exceeded. See Rate limit.

  • 500

    Unexpected server error.