DEdefaulr
ApiKeys

List API keys

Changed on

List API keys for the authenticated user, or for all users in the workspace when called by an administrator. The secret key value is never included in this response.

post/apiKeys.list

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/apiKeys.list
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getoutline.com/oauth/authorize
      Token URL: https://app.getoutline.com/oauth/token scopes: read, write

Request body

offsetnumber
limitnumber
sortstring
direction'ASC' | 'DESC'
userIdstring uuid

Filter to keys belonging to this user (admin only).

querystring

Filter to keys whose name matches this search term.

Example request

{
  "limit": 25,
  "sort": "updatedAt",
  "direction": "DESC"
}

Response

OK

Example response

{
  "pagination": {
    "limit": 25
  },
  "policies": [
    {
      "abilities": {
        "read": true,
        "update": true,
        "delete": false
      }
    }
  ]
}

Changes