Configuration APIApproval Request

Get approval request.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

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

Path parameters

versionstringRequiredDefaults to 1
version
resourceIdstringRequiredDefaults to
The ID of the resource to be requested.

Headers

x-platform-idstringOptional
Platform ID.

Response

OK
object_typestring or nullRead-only
idstring or nullRead-only
approval_policy_idslist of strings or nullRead-only
The IDs of all the Approval Policies that were breached.
source_typeenum or nullRead-only

The object type in which this Approval Request was triggered. I.e. QUOTE_VERSION.

Allowed values:
source_idstring or nullRead-only
The ID of the object type that triggered this Approval Request.
statusenum or nullRead-only
The current status of the Approval Request.
Allowed values:
owner_idstring or nullRead-only
The ID of the user who owns the Approval Request.
created_atstring or nullRead-only
The date that the Approval Request was created.
updated_atstring or nullRead-only
The date that the Approval Request was updated.
reviewerslist of objects or nullRead-only
The list of users that have approved or declined the Approval Request.
approval_strategyenum or nullRead-only
Approval Strategy applied in the Approval Request.
Allowed values:
reviewed_atstring or nullRead-onlyDeprecated

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error