OPopal
requests

Get requests

Changed on

Returns a list of requests for your organization that is visible by the admin.

get/requests

Request

  • Base URL
    https://api.opal.dev/v1
  • Auth
    HTTP bearer

Query parameters

start_date_filterstring

A start date filter for the events.

end_date_filterstring

An end date filter for the events.

requester_idstring uuid

Filter requests by their requester ID.

target_user_idstring uuid

Filter requests by their target user ID.

resource_idstring uuid

Filter requests by the resource ID that was requested.

group_idstring uuid

Filter requests by the group ID that was requested.

cursorstring

The pagination cursor value.

page_sizeinteger

Number of results to return per page. Default is 200.

show_pending_onlyboolean

Boolean toggle for if it should only show pending requests.

Response

The list of requests.

cursorstring

The cursor to use in the next request to get the next page of results.

Example response

{
  "requests": [
    {
      "id": "7c86c85d-0651-43e2-a748-d69d658418e8",
      "organization_id": "w86c85d-0651-43e2-a748-d69d658418e8",
      "created_at": "2021-01-06T20:00:00Z",
      "updated_at": "2021-01-06T20:00:00Z",
      "requester_id": "c86c85d-0651-43e2-a748-d69d658418e8",
      "target_user_id": "r86c85d-0651-43e2-a748-d69d658418e8",
      "target_group_id": "g86c85d-0651-43e2-a748-d69d658418e8",
      "status": "pending",
      "reason": "I need this resource.",
      "duration_minutes": 1440,
      "request_comments": [
        {
          "id": "4c86c85d-0651-43e2-a748-d69d658418e8",
          "created_at": "2021-01-06T20:00:00Z",
          "updated_at": "2021-01-06T20:00:00Z",
          "request_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
          "user_id": "c86c85d-0651-43e2-a748-d69d658418e8",
          "comment": "This is a comment."
        }
      ]
    }
  ],
  "cursor": "eyJjcmVhdGVkX2F0IjoiMjAyMS0wMS0wNlQyMDo0NzowMFoiLCJ2YWx1ZSI6ImFkbWluIn0="
}

Changes

  • c0ce333f6196Revision changes
    • info

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

    • info

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

  • c5dec6811e07Revision changes
    • warning

      added the new CALLOUT enum value to the //// response property for the response status

    • warning

      added the new MULTI_SELECT enum value to the //// response property for the response status