Search requests

List requests

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageinteger · min: 1 · max: 9007199254740991Optional

Which page to fetch

Default: 1

pageSizeinteger · min: 1 · max: 30Optional

Page size to use

Default: 30

typeany ofOptional

Search by request type

or

string · enumOptional

Single type

Possible values:

stateany ofOptional

Search by request state

or

string · enumOptional

Single state

Possible values:

targetIdstringOptional

Search by target ID

createdBystringOptional

Search by request creator (user ID or 'me')

reviewedBystringOptional

Search by user who has already reviewed (user ID or 'me')

pendingBystringOptional

Search by user who has a pending review for the request (user ID or 'me')

sortBystring · enumOptional

Sort by attribute

Default: createdAtPossible values:

sortOrderstring · enumOptional

Sort order

Default: ascPossible values:

fromDatestringOptional

Search by createdAt >= this date (inclusive)

toDatestringOptional

Search by createdAt <= this date (inclusive)

Responses

200

Successful response

application/json

pagenumberRequired

Current page

nextany ofRequired

Next page or null if there is none

numberOptional

or

nullOptional

prevany ofRequired

Previous page or null if there is none

numberOptional

or

nullOptional

pageSizenumberRequired

Max count of items per page

totalnumberRequired

Total count of items

resultsone of[]Required

Array of results

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/requests

HTTPcURLJavaScriptPython

GET /v1/rest/requests HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "page": 1,
  "next": 1,
  "prev": 1,
  "pageSize": 1,
  "total": 1,
  "results": [
    {
      "type": "text",
      "data": {
        "quorum": 1
      },
      "id": "text",
      "legacyId": 1,
      "state": "INITIAL",
      "reviewSteps": [
        {
          "stageName": "text",
          "quorum": 1
        }
      ],
      "currentStepIndex": 1,
      "expiresAt": "text",
      "expiredAt": "text",
      "targetId": "text",
      "note": {
        "title": "text",
        "content": "text"
      },
      "reviews": [
        {
          "stepIndex": 1,
          "userId": "text",
          "groupName": "text",
          "status": "PENDING",
          "createdAt": "text",
          "updatedAt": "text"
        }
      ],
      "createdAt": "text",
      "updatedAt": "text",
      "createdById": "text",
      "inflight": {
        "lastError": "text",
        "numFailed": 1,
        "retryAfter": "text"
      }
    }
  ]
}