API Reference

Get a list of all users

get
https://api.pushologies.com/v1/users

Retrieves a list of registered users. This list will be comprised of either users who registered via the portal or references to ADMIN_API api keys

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
10 to 500
Defaults to 100

Number of items to retrieve with this API request (default is 100, minimum - 10 per page, maximum - 500).

integer
0 to 10000000
Defaults to 0

A cursor on where to start returning the amount of items specified in query parameter (defaults to 0).

boolean
Defaults to false

Once set to TRUE the endpoint will return deleted Users too.

boolean
Defaults to false

Only return users who have not been created to accompany API keys

string
enum

Only return users who have a given system "status"

Allowed:
string
enum

Only return users who have a given system "role"

Allowed:
Responses

401

Id Token or X-API-Key/X-API-Secret is missing or invalid.

403

The server understood the request but refuses to authorize it. In most cases due to insufficient user permissions.

Updated over 2 years ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago