Search change requests

Enterprise feature

Search and filter change requests by creator and approver.

Authentication

Authorizationstring
API key needed to access this API
OR
AuthorizationBearer
API key needed to access this API, in Bearer token format

Query parameters

createdBystringOptional
Filter by change request creator user ID
requestedApproverIdstringOptional
Filter by requested approver user ID
stateenumOptional

Filter by open / closed change requests. Change requests that are in ‘draft’, ‘in review’, ‘approved’, or ‘scheduled’ states are considered open. Change requests that are in ‘cancelled’, ‘applied’, or ‘rejected’ states are considered closed.

Allowed values:
offsetintegerOptional>=0Defaults to 0
The number of change requests to skip when returning a page. By default it is set to 0.
limitintegerOptional1-1000Defaults to 50
The number of change requests to return in a page. By default it is set to 50. The maximum is 1000.

Response

changeRequestSearchResponseSchema
changeRequestslist of objects
List of change requests matching the search criteria.
totaldouble
Total number of change requests matching the search criteria.

Errors