Retrieve Workflows

GET https://{{vaultDNS}}/api/{{version}}/objects/objectworkflows

https://developer.veevavault.com/api/20.2/#retrieve-workflows

Retrieve all workflows for a specific object and object record or from a specific workflow participant.

Request Params

KeyDatatypeRequiredDescription
object__vnullTo retrieve all workflows configured on an object, include the Vault object name__v and object record id field values as ?object__v={name__v}&record_id__v={id}. These two parameters are required when the participant parameter is not used.
record_id__vnullTo retrieve all workflows configured on an object, include the Vault object name__v and object record id field values as ?object__v={name__v}&record_id__v={id}. These two parameters are required when the participant parameter is not used.
participantnullTo retrieve all workflows available to a particular user, include the user id field value as ?participant={id}. To retrieve your own workflows, set this value to ?participant=me. This parameter is required when the object__v and record_id__v parameters are not used.
status__vnullTo retrieve all workflows with specific statuses, include one or more status name__v field values. For example: ?status__v=active__v, ?status__v=active__v,completed__v.
offsetnullThis parameter is used to paginate the results. It specifies the amount of offset from the first record returned. Vault returns 200 records per page by default. If you are viewing the first 200 results (page 1) and want to see the next page, set this to ?offset=201.
page_sizenullThis parameter is used to paginate the results. It specifies the size number of records to display per page. Vault returns 200 records per page by default. You can set this value lower or as high as 1000 records per page. For example: ?page_size=1000.
locnullWhen localized (translated) strings are available, retrieve them by including ?loc=true.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring
Acceptstring