Skip to main content

List parts

GEThttps://carchost.fieldcontrol.com.br/parts

Lists the account's parts, with pagination, filters and sorting. The list does not include equipmentTypes or customFields.

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: code:CAP archived:false.

FilterWhat it does
name

Part of the part name, case-insensitive.

code

Part of the part code, case-insensitive.

externalId

Part identifier in your system, exactly as registered.

partTypeId

Part type identifier.

archived

true for archived, false for active.

sortstring

Sorting. The - prefix reverses the order.

Accepted values: id, -id, name, -name, code, -code, value, -value, created_at, -created_at, updated_at, -updated_at.Default: id.

Headers

User-Agentstringrequired

Identification of your application.

Example: MinhaIntegracao/1.0.

Responses

  • 200

    List of parts.

  • 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 pagination or sorting (parametersValidationErr).

  • 429

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

  • 500

    Unexpected server error.