Retrieve an equipment

GEThttps://carchost.fieldcontrol.com.br/equipments/{id}

Returns an equipment by identifier, with the answers to the custom fields, the labels and, in accounts with the parts module, the status (status).

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

Request

Path parameters

idstringrequired

Equipment identifier.

Example: NDgyYzI4MjctNmE4MS00MGExLWE1MWQtNjMxNjgzMGMxN2VhOjIyOTE1.

Headers

User-Agentstringrequired

Identification of your application.

Example: MinhaIntegracao/1.0.

Responses

• 200

  Equipment found.

• 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.

• 404

  Resource not found. The response body is empty.

• 422

  Invalid identifier in the path or one from another account (uriValidationErr), or invalid query parameter (parametersValidationErr). A valid identifier that does not exist returns 404.

• 429

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

• 500

  Unexpected server error.