Users

get

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

identityPlatformUidstringOptional

Filter by identity platform uid

Example: DMr6o6EjVhftxSTQ9spoG4wj2bj1

updatedAfterstringOptional

ISO8601 compatible datetime string

Example: 2017-07-21T17:32:28Z

createdAfterstringOptional

ISO8601 compatible datetime string

Example: 2017-07-21T17:32:28Z

beforestringOptional

Pledge cursor to fetch results before

Example: a3c2a57e-2797-4159-8700-8ad55bf8150e

lastnumberOptional

The amount of results to fetch before the 'before' cursor

Example: 10

afterstringOptional

Pledge cursor to fetch results after

Example: a3c2a57e-2797-4159-8700-8ad55bf8150e

firstnumberOptional

The amount of results to fetch after the 'after' cursor

Example: 10

Responses

200Success

application/json

400

Bad request. Response body shows what the problem is.

401

Service account not properly authenticated

403

Service account forbids executing this action

default

application/json

get

/api/v1/users

HTTPcURLJavaScriptPython

GET /api/v1/users HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "edges": [
    {
      "node": {
        "uuid": "005d5052-4d19-4377-8b45-ff68fd1e6952",
        "username": "[email protected]",
        "name": "Peter Parker",
        "createdAt": "2017-07-21T17:32:28Z"
      },
      "cursor": "48094b0e-15b3-430f-ab5a-16ecf12b9171"
    }
  ],
  "pageInfo": {
    "startCursor": "48094b0e-15b3-430f-ab5a-16ecf12b9171",
    "endCursor": "494d74df-6fbc-46a3-811e-1c17230340a1",
    "hasPreviousPage": true,
    "hasNextPage": false
  }
}