Skip to content
vocapable.Docs

The review drawer for one request

GET
/v1/workspace/approvals/{approval_id}/review
curl --request GET \
  --url https://api.vocapable.com/v1/workspace/approvals/example/review \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
approval_id
required
Approval Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceApprovalReview

The review drawer: the exact request, where its record is, and who may act.

object
approval
required
WorkspaceApproval

One request for review, pinned to the exact payload reviewed (its digest).

object
id
required
Id
string
action_type
required
Action Type
string
subject_type
required
Subject Type
string
subject_id
required
Subject Id
string
digest
required
Digest
string
summary
required
Summary
object
key
additional properties
any
requested_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
reviewer
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
status
required
Status
string
Allowed values: awaiting_review changes_requested approved declined expired stale executing confirmed failed
decided_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
decided_at
required
Any of:
string format: date-time
reason
required
Any of:
string
expires_at
required
Expires At
string format: date-time
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
subject_label
required
Subject Label
string
link
required
Any of:
string
can_decide
required
Can Decide
boolean
blocked_reason
required
Any of:
string
reviewers
required
Reviewers
Array<object>
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
status_explanation
required
Status Explanation
string
Example
{
  "approval": {
    "status": "awaiting_review"
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}