REST API reference

API Reference Index

Start from the developer job you need to complete, then drill into the OpenAPI tag that contains the relevant methods and paths. Detailed per-endpoint pages are not part of this phase.

Browse API reference Authentication
REST APIConnect Yeeflow with external systems
OpenAPI 3.0.1apiKeyJSONWebhooksNo live console

Developer jobs

Reference grouped by use case

Data and records

Read list structure, query operational records, and create or update list items.

  • Synchronize Yeeflow list data with external systems
  • Create records from another workflow or service
  • Read selected fields for reporting or integration jobs
  • Attach files to list items or document libraries

Lists

List is a database-like data repository for managing business data. Use Lists APIs to query, add, update, and delete list items.

13 endpoints
GET/lists/{appID}/{listID}Get details for a list
GET/lists/{appID}/{listID}/fieldsGet fields of a list
POST/lists/{appID}/{listID}/itemsAdd an item to a list
POST/lists/{appID}/{listID}/items/batchAdd multiple items to a list
PATCH/lists/{appID}/{listID}/items/batchUpdate multiple items
POST/lists/{appID}/{listID}/items:batchDeleteDelete items from a list
PATCH/lists/{appID}/{listID}/items/{id}Update an item
DELETE/lists/{appID}/{listID}/items/{id}Delete an item
GET/lists/{appID}/{listID}/items/{id}Get an item by id
POST/lists/{appID}/{listID}/items/queryQuery list items
POST/lists/{appID}/{listID}/items/{id}/filesAdd file to item
POST/lists/{appID}/{listID}/libraryAdd file to document library
GET/lists/{appID}/{listID}/library/{id}/contentGet file from document library

Files

Upload files and retrieve file content by id.

2 endpoints
POST/filesUpload file
GET/files/{id}/contentGet file content by id

Organization

Manage users and organizational structures used by apps and approvals.

  • Search or provision users
  • Maintain departments, locations, groups, and positions
  • Assign users to groups or positions
  • Keep organization data aligned with an external directory

Users

Manage system users with user-specific operations, while broader user data can also be queried through Lists APIs.

8 endpoints
POST/usersAdd user
GET/usersGet a user by AccountID
POST/users/searchSearch users
GET/users/{id}Get a user by id
PUT/users/{id}Update a user by id
DELETE/users/{id}Delete a user
PUT/users/{id}/enableEnable a user
PUT/users/{id}/disableDisable a user

Departments

Query, add, edit, and delete departments.

4 endpoints
GET/departmentsGet departments
POST/departmentsAdd a department
PUT/departments/{id}Update a department
DELETE/departments/{id}Delete a department by id

Locations

Query, add, edit, and delete locations.

5 endpoints
GET/locationsGet all locations
POST/locationsAdd a location
GET/locations/{id}Get location by id
PUT/locations/{id}Update a location
DELETE/locations/{id}Delete a location

Groups

Query, add, edit, delete groups, and manage group membership.

7 endpoints
GET/groupsGet groups
POST/groupsAdd a group
PUT/groups/{id}Update a group
DELETE/groups/{id}Delete a group
POST/groups/{id}/usersAdd users to a group
GET/groups/{id}/usersGet users of a group
POST/groups/{id}/users/removeRemove users from a group

Positions

Query, add, edit, delete positions, and manage user assignments.

7 endpoints
POST/positionsAdd a position
GET/positionsGet positions
PUT/positions/{id}Update a position
DELETE/positions/{id}Delete a position
POST/positions/{id}/usersAssign users to a position
GET/positions/{id}/usersGet position assignment
POST/positions/{id}/users/removeRemove users from a position

ServicePortal

Operate Service Portal users, groups, passwords, and membership.

11 endpoints
POST/ServicePortal/{portalid}/usersCreate a user
GET/ServicePortal/{portalid}/users/searchSearch users
DELETE/ServicePortal/{portalid}/users/{id}Delete a user
POST/ServicePortal/{portalid}/users/{userid}/resetpwdSet password for a user
GET/ServicePortal/{portalid}/groupsGet groups
POST/ServicePortal/{portalid}/groupsCreate a group
PUT/ServicePortal/{portalid}/groups/{id}Update group
DELETE/ServicePortal/{portalid}/groups/{id}Delete a group
GET/ServicePortal/{portalid}/groups/{id}/users/countGet user count of a group
POST/ServicePortal/{portalid}/groups/{id}/usersAdd users to a group
POST/ServicePortal/{portalid}/groups/{id}/users/removeRemove users from a group

Process automation

Start workflows, inspect pending tasks, handle tasks, and maintain delegation settings.

  • Start a workflow from another system
  • Read pending tasks for a user or date range
  • Handle workflow tasks from an integration service
  • Read or update workflow form variables

Workflows

Start workflows, handle tasks, read variables, and manage delegate settings.

13 endpoints
POST/workflow/forms/startStart a workflow
GET/workflow/tasks/todoGet pending tasks
GET/workflow/tasks/{id}/variablesGet variables of task
PUT/workflow/tasks/{id}/handleProcess task
GET/workflow/delegatesGet delegations
POST/workflow/delegatesAdd a delegation
GET/workflow/delegates/{id}Get a delegation by ID
PUT/workflow/delegates/{id}Edit a delegation
DELETE/workflow/delegates/{id}Delete a delegation
PUT/workflow/delegates/{id}/enableEnable a delegation
PUT/workflow/delegates/{id}/disableDisable a delegation
GET/workflow/forms/{id}/variablesGet form variables
PUT/workflow/forms/{id}/variablesUpdate form variables

AI and automation

Discover and run Yeeflow AI Agents from API-driven automation flows.

  • List agents available for an application
  • Read an Agent definition before running it
  • Run an Agent from a governed integration service

Agents

Read and run Yeeflow AI Agent definitions.

3 endpoints
GET/applications/{listID}/agentsGet Agents of Application
GET/agents/{agentID}Get definition of an Agent
POST/agents/{agentID}/runRun an Agent

Events and webhooks

Subscribe to Yeeflow events and route change notifications into your own services.

  • Create webhook subscriptions for workflow task events
  • Route callbacks to an integration endpoint
  • Track event channel and type headers in receiving services

Webhooks

Subscribe to system object change events and inspect webhook subscriptions.

3 endpoints
POST/hooksCreate a webhook
GET/hooks/{id}Get a webhook by id
DELETE/hooks/{id}Delete a webhook by id
NextUnderstand response errors

We use cookies to improve your experience

We use necessary cookies to make the site work. With your permission, we also use analytics, marketing, and support cookies to understand usage, improve the website, and personalize interactions. You can accept all, reject non-essential cookies, or manage your preferences.