Skip to content
vocapable.Docs

Requests awaiting your review

GET
/v1/mobile/workspace/approvals
curl --request GET \
  --url 'https://api.vocapable.com/v1/mobile/workspace/approvals?view=review&limit=50' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
view
View
string
default: review
Allowed values: review mine all
status
Any of:
string
Allowed values: awaiting_review changes_requested approved declined expired stale executing confirmed failed
limit
Limit
integer
default: 50 >= 1 <= 200
cursor
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CursorPage[WorkspaceApproval]
object
data
required
Data
Array<object>
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
next_cursor
Any of:
string
has_more
Has More
boolean
Example
{
  "data": [
    {
      "status": "awaiting_review"
    }
  ],
  "has_more": false
}

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": {}
    }
  ]
}