DEdefaulr
AccessRequests

Retrieve an access request

Changed on

Retrieve information about an access request by id, or the current user's pending request for a document by documentId. At least one of these parameters must be provided.

post/accessRequests.info

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/accessRequests.info
  • 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

idstring uuid

Unique identifier for the access request.

documentIdstring uuid

Identifier for the document to find a pending request for the current user.

Response

OK

Example response

{
  "data": {
    "user": {
      "name": "Jane Doe"
    },
    "responder": {
      "name": "Jane Doe"
    }
  },
  "policies": [
    {
      "abilities": {
        "read": true,
        "update": true,
        "delete": false
      }
    }
  ]
}

Changes

  • 9a99ee93e11dRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 304cd065561bRevision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status