Purpose
What the Yeeflow REST API is for
The API is designed for external systems that need to read Yeeflow data, create or update list records, work with users and organization metadata, start or handle workflow activity, upload files, run supported Agent actions, or subscribe to event notifications.
Integrate operational data
- Query list items
- Create and update records
- Select only the fields a job needs
Connect process work
- Start workflows
- Read pending tasks
- Handle workflow tasks and variables
React to events
- Create webhook subscriptions
- Receive workflow task callbacks
- Route events into integration services
Use cases
What you can build
System integrations
- Sync records between Yeeflow and an ERP, CRM, data warehouse, or custom service.
- Provision users, departments, groups, positions, or Service Portal users from an external source.
Automation services
- Start workflow forms when an external business event occurs.
- Process tasks or variables from a trusted backend service.
- Subscribe to webhook events for downstream automation.
Preparation
Before you start
- Confirm which Yeeflow app, list, workflow, or Service Portal resource you need to access.
- Collect required IDs such as appID, listID, item ID, portal ID, or agent ID from Yeeflow.
- Create or request an API key in Yeeflow and store it server-side.
- Decide how your integration will handle retries, rate limits, and non-success response envelopes.
Use examples in these docs from trusted server code. Do not put API keys in browser-side JavaScript, public repositories, screenshots, analytics events, or client logs.
Endpoint root
Base URL
Send Yeeflow REST API requests to the versioned API base URL.
https://api.yeeflow.com/v1Authentication
Authentication summary
The OpenAPI source defines an API-key security scheme named ApiKeyAuth. Prefer the apiKey request header for server-side integrations.
curl "https://api.yeeflow.com/v1/lists/YOUR_APP_ID/YOUR_LIST_ID" \
-H "apiKey: YOUR_API_KEY"First request
Your first request
Start with a read-only request such as list details. Replace the placeholders with IDs from your Yeeflow environment and run the command from a trusted terminal or backend environment.
curl "https://api.yeeflow.com/v1/lists/YOUR_APP_ID/YOUR_LIST_ID" \
-H "apiKey: YOUR_API_KEY" \
-H "Accept: application/json"Limits
Rate limit summary
The copied OpenAPI overview documents rate limits per account. The current documented limit is a burst of 10 requests per second for all tiers.
| Product tier | Documented limit |
|---|---|
| All | Burst: 10 per second |
Use queues, scheduled jobs, or retry-with-backoff logic for integrations that move larger volumes of data.
Responses
Response envelope
The API overview documents a common JSON envelope. Check the HTTP response and the Yeeflow Status value before trusting Data.
{
"Status": 0,
"Data": {},
"Message": ""
}| Field | Meaning |
|---|---|
Status | Yeeflow request status. The documented success value is 0. |
Data | Endpoint-specific payload such as a record, list, ID, or object. |
Message | Human-readable detail when available, especially for non-success responses. |
Patterns
Core API patterns
Path IDs
- Many endpoints require appID, listID, item ID, portal ID, or agent ID.
- Keep those IDs in configuration instead of hard-coding them across jobs.
Fields and filters
- List item queries can select Fields, Filters, Sorts, PageIndex, and PageSize.
- The OpenAPI source notes indexed-field requirements for filtering and sorting.
Event callbacks
- Webhook callbacks are POST requests with Channel and Type headers.
- Receive callbacks in your own endpoint and verify payload handling before automating downstream work.
Reference map
API areas
The current OpenAPI source includes 11 API tags and 76 operations. The reference index groups them by developer job so you can start from the work you need to do.
Next steps