List labels

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

Lists the account's labels, of all types (orders, customers, quotations etc.). Labels are registered in the Manager Panel.

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:Garantia.

Filter	What it does
name	Label name, as registered, case-insensitive. From 2 to 150 characters.

sortstring

Sorting. The - prefix reverses the order.

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

Headers

User-Agentstringrequired

Identification of your application.

Example: MinhaIntegracao/1.0.

Responses

• 200

  List of labels.

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