Articles in this section

Available Veeva APIs

When you configure an export, import, other type of flow step using the prebuilt Veeva connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Veeva API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource API endpoint

Export

Import

Binders: Binder documents Add document to binder

 

X

Move document in binder

 

X

Remove document from binder

 

X

Binders: Binder relationships Retrieve binder relationship

X

 

Delete binder relationship

 

X

Create binder relationship

 

X

Binders: Binder sections Retrieve binder sections

X

 

Delete binder section

 

X

Retrieve binder version section

X

 

Create binder section

 

X

Update binder section

 

X

Binders: Binder templates Retrieve binder template metadata

X

 

Retrieve binder template node metadata

X

 

Retrieve binder template collection

X

 

Update binder template

 

X

Bulk update binder templates

 

X

Create binder template

 

X

Bulk create binder templates

 

X

Retrieve binder template attributes

X

 

Delete binder template

 

X

Retrieve binder template node attributes

X

 

Replace binder template nodes

 

X

Create binder template node

 

X

Binders: Binding rules Update binding rule

 

X

Update binder section binding rule

 

X

Update binder document binding rule

 

X

Binders: Create binders Create binder version

 

X

Create binder

 

X

Create binder from template

 

X

Binders: Delete binders Delete binder

 

X

Delete binder version

 

X

Binders: Export binders Export binder

X

 

Export binder version

X

 

Retrieve binder export results

X

 

Binders: Retrieve binders Retrieve binder

X

 

Retrieve all binder versions

X

 

Retrieve binder version

X

 

Binders: Update binders Update binder

 

X

Reclassify binder

 

X

Update binder version

 

X

Refresh binder auto-filing

 

X

Bulk translation Export bulk translation file

X

 

Import bulk translation file

 

X

Retrieve import bulk translation file job summary

X

 

Retrieve import bulk translation file job errors

X

 

Export label set

X

 

Configuration migration Import package

 

X

Export package

X

 

Deploy package

 

X

Retrieve package deploy results

X

 

Retrieve outbound package dependencies

X

 

Component definition query

X

 

Vault compare

 

X

Vault configuration report

 

X

Validate package

 

X

Enable configuration mode

 

X

Disable configuration mode

 

X

Custom pages Retrieve all client code distribution metadata

X

 

Add or replace single client code distribution

 

X

Retrieve single client code distribution metadata

X

 

Delete single client code distribution

 

X

Download single client code distribution

X

 

Direct data Retrieve available direct data files

X

 

Download direct data file

X

 

Document and binder roles: Binder roles Retrieve all binder roles

X

 

Assign users and groups to roles on a single binder

 

X

Retrieve binder role

X

 

Remove users and groups from roles on a single binder

 

X

Document and binder roles: Document roles Retrieve all document roles

X

 

Assign users and groups to roles on a single document

 

X

Retrieve document role

X

 

Assign users and groups to roles on multiple documents and binders

 

X

Remove users and groups from roles on multiple documents and binders

 

X

Remove users and groups from roles on a single document

 

X

Document lifecycle and workflows: Binder user actions Retrieve binder user actions

X

 

Retrieve user actions on multiple binders

X

 

Retrieve binder entry criteria

X

 

Initiate binder user action

 

X

Initiate bulk binder user actions

 

X

Document lifecycle and workflows: Document user actions Retrieve document user actions

X

 

Retrieve user actions on multiple documents

X

 

Retrieve document entry criteria

X

 

Initiate document user action

 

X

Download controlled copy job results

X

 

Initiate bulk document user actions

 

X

Document lifecycle and workflows: Document workflows Retrieve all document workflows

X

 

Retrieve document workflow details

X

 

Initiate document workflow

 

X

Document lifecycle and workflows: Lifecycle role assignment rules Retrieve lifecycle role assignment rules (default and override)

X

 

Update lifecycle role assignment rules (default and override)

 

X

Create lifecycle role assignment override rules

 

X

Delete lifecycle role assignment override rules

 

X

Documents Document tokens

 

X

Documents: Create documents Create single document

 

X

Create multiple documents

 

X

Documents: Delete documents Delete single document

 

X

Delete single document version

 

X

Delete multiple documents

 

X

Delete multiple document versions

 

X

Retrieve deleted document IDs

X

 

Documents: Document annotations Retrieve annotation type metadata

X

 

Retrieve annotation placemark type metadata

X

 

Retrieve annotation reference type metadata

X

 

Update annotations

 

X

Create multiple annotations

 

X

Delete annotations

 

X

Add annotation replies

 

X

Read annotations by document version and type

X

 

Read annotations by ID

X

 

Read replies of parent annotation

X

 

Export document annotations to PDF

X

 

Import document annotations from PDF

 

X

Export document version annotations to PDF

X

 

Import document version annotations from PDF

 

X

Documents: Document attachments Determine if a document has attachments

X

 

Retrieve document attachments

X

 

Create document attachment

 

X

Retrieve document version attachments

X

 

Retrieve document attachment versions

X

 

Retrieve document version attachment versions

X

 

Retrieve document version attachment version metadata

X

 

Retrieve document attachment metadata

X

 

Update document attachment description

 

X

Delete single document attachment

 

X

Retrieve document attachment version metadata

X

 

Restore document attachment version

 

X

Delete single document attachment version

 

X

Download document attachment

X

 

Download document attachment version

X

 

Download document version attachment version

X

 

Download all document attachments

X

 

Download all document version attachments

X

 

Update multiple document attachment descriptions

 

X

Create multiple document attachments

 

X

Delete multiple document attachments

 

X

Retrieve deleted document attachments

X

 

Documents: Document events Retrieve document event types and subtypes

X

 

Retrieve document event subtype metadata

X

 

Create document event

 

X

Retrieve document events

X

 

Documents: Document locks Retrieve document lock metadata

X

 

Retrieve document lock

X

 

Create document lock

 

X

Delete document lock

 

X

Undo collaborative authoring checkout

 

X

Documents: Document relationships Retrieve document type relationships

X

 

Retrieve document relationships

X

 

Create single document relationship

 

X

Create multiple document relationships

 

X

Delete multiple document relationships

 

X

Retrieve document relationship

X

 

Delete single document relationship

 

X

Documents: Document renditions Retrieve document renditions

X

 

Retrieve document version renditions

X

 

Download document rendition file

X

 

Replace document rendition

 

X

Add single document rendition

 

X

Delete single document rendition

 

X

Download document version rendition file

X

 

Replace document version rendition

 

X

Upload document version rendition

 

X

Delete document version rendition

 

X

Add multiple document renditions

 

X

Delete multiple document renditions

 

X

Update multiple document renditions

 

X

Documents: Document signatures Retrieve document signature metadata

X

 

Retrieve archived document signature metadata

X

 

Documents: Document templates Retrieve document template metadata

X

 

Retrieve document template collection

X

 

Update multiple document templates

 

X

Create single document template

 

X

Create multiple document templates

 

X

Retrieve document template attributes

X

 

Update single document template

 

X

Delete basic document template

 

X

Download document template file

X

 

Documents: Export documents Export documents

X

 

Export document versions

X

 

Retrieve document export results

X

 

Documents: Retrieve document fields Retrieve all document fields

X

 

Retrieve common document fields

X

 

Documents: Retrieve document types Retrieve all document types

X

 

Retrieve document type

X

 

Retrieve document subtype

X

 

Retrieve document classification

X

 

Documents: Retrieve documents Retrieve document

X

 

Retrieve document versions

X

 

Retrieve document version

X

 

Retrieve document version text

X

 

Download document file

X

 

Download document version file

X

 

Download document version thumbnail file

X

 

Documents: Update documents Update single document

 

X

Create single document version

 

X

Update document version

 

X

Update multiple documents

 

X

Reclassify single document

 

X

Reclassify multiple documents

 

X

Create multiple document versions

 

X

Domain information Retrieve domain information

X

 

Retrieve domains

X

 

Expected document lists Create a placeholder from an EDL item

 

X

Retrieve all root nodes

X

 

Retrieve specific root nodes

X

 

Retrieve a node's children

X

 

Update node order

 

X

Bulk update node order

 

X

Add EDL matched documents

 

X

Remove EDL matched documents

 

X

File staging List items at a path

X

 

Update folder or file

 

X

Delete file or folder

 

X

Download item content

X

 

Create folder or file

 

X

File staging: Resumable upload sessions Create resumable upload session

 

X

Get upload session details

X

 

Commit upload session

 

X

Abort upload session

 

X

List upload sessions

X

 

List file parts uploaded to session

X

 

Groups Retrieve group metadata

X

 

Retrieve all groups

X

 

Create group

 

X

Retrieve auto managed groups

X

 

Retrieve group

X

 

Update group

 

X

Delete group

 

X

Jobs Retrieve job status

X

 

Retrieve SDK job tasks

X

 

Retrieve job histories

X

 

Retrieve job monitors

X

 

Start job

 

X

Cancel job

 

X

Logs Retrieve email notification histories

X

 

Download daily API usage

X

 

Download SDK runtime log

X

 

Download workflow activity log

X

 

Logs: Audit Retrieve audit types

X

 

Retrieve audit metadata

X

 

Retrieve audit details

X

 

Logs: Audit history Retrieve complete audit history for a single document

X

 

Retrieve complete audit history for a single object record

X

 

Logs: SDK debug log Retrieve all debug logs

X

 

Create debug log

 

X

Retrieve single debug log

X

 

Download debug log files

X

 

Reset debug log

 

X

Delete debug log

 

X

Logs: SDK request profiler Retrieve all profiling sessions

X

 

Create profiling session

 

X

Retrieve profiling session

X

 

Delete profiling session

 

X

End profiling session

 

X

Download profiling session results

X

 

Logs: VQL query profiler List all sessions

X

 

Create new session

 

X

List single session

X

 

Delete session

 

X

End active session

 

X

Download session results

X

 

Managing Vault Java SDK Retrieve single source code file

X

 

Delete single source code file

 

X

Enable Vault extension

 

X

Disable Vault extension

 

X

Add or replace single source code file

 

X

Validate imported package

 

X

Retrieve signing certificate

X

 

Managing Vault Java SDK: Queues Retrieve all queues

X

 

Retrieve queue status

X

 

Disable delivery

 

X

Enable delivery

 

X

Reset queue

 

X

Metadata definition language (MDL) Retrieve all component metadata

X

 

Retrieve component type metadata

X

 

Metadata definition language (MDL): Asynchronous MDL requests Cancel raw object deployment

 

X

Metadata definition language (MDL): Retrieve component records Retrieve component record collection

X

 

Retrieve component record (XML/JSON)

X

 

Object lifecycle and workflows: Multi-record workflows Retrieve all multi-record workflows

X

 

Retrieve multi-record workflow details

X

 

Initiate multi-record workflow

 

X

Object lifecycle and workflows: Object record user actions Retrieve object record user actions

X

 

Retrieve object user actions details

X

 

Initiate object action on a single record

 

X

Initiate object action on multiple records

 

X

Picklists Retrieve all picklists

X

 

Retrieve picklist values

X

 

Update picklist value label

 

X

Create picklist values

 

X

Update picklist value

 

X

Inactivate picklist value

 

X

Sandbox Vaults Retrieve sandboxes

X

 

Create or refresh sandbox

 

X

Retrieve sandbox details by ID

X

 

Recheck sandbox usage limit

 

X

Change sandbox size

 

X

Set sandbox entitlements

 

X

Refresh sandbox from snapshot

 

X

Delete sandbox

 

X

Generate API access token for sandbox

 

X

Sandbox Vaults: Pre-production Vaults Build production Vault

 

X

Promote to production

 

X

Sandbox Vaults: Sandbox snapshots Retrieve sandbox snapshots

X

 

Create sandbox snapshot

 

X

Delete sandbox snapshot

 

X

Update sandbox snapshot

 

X

Upgrade sandbox snapshot

 

X

SCIM: Discovery endpoints Retrieve SCIM provider

X

 

Retrieve all SCIM schema information

X

 

Retrieve single SCIM schema information

X

 

Retrieve all SCIM resource types

X

 

Retrieve single SCIM resource type

X

 

SCIM: Users Retrieve all users with SCIM

X

 

Create user with SCIM

 

X

Retrieve single user with SCIM

X

 

Update user with SCIM

 

X

Retrieve current user with SCIM

X

 

Update current user with SCIM

 

X

Retrieve SCIM resources

X

 

Retrieve single SCIM resource

X

 

Security policies Retrieve security policy metadata

X

 

Retrieve all security policies

X

 

Retrieve security policy

X

 

Users Retrieve user

X

 

Validate session user

X

 

Retrieve user metadata

X

 

Retrieve all users

X

 

Disable user

 

X

Change my password

 

X

Update Vault membership

 

X

Retrieve application license usage

X

 

Retrieve user permissions

X

 

Retrieve my user permissions

X

 

Users: API access tokens Generate API access token

 

X

Generate my API access token

 

X

Users: Create users Create single user

 

X

Create multiple users

 

X

Users: Update users Update multiple users

 

X

Update single user

 

X

Update my user

 

X

Vault AI Retrieve all agents

X

 

Retrieve agent

X

 

Retrieve all agent actions

X

 

Retrieve agent action

X

 

Execute agent action

 

X

Retrieve agent action execution status

X

 

Cancel agent action execution

 

X

Vault loader: Multi-file extract Extract data files

X

 

Retrieve loader extract results

X

 

Retrieve loader extract renditions results

X

 

Retrieve loader extract text results

X

 

Vault loader: Multi-file load Load data objects

 

X

Retrieve load success log results

X

 

Retrieve load failure log results

X

 

Vault objects Retrieve object metadata

X

 

Retrieve object field metadata

X

 

Retrieve object collection

X

 

Retrieve object records

X

 

Retrieve object record

X

 

Update object records

 

X

Create and upsert object records

 

X

Delete object records

 

X

Cascade delete object record

 

X

Retrieve results of cascade delete job

X

 

Deep copy object record

 

X

Retrieve results of deep copy job

X

 

Retrieve deleted object record ID

X

 

Retrieve limits on objects

X

 

Update corporate currency fields

 

X

Vault objects: Merge object records Initiate record merge

 

X

Retrieve record merge status

X

 

Retrieve record merge results

X

 

Download merge records job log

X

 

Vault objects: Object attachment fields Download attachment field file

X

 

Update attachment field file

 

X

Download all attachment field files

X

 

Export attachment field files

X

 

Retrieve attachment field files export results

X

 

Download attachment field files export

X

 

Vault objects: Object page layouts Retrieve page layouts

X

 

Retrieve page layout metadata

X

 

Vault objects: Object record attachments Determine if attachments are enabled on an object

X

 

Retrieve object record attachments

X

 

Create object record attachment

 

X

Retrieve object record attachment metadata

X

 

Update object record attachment description

 

X

Delete object record attachment

 

X

Retrieve object record attachment versions

X

 

Retrieve object record attachment version metadata

X

 

Retrieve deleted object record attachments

X

 

Restore object record attachment version

 

X

Delete object record attachment version

 

X

Download object record attachment file

X

 

Download object record attachment version file

X

 

Download all object record attachment files

X

 

Update multiple object record attachment descriptions

 

X

Create multiple object record attachments

 

X

Delete multiple object record attachments

 

X

Vault objects: Object roles Retrieve object record roles

X

 

Assign users and groups to roles on object records

 

X

Remove users and groups from roles on object records

 

X

Vault objects: Object types Retrieve details from all object types

X

 

Retrieve details from a specific object

X

 

Change object type

 

X

Vault objects: Roll-up fields Retrieve roll-up field recalculation status

X

 

Recalculate roll-up fields

 

X

Vault query language (VQL) Submit a query

X

 

Workflows Retrieve workflows

X

 

Retrieve workflow details

X

 

Retrieve workflow actions

X

 

Retrieve workflow action details

X

 

Initiate workflow action

 

X

Complete job step

 

X

Workflows: Bulk active workflow actions Retrieve bulk workflow actions

X

 

Retrieve bulk workflow action details

X

 

Initiate workflow actions on multiple workflows

 

X

Cancel workflows

 

X

Cancel workflow tasks

 

X

Reassign workflow tasks

 

X

Replace workflow owner

 

X

Workflows: Workflow tasks Retrieve workflow tasks

X

 

Retrieve workflow task details

X

 

Retrieve workflow task actions

X

 

Retrieve workflow task action details

X

 

Accept multi-item workflow task

 

X

Accept single record workflow task

 

X

Undo workflow task acceptance

 

X

Complete multi-item workflow task

 

X

Complete single record workflow task

 

X

Reassign multi-item workflow task

 

X

Reassign single record workflow task

 

X

Update workflow task due date

 

X

Cancel workflow task

 

X

Manage multi-item workflow content

 

X