v1

latestOpenAPI 3.1.02026-07-24560263.9 KB

Listar Usuários

Listar e consultar usuários

get/users

Query parameters

filter[email]string

Informe um email caso deseje filtrar

Headers

Authorizationstring

Access Token gerado pelo gestor da conta

Content-type'application/vnd.api+json'

Content-type padrão para todas requisições JSON:API

Response

200

Example response

{
  "data": [
    {
      "id": "0c010fc6-c5a2-4561-9631-ea8a5d7e2096",
      "type": "users",
      "links": {
        "self": "https://sandbox.clicksign.com/api/v3/users/0c010fc6-c5a2-4561-9631-ea8a5d7e2096"
      },
      "attributes": {
        "name": "John Doe",
        "email": "john.doe@example.com",
        "phone_number": "11666999666",
        "created": "2024-11-01T11:03:30.590-03:00",
        "modified": "2024-11-01T11:03:30.597-03:00"
      }
    }
  ],
  "meta": {
    "record_count": 1
  },
  "links": {
    "first": "https://sandbox.clicksign.com/api/v3/users?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "last": "https://sandbox.clicksign.com/api/v3/users?page%5Bnumber%5D=1&page%5Bsize%5D=20"
  }
}