Skip to main content
GET
/
requests
/
relay
Get requests via Relay
curl --request GET \
  --url https://api.opal.dev/v1/requests/relay \
  --header 'Authorization: Bearer <token>'
{
  "edges": [
    {
      "node": {
        "id": "7c86c85d-0651-43e2-a748-d69d658418e8",
        "created_at": "2021-01-06T20:00:00.000Z",
        "updated_at": "2021-01-06T20:00:00.000Z",
        "requester_id": "c86c85d-0651-43e2-a748-d69d658418e8",
        "target_user_id": "r86c85d-0651-43e2-a748-d69d658418e8",
        "target_group_id": "r86c85d-0651-43e2-a748-d69d658418e8",
        "status": "pending",
        "reason": "I need this resource.",
        "duration_minutes": 1440,
        "request_comments": [
          {
            "id": "7c86c85d-0651-43e2-a748-d69d658418e8",
            "created_at": "2021-01-06T20:00:00.000Z",
            "updated_at": "2021-01-06T20:00:00.000Z",
            "request_id": "4c86c85d-0651-43e2-a748-d69d658418e8",
            "user_id": "c86c85d-0651-43e2-a748-d69d658418e8",
            "comment": "This is a comment."
          }
        ],
        "reviewer_stages": [
          {
            "requestedRoleName": "Admin",
            "requestedItemName": "AWS Production Account",
            "stages": [
              {
                "stage": 1,
                "operator": "AND",
                "reviewers": [
                  {
                    "id": "7c86c85d-0651-43e2-a748-d69d658418e8",
                    "status": "PENDING"
                  }
                ]
              },
              {
                "stage": 2,
                "operator": "OR",
                "reviewers": [
                  {
                    "id": "8d86c85d-0651-43e2-a748-d69d658418e9",
                    "status": "APPROVED"
                  }
                ]
              }
            ]
          }
        ]
      },
      "cursor": "<string>"
    }
  ],
  "pageInfo": {
    "hasNextPage": true,
    "endCursor": "<string>",
    "hasPreviousPage": true,
    "startCursor": "<string>"
  },
  "totalCount": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

first
integer

Number of results to return after the cursor. Use either first/after or last/before, not both.

Required range: 1 <= x <= 100
after
string

Cursor to fetch results after. Used with 'first' for forward pagination.

last
integer

Number of results to return before the cursor. Use either first/after or last/before, not both.

Required range: 1 <= x <= 100
before
string

Cursor to fetch results before. Used with 'last' for backward pagination.

status
enum<string>

Filter requests by their status.

Available options:
PENDING,
APPROVED,
DENIED,
CANCELED
to
string<uuid>

Filter requests assigned to a specific user ID.

from
string<uuid>

Filter requests made by a specific user ID.

Response

200 - application/json

A paginated list of requests using Relay-style cursor pagination.

edges
object[]
required
pageInfo
object
required
totalCount
integer
required

The total number of items available