Skip to main content

List materials

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

Lists the account's materials, with pagination and filters. The list is sorted by identifier. In accounts that migrated materials to products, it lists the products.

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: name:cabo archived:false.

FilterWhat it does
name

Part of the material name, case-insensitive. From 5 to 150 characters.

archived

true for archived, false for active.

Headers

User-Agentstringrequired

Identification of your application.

Example: MinhaIntegracao/1.0.

Responses

  • 200

    List of materials.

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

  • 429

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

  • 500

    Unexpected server error.