API Examples

Use POST /users/search to retrieve users with paging and optional search criteria from the documented SearchUsersRequest schema.

curl "https://api.yeeflow.com/v1/users/search" \
  -H "apiKey: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "PageIndex": 1,
    "PageSize": 20,
    "SearchKey": "example"
  }'

curl "https://api.yeeflow.com/v1/lists/YOUR_APP_ID/YOUR_LIST_ID/items/query" \
  -H "apiKey: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "Fields": ["Title", "Text1"],
    "Filters": [
      {
        "Field": "Title",
        "Type": 8,
        "Value": "Project"
      }
    ],
    "PageIndex": 1,
    "PageSize": 20
  }'

The add-item endpoint accepts a Data object whose keys are field names and whose values are strings, matching the OpenAPI schema.

curl "https://api.yeeflow.com/v1/lists/YOUR_APP_ID/YOUR_LIST_ID/items" \
  -H "apiKey: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "Data": {
      "Title": "Hello World",
      "Text1": "Field 1",
      "Text3": "[\"Option1\", \"Option2\"]"
    }
  }'

The update endpoint is a PATCH request. The OpenAPI source documents RowVersion; set it to 0 when intentionally forcing an overwrite.

curl -X PATCH "https://api.yeeflow.com/v1/lists/YOUR_APP_ID/YOUR_LIST_ID/items/YOUR_ITEM_ID" \
  -H "apiKey: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "RowVersion": 0,
    "Data": {
      "Title": "Updated title"
    }
  }'

The current OpenAPI source documents webhook subscriptions for workflow task events. The Settings.callbackUrl value should point to your HTTPS receiving endpoint.

curl "https://api.yeeflow.com/v1/hooks" \
  -H "apiKey: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "Resource": "workflow/tasks",
    "Channel": "operations-sync",
    "Type": 3,
    "Settings": {
      "callbackUrl": "YOUR_WEBHOOK_URL"
    }
  }'

The OpenAPI tag description says Yeeflow sends webhook callbacks with the POST method, Channel and Type headers, and an application/json body whose schema depends on the subscribed resource.

export async function POST(request: Request) {
  const channel = request.headers.get("Channel");
  const type = request.headers.get("Type");
  const event = await request.json();

  // Validate channel, type, and payload shape for your subscribed resource.
  console.log({ channel, type, event });

  return new Response("ok", { status: 200 });
}