v1

latestOpenAPI 3.1.02026-07-242200814.7 KB

Listar usuários

get/users

Query parameters

showinteger

Número de itens na página de resultado.

cursorstring

Hash da pŕoxima página.

emailstring

Filtrar pelo e-mail do usuário.

account_idstring

Filtrar pelo ID da conta.

namestring

Filtrar pelo nome do usuário.

activestring

Filtrar pelo status do usuário. Detalhes na descrição do endpoint.

permissionstring
created_at_startstring date-time

Filtrar por usuários criados a partir da data e hora informada.

created_at_endstring date-time

Filtrar por usuários criados até a da data e hora informada.

updated_at_startstring date-time

Filtrar por usuários atualizados até a da data e hora informada.

updated_at_endstring date-time

Filtrar por usuários atualizados até a da data e hora informada.

Response

200

successboolean
messagestring

Example response

{
  "success": true,
  "message": "OK",
  "data": [
    {
      "id": 748,
      "email": "teste@email.com.br",
      "hash": "200212000098",
      "account_id": 1,
      "pipeline_id": 1,
      "region_id": 1,
      "name": "Admin PipeRun",
      "birth_day": "2005-09-27",
      "active": 1,
      "pipeline_view": 2,
      "only_yours_deals": true,
      "last_login_at": "2020-03-03 09:58:22",
      "created_at": "2020-02-12 14:38:05",
      "updated_at": "2020-02-12 14:38:05",
      "schedule_active": 1,
      "schedule_duration": 30
    }
  ],
  "meta": {
    "cursor": {
      "next": "eyJp.....SXRlbXMiOnRydWV9"
    }
  }
}