Menu

Batches

1 endpoint in the Mattering Productivity API.

POST batches/manage/ User APIService tier

List, create, update, or delete task batches.

URL

  • User APIhttps://productivity.mattering.io/api/user/v1/batches/manage/
  • Service tierhttps://productivity.mattering.io/api/internal/batches/manage/

Body keys (JSON)

KeyRequiredDefault
actionoptional or conditionalnone
batch_idoptional or conditionalnone
custom_fieldsoptional or conditional{}
limitoptional or conditional100
nameoptional or conditionalNew Batch
names_onlyoptional or conditionalnone
offsetoptional or conditional0
task_idsoptional or conditionalnone
user_idoptional or conditionalnone
widget_idoptional or conditionalnone

Keys the view reads. A key not in this list is ignored by the view. Where a key is required only for some actions (for example the action dispatch), the description above says which.

Pagination

Accepts limit and offset and the server caps limit at 500. Check the response for a total or count field.

Responses

200 bare JSON object (no envelope)

{
  "success": true,
  "batch": {
    "id": "...",
    "name": "..."
  }
}

200 bare JSON object (no envelope)

{
  "batches": [
    {
      "id": "...",
      "name": "...",
      "task_count": 0
    }
  ],
  "total": 0,
  "limit": 100,
  "offset": 0,
  "has_more": true
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
400invalid action message
401missing_actor
401unauthorized
403forbidden
404batch_not_found
404widget_not_found

Example

curl -X POST "https://productivity.mattering.io/api/user/v1/batches/manage/" \
  -H "Authorization: Bearer $MATTERING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "...",
  "batch_id": "...",
  "custom_fields": {},
  "limit": 100,
  "name": "New Batch",
  "names_only": "...",
  "offset": 0,
  "task_ids": "..."
}'

Source: MatteringPMCore/internal_api.py (internal_api.internal_manage_batch)

All Productivity resources
Start Free Explore our Products