Skip to content
Optiwork API Docs

Search who can be asked for approval

GET
/drives/{drive}/approvals/requestables
curl --request GET \
  --url 'https://work.optidata.cloud/api/drives/1/approvals/requestables?query=john' \
  --header 'Authorization: Bearer <token>'

Users of the tenant who can be named as approvers, matched by name or e-mail and ordered by name. The caller is never included.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
drive
required
integer format: int64

Numeric id of the drive. Read it from GET /drives/config.json.

Query Parameters

Section titled “Query Parameters”
query
required
string

Text matched against the name and e-mail.

Example
john

Responses

Section titled “ Responses ”

200

Section titled “200”

Candidate approvers.

Media typeapplication/json
object
requestables
required
Array
object
id
integer format: int64
uuid

Tenant-wide identifier of the user. Use this, not id, on account endpoints.

string format: uuid
name
string
email
string format: email
status

Present where the payload includes it (for example audit entries).

string
Allowed values: active inactive blocked
deleted_at
string | null format: date-time
avatar_url
string | null format: uri
full_name
string
type
string
Allowed values: user
Example
{
  "requestables": [
    {
      "id": 15,
      "uuid": "9c1f0e2a-4d31-4d8a-8c1a-1f0b6b1f9a10",
      "name": "Jane Doe",
      "email": "jane.doe@acme.example",
      "status": "active",
      "type": "user"
    }
  ]
}

401

Section titled “401”

Missing, malformed or expired authentication key.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Examplemissing

No bearer token sent

{
  "error": "JWT passport exception: Missing bearer token in request"
}

422

Section titled “422”

The request body or query string failed validation.

Media typeapplication/json
object
message
required

The first validation message.

string
errors
required

Validation messages keyed by field name.

object
key
additional properties
Array<string>
Examples
Exampleinvalid
{
  "message": "The name field is required.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}

429

Section titled “429”

Rate limit exceeded. Retry after the window resets.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Examplethrottled
{
  "message": "Too Many Attempts."
}