v1

latestOpenAPI 3.1.02026-07-242200814.7 KB

Campos customizados em empresas

get/companies/custom-fields

Query parameters

cursorstring

Hash da próxima página

showinteger

Quantidade de items na listagem.

company_idinteger

Listar pelo ID da empresa.

custom_field_idinteger

Listar pelo ID do campo customizado.

created_at_startstring date-time

Filtrar por registros de campos customizados a partir da data e hora informada de criação.

created_at_endstring date-time

Filtrar por registros de campos customizados até a data e hora informada de criação

updated_at_startstring date-time

Filtrar por registros de campos customizados a partir da data e hora informada de atualização.

updated_at_endstring date-time

Filtrar por registros de campos customizados até a data e hora informada de atualização.

Response

200

successboolean

messagestring

Example response

{
  "success": true,
  "message": "OK",
  "data": [
    {
      "company_id": 123,
      "custom_field_id": 123,
      "value": "28/09/2023",
      "created_at": "2023-09-27 16:09:17",
      "updated_at": "2023-09-27 16:09:17"
    }
  ],
  "meta": {
    "cursor": {
      "next": "eyJhZ2....RydWV9"
    }
  }
}