Skip to main content
GET
/
poolside
/
v1
/
users
List users
curl --request GET \
  --url https://api.example.com/poolside/v1/users
{
  "links": {
    "next": "<string>"
  },
  "users": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "email": "jsmith@example.com",
      "id": "<string>",
      "status": "created",
      "teams": {
        "links": {
          "next": "<string>"
        },
        "teams": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>"
          }
        ],
        "$schema": "<string>"
      },
      "updated_at": "2023-11-07T05:31:56Z",
      "$schema": "<string>",
      "attributes": {
        "scim": {}
      },
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ],
  "$schema": "<string>"
}

Query Parameters

start_token
string

token for fetching the next page of results, if any. May specify start_token or page but not both.

Minimum string length: 4
page_size
integer<int64>

Items per page (defaults to 20, max 300)

email
string<email>

return users with the specified email address (exact match)

status
enum<string>[]

return users with any of the specified status values (comma-separated)

Maximum array length: 4
Available options:
created,
active,
suspended,
deleted
team
string<uuid>

return users belonging to the specified team

Response

OK

users
object[]
required

a page of users

$schema
string<uri>
read-only

A URL to the JSON Schema for this object.

Example:

"https://example.com/schemas/ListUsersPage.json"