Bots

List bot reviewers

Changed on

Returns a paginated list of Workfront bot users that are eligible to be added as reviewer participants on an approval. A bot reviewer is invoked automatically when its assigned stage becomes active.

get/api/v1/bots

Request

  • Base URL: https://workfront.adobe.io/workfront-approvals
  • URL: https://workfront.adobe.io/workfront-approvals/api/v1/bots
  • Auth: HTTP bearer

Query parameters

pageinteger
limitinteger

Headers

x-api-keystring required

client_id of the Adobe Developer Console technical account. Identifies the calling integration to the AIO gateway.

x-gw-subdomainstring required

Workfront customer subdomain (e.g. mycompany). Must match the subdomain of the Workfront instance being accessed. Passing an incorrect or unrecognized subdomain will result in a 502 Bad Gateway response from the AIO gateway.

wf-customeridstring required

Workfront customer ID.

wf-useridstring required

Workfront user ID of the acting user.

wf-lane'prod' | 'preview' | 'hub' | 'staging' | 'devtest' required

Workfront deployment lane.

x-request-idstring uuid

Unique identifier for request tracing. Auto-generated if not provided.

x-correlation-idstring

Unique identifier for correlation across multiple service calls. Auto-generated if not provided.

Response

OK

Changes

  • 05c9b02a400aRevision changes
    • breaking

      added the new required header request parameter wf-customerid

    • breaking

      added the new required header request parameter wf-lane

    • breaking

      added the new required header request parameter wf-userid

    • breaking

      added the new required header request parameter x-api-key

    • breaking

      added the new required header request parameter x-gw-subdomain

  • 37ac7305fbe3Revision changes
    • info

      endpoint added