Qodex.ai

Get Approvals

GET {{baseUrl}}/generic-approvals

Retrieve a list of approvals, which can be filtered by requester ID, status, or reference type. Mine query parameter can be used and it will return all approvals for the current approver. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals. Absence of all query parameters will will default to mine=true.

Request Params

KeyDatatypeRequiredDescription
minebooleanReturns the list of approvals for the current caller
requesterIdstringReturns the list of approvals for a given requester ID
filtersstringFilter results using the standard syntax described in V3 API Standard Collection Parameters

Filtering is supported for the following fields and operators:

status: eq

referenceType: eq |

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

[{"approvalId":"38453251-6be2-5f8f-df93-5ce19e295837","approvers":[{"id":"85d173e7d57e496569df763231d6deb6a","type":"IDENTITY","name":"John Doe"},{"id":"85d173e7d57e496569df763231d6deb6a","type":"IDENTITY","name":"John Doe"}],"createdDate":"2023-04-12T23:20:50.520Z","type":"ENTITLEMENT_DESCRIPTIONS","name":[{"value":"Audit DB Access","locale":"en_US"},{"value":"Audit DB Access","locale":"en_US"}],"batchRequest":{"batchId":"38453251-6be2-5f8f-df93-5ce19e295837","batchSize":100},"description":[{"value":"This access allows viewing and editing of workflow resource","locale":"en_US"},{"value":"This access allows viewing and editing of workflow resource","locale":"en_US"}],"priority":"HIGH","requester":{"type":"IDENTITY","name":"John Doe"},"comments":[{"author":{"id":"85d173e7d57e496569df763231d6deb6a","type":"IDENTITY","name":"John Doe"},"comment":"Looks good","createdDate":"2023-04-12T23:20:50.520Z"},{"author":{"id":"85d173e7d57e496569df763231d6deb6a","type":"IDENTITY","name":"John Doe"},"comment":"Looks good","createdDate":"2023-04-12T23:20:50.520Z"}],"approvedBy":[{"id":"85d173e7d57e496569df763231d6deb6a","type":"IDENTITY","name":"John Doe"},{"id":"85d173e7d57e496569df763231d6deb6a","type":"IDENTITY","name":"John Doe"}],"rejectedBy":[{"id":"85d173e7d57e496569df763231d6deb6a","type":"IDENTITY","name":"John Doe"},{"id":"85d173e7d57e496569df763231d6deb6a","type":"IDENTITY","name":"John Doe"}],"completedDate":"2023-04-12T23:20:50.520Z","approvalCriteria":"SINGLE","status":"PENDING","additionalAttributes":"{ \"llm_description\": \"generated description\" }","referenceData":[{"id":"64012350-8fd9-4f6c-a170-1fe123683899","type":"AccessRequestId"},{"id":"64012350-8fd9-4f6c-a170-1fe123683899","type":"AccessRequestId"}]},{"approvalId":"38453251-6be2-5f8f-df93-5ce19e295837","approvers":[{"id":"85d173e7d57e496569df763231d6deb6a","type":"IDENTITY","name":"John Doe"},{"id":"85d173e7d57e496569df763231d6deb6a","type":"IDENTITY","name":"John Doe"}],"createdDate":"2023-04-12T23:20:50.520Z","type":"ENTITLEMENT_DESCRIPTIONS","name":[{"value":"Audit DB Access","locale":"en_US"},{"value":"Audit DB Access","locale":"en_US"}],"batchRequest":{"batchId":"38453251-6be2-5f8f-df93-5ce19e295837","batchSize":100},"description":[{"value":"This access allows viewing and editing of workflow resource","locale":"en_US"},{"value":"This access allows viewing and editing of workflow resource","locale":"en_US"}],"priority":"HIGH","requester":{"type":"IDENTITY","name":"John Doe"},"comments":[{"author":{"id":"85d173e7d57e496569df763231d6deb6a","type":"IDENTITY","name":"John Doe"},"comment":"Looks good","createdDate":"2023-04-12T23:20:50.520Z"},{"author":{"id":"85d173e7d57e496569df763231d6deb6a","type":"IDENTITY","name":"John Doe"},"comment":"Looks good","createdDate":"2023-04-12T23:20:50.520Z"}],"approvedBy":[{"id":"85d173e7d57e496569df763231d6deb6a","type":"IDENTITY","name":"John Doe"},{"id":"85d173e7d57e496569df763231d6deb6a","type":"IDENTITY","name":"John Doe"}],"rejectedBy":[{"id":"85d173e7d57e496569df763231d6deb6a","type":"IDENTITY","name":"John Doe"},{"id":"85d173e7d57e496569df763231d6deb6a","type":"IDENTITY","name":"John Doe"}],"completedDate":"2023-04-12T23:20:50.520Z","approvalCriteria":"SINGLE","status":"PENDING","additionalAttributes":"{ \"llm_description\": \"generated description\" }","referenceData":[{"id":"64012350-8fd9-4f6c-a170-1fe123683899","type":"AccessRequestId"},{"id":"64012350-8fd9-4f6c-a170-1fe123683899","type":"AccessRequestId"}]}]