Every open and working task with its records and its thread, plus the loose pool and the next task number.
/docs/api/tasks.txtPOST https://api.pixydesignapp.com/tasks
The board, agent side: every task that is open or working, each with its records and its thread, and the loose records beside them. Read this before pulling, the way the user reads the Edits panel.
Header: X-Pixy-Key carrying the agent key (px_sk_…).
Body: none.
Response:
| field | type | description |
|---|---|---|
tasks |
array | One entry per open or working task, oldest first. |
loose |
number | How many records are in no task yet. |
loose_edits |
array | Those records in full, the shape pull sets out. |
Each entry in tasks:
| field | type | description |
|---|---|---|
id |
string | The id that goes in a path. |
num |
number | The number the task shows under, Task #N. |
title |
string | What the user called it, or what you named it at ack. |
status |
string | open, or working while an agent holds the batch. |
agent_name |
string | Who holds it, when it is working. A name that is not yours means the batch is spoken for. |
messages |
array | The thread, oldest first: {"name", "text", "at"} per line. An empty name is the user. |
edits |
array | The task's new records, oldest first. |
A done task is not here. This is the live board, not the history.
Errors: invalid_key.
Example:
curl -X POST https://api.pixydesignapp.com/tasks \
-H 'X-Pixy-Key: px_sk_yourkey'