List all (or one) users.

Endpoint URL

Authentication and rate limits

Authentication methodOAuth 2.0 Bearer token
Rate limitRate Limit

Requests Example

curl --request GET \
  --url '' \
  --header 'Authorization: Bearer $BEARER_TOKEN'
curl --request GET \
  --url '$id' \
  --header 'Authorization: Bearer $BEARER_TOKEN'

Query Parameters

  • id (integer) --

    Optional if you want to list a specific user ID. The id parameter is passed as part of the request url /user/$id.

Response Syntax

  "id": integer,
  "first_name": "string",
  "last_name": "string",
  "email": "string",
  "role": "admin" | "user",
  "status": "has_site_access" | "no_site_access" | "removed"

Response Fields

  • id (integer) --

    The ID of the user.

  • first_name (string) --

    The first name of the user.

  • last_name (string) --

    The last name of the user.

  • email (string) --

    The email of the user.

  • role (string) --

    The role of the user.

  • status (string) --

    The status of the user.