Sign in
Usuários

Buscar usuários

get/api/users

Query parameters

idinteger

The ID of the user to filter users by.

Example:1

The ID of the user to filter users by.

cepstring

O CEP para filtrar usuários por.

Example:03982-000

O CEP para filtrar usuários por.

cpfstring

O CPF para filtrar usuários por.

Example:999.999.999-99

O CPF para filtrar usuários por.

genderstring

O gênero do usuário.

Example:M, F, A

O gênero do usuário.

registerDatestring[]

Data de registro do usuário.

Data de registro do usuário.

[
  "2022-08-15T11:45:38",
  "2022-08-15T11:45:38"
]
attached_atstring[]

Data de vinculação do usuário.

Data de vinculação do usuário.

[
  "2022-08-15T11:45:38",
  "2022-08-15T11:45:38"
]
birthdatestring[]

Data de nascimento do usuário.

Data de nascimento do usuário.

[
  "2022-08-15T11:45:38",
  "2022-08-15T11:45:38"
]
updated_atstring

Data mínima da última atualização do cadastro no formato ISO 8601.

Example:2024-01-02T15:00:00Z

Data mínima da última atualização do cadastro no formato ISO 8601.

blacklistboolean

O status do usuário.

Example:true

O status do usuário.

Response

Example response

{
  "data": [
    {
      "name": "string",
      "cpf": "string",
      "birthdate": "date",
      "gender": "string",
      "registerDate": "datetime",
      "email": "string",
      "phone": "string",
      "zipcode": "string",
      "balance": "float",
      "updated_at": "datetime",
      "id": "int",
      "blacklist": "boolean",
      "pdvs": {
        "data": [
          "array"
        ]
      },
      "address": {
        "neighborhood": "string",
        "state": "string",
        "address": "string",
        "number": "string",
        "complement": "string",
        "city": "string"
      }
    }
  ],
  "links": {
    "self": "string",
    "first": "string",
    "last": "string",
    "prev": "nullable_string",
    "next": "nullable_string"
  },
  "meta": {
    "current_page": "int",
    "from": "int",
    "last_page": "int",
    "links": [
      {
        "url": "nullable_string",
        "label": "string",
        "active": "boolean"
      },
      {
        "url": "string",
        "label": "string",
        "active": "boolean"
      },
      {
        "url": "nullable_string",
        "label": "string",
        "active": "boolean"
      }
    ],
    "path": "string",
    "per_page": "int",
    "to": "int",
    "total": "int"
  }
}

Changes