---
agentTools:
  projectIndex: https://atendare.readme.io/llms.txt
---

# Listar usuários

Lista vários contatos de acordo com a ordem de criação. Podendo ser feito paginação pelo parâmetro da query {page_index} e {page_size}

```json
GET - 200

{
  "total": 1,
  "page_index": 0,
  "page_size": 15,
  "results": [
    {
      "id": 1,
      "uid": 1,
      "name": "Nome do usuário",
      "full_name": "Nome completo do usuário",
      "show_name": "Nome exibido do usuário",
      "image": "https://image-url/image.png",
      "image_min": "https://image-url/image.png",
      "email": "email@atendare.com",
      "phone": "55 9 99999999",
      "cpf": "000.000.000-00",
      "status": 1,
      "user_status": 1,
      "birth_date": "1995-06-29T00:00:00Z",
      "creation_date": "0001-01-01T00:00:00Z",
      "update_date": "2022-07-05T19:05:33.114421Z",
      "language_id": 94,
      "timezone_id": 24,
      "allow_support": false
    }
  ]
}
```

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Atendare API - v2",
    "version": "2.0"
  },
  "servers": [
    {
      "url": "https://api.atendare.com/v2"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/users": {
      "get": {
        "summary": "Listar usuários",
        "description": "Lista vários contatos de acordo com a ordem de criação. Podendo ser feito paginação pelo parâmetro da query {page_index} e {page_size}",
        "operationId": "list-users",
        "parameters": [
          {
            "name": "Access-Token",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page_index",
            "in": "query",
            "description": "Para paginação, representa o primeiro elemento da lista.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "page_size",
            "in": "query",
            "description": "Para paginação, define o total de contatos que ira ser retornado em uma lista. O limite é 15",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 15
            }
          },
          {
            "name": "search_text",
            "in": "query",
            "description": "Termo usado para pesquisar",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort_order",
            "in": "query",
            "description": "Tipo de ordenação crescente (ASC) ou decrescente (DESC), o padrão é crescente",
            "schema": {
              "type": "string",
              "default": "asc"
            }
          },
          {
            "name": "filter",
            "in": "query",
            "schema": {
              "properties": {
                "condition": {
                  "type": "string",
                  "description": "Or - And"
                },
                "conditions": {
                  "type": "array",
                  "items": {
                    "properties": {
                      "field": {
                        "type": "string",
                        "description": "Campo que você deseja filtrar"
                      },
                      "operation": {
                        "type": "string",
                        "enum": [
                          "equal",
                          "not_equal",
                          "less",
                          "less_or_equal",
                          "greater",
                          "greater_or_equal",
                          "begins_with",
                          "does_not_begin_with",
                          "is_in",
                          "is_not_in",
                          "ends_with",
                          "does_not_end_with",
                          "contains",
                          "does_not_contains",
                          "is_empty",
                          "is_not_empty",
                          "between",
                          "does_not_between"
                        ]
                      },
                      "value": {
                        "type": "string"
                      }
                    },
                    "type": "object"
                  }
                }
              },
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"total\": 1,\n  \"page_index\": 0,\n  \"page_size\": 15,\n  \"results\": [\n    {\n      \"id\": 1,\n      \"uid\": 1,\n      \"name\": \"Nome do usuário\",\n      \"full_name\": \"Nome completo do usuário\",\n      \"show_name\": \"Nome exibido do usuário\",\n      \"image\": \"https://image-url/image.png\",\n      \"image_min\": \"https://image-url/image.png\",\n      \"email\": \"email@atendare.com\",\n      \"phone\": \"55 9 99999999\",\n      \"cpf\": \"029.401.850-69\",\n      \"status\": 1,\n      \"user_status\": 1,\n      \"birth_date\": \"1995-06-29T00:00:00Z\",\n      \"creation_date\": \"0001-01-01T00:00:00Z\",\n      \"update_date\": \"2022-07-05T19:05:33.114421Z\",\n      \"language_id\": 94,\n      \"timezone_id\": 24,\n      \"allow_support\": false\n    }\n  ]\n}\n"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "total": {
                      "type": "integer",
                      "example": 1,
                      "default": 0
                    },
                    "page_index": {
                      "type": "integer",
                      "example": 0,
                      "default": 0
                    },
                    "page_size": {
                      "type": "integer",
                      "example": 15,
                      "default": 0
                    },
                    "results": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "integer",
                            "example": 1,
                            "default": 0
                          },
                          "uid": {
                            "type": "integer",
                            "example": 1,
                            "default": 0
                          },
                          "name": {
                            "type": "string",
                            "example": "Nome do usuário"
                          },
                          "full_name": {
                            "type": "string",
                            "example": "Nome completo do usuário"
                          },
                          "show_name": {
                            "type": "string",
                            "example": "Nome exibido do usuário"
                          },
                          "image": {
                            "type": "string",
                            "example": "https://image-url/image.png"
                          },
                          "image_min": {
                            "type": "string",
                            "example": "https://image-url/image.png"
                          },
                          "email": {
                            "type": "string",
                            "example": "email@atendare.com"
                          },
                          "phone": {
                            "type": "string",
                            "example": "55 9 99999999"
                          },
                          "cpf": {
                            "type": "string",
                            "example": "029.401.850-69"
                          },
                          "status": {
                            "type": "integer",
                            "example": 1,
                            "default": 0
                          },
                          "user_status": {
                            "type": "integer",
                            "example": 1,
                            "default": 0
                          },
                          "birth_date": {
                            "type": "string",
                            "example": "1995-06-29T00:00:00Z"
                          },
                          "creation_date": {
                            "type": "string",
                            "example": "0001-01-01T00:00:00Z"
                          },
                          "update_date": {
                            "type": "string",
                            "example": "2022-07-05T19:05:33.114421Z"
                          },
                          "language_id": {
                            "type": "integer",
                            "example": 94,
                            "default": 0
                          },
                          "timezone_id": {
                            "type": "integer",
                            "example": 24,
                            "default": 0
                          },
                          "allow_support": {
                            "type": "boolean",
                            "example": false,
                            "default": true
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "61f3f7309a3abf0010b92516:62c6f15f4d7ed00021ef6fb0"
}
```