Use the REST API reference to find methods, paths, and resource IDs for an external integration. The interactive developer reference is also available.
The diagram shows a read request from a trusted backend. Keep the API key on that backend and check the response before using its data.
API FAQs
What can I do with the Yeeflow API?
Common operations include:
Read list records for a report or synchronization job.
Create records from an external system.
Update existing records.
Delete records when the integration is authorized to do so.
Read workflow task variables using the task ID.
Update supported user attributes.
Choose the endpoint for the actual resource and operation. A list ID, item ID, and workflow task ID identify different objects.
How do I get started?
Ask a system administrator to obtain an API key for the integration. See Access your API key.
Confirm the intended Yeeflow organization and collect the IDs required by the endpoint. Start with a resource whose expected contents you know.
Send a read-only request from trusted server-side code to
https://api.yeeflow.com/v1, using theapiKeyheader. Replace every placeholder in the example below.Check the HTTP response and the Yeeflow
Statusvalue. The documented success value is0; then verify thatDatadescribes the intended resource.
curl 'https://api.yeeflow.com/v1/lists/YOUR_APP_ID/YOUR_LIST_ID' \
-H 'apiKey: YOUR_API_KEY' \
-H 'Accept: application/json'
This example reads list details. Keep the real key out of browser scripts, shared screenshots, and source repositories. Authentication guidance
For failed requests, inspect the response and its Message before retrying. For list queries, plan how to retrieve the required pages and fields. Response handling · Pagination and filtering
Is there a rate limit?
The published API overview documents a burst limit of 10 requests per second per account across all pricing tiers. Coordinate jobs that share an account, queue larger batches, and use retry delays for transient or rate-limit failures. Check the current API overview when planning an integration.
Before retrying a write after a timeout, check whether it already took effect so that the retry does not create duplicate business records.

