GET
/
users
curl --request GET \
  --url https://api.shiftkeeper.io/users/ \
  --header 'x-api-key: <api-key>'
{
  "users": [
    {
      "id": "usr_bq7CmsOKLmkMeZkUUu1hy",
      "name": "Rick",
      "email": "rick@example.org",
      "time_zone": "Europe/Paris",
      "role": "owner",
      "seat": "member",
      "slack_id": "U082KENSEQ3"
    }
  ],
  "meta": {
    "total": 100,
    "page": 1,
    "per_page": 20
  }
}

Authorizations

x-api-key
string
header
required

Enter your API key which starts with 'keeper_'

Headers

x-shiftkeeper-api-version
string
default:
2024-12-01

Shiftkeeper API version

Query Parameters

per_page
number
default:
20

The number of items per page.

Required range: 1 < x < 100
page
number
default:
1

The page number of the results to return.

Required range: x > 1

Response

200 - application/json
Default Response
users
object[]
required
meta
object
required