List employees

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

Lists the account's employees, with pagination and filters. The list is sorted by identifier.

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: email:joana.ribeiro@example.com.

Filter	What it does
name	Employee name, exactly as registered. At least 4 characters.
email	Employee email, exactly as registered.
id	Internal numeric identifier of the employee. The id returned by the API is not accepted in this filter.

Headers

User-Agentstringrequired

Identification of your application.

Example: MinhaIntegracao/1.0.

Responses

• 200

  List of employees.

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