Menu

Queries

4 endpoints in the Mattering Productivity API.

POST query/batch/ User APIService tier

Return batch metadata + serialized tasks in the batch.

Recognized config keys: batch_id (required), include_fields, transcription_order, filters.

URL

  • User APIhttps://productivity.mattering.io/api/user/v1/query/batch/
  • Service tierhttps://productivity.mattering.io/api/internal/query/batch/

Body keys (JSON)

KeyRequiredDefault
configoptional or conditionalnone
space_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. The response meta carries total, limit and offset.

Responses

200 bare JSON object (no envelope)

{
  "success": true,
  "meta": "...",
  "data": {
    "type": "query",
    "query": "query_batch",
    "batch": {
      "id": "...",
      "name": "...",
      "widget_id": "...",
      "space_id": "...",
      "custom_fields": {
        "...": "..."
      },
      "fields": [
        "..."
      ]
    },
    "tasks": [
      "..."
    ],
    "task_count": 0
  }
}

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

Errors

StatusCode
401missing_actor
401unauthorized
403forbidden

Example

curl -X POST "https://productivity.mattering.io/api/user/v1/query/batch/" \
  -H "Authorization: Bearer $MATTERING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "config": "...",
  "space_id": "..."
}'

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

POST query/project/ User APIService tier

Return project info + serialized tasks in the project.

Recognized config keys: project_id (required), include_fields, transcription_order, filters.

URL

  • User APIhttps://productivity.mattering.io/api/user/v1/query/project/
  • Service tierhttps://productivity.mattering.io/api/internal/query/project/

Body keys (JSON)

KeyRequiredDefault
configoptional or conditionalnone
space_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. The response meta carries total, limit and offset.

Responses

200 bare JSON object (no envelope)

{
  "success": true,
  "meta": "...",
  "data": {
    "type": "query",
    "query": "query_project",
    "project": {
      "id": "...",
      "name": "..."
    },
    "tasks": [
      "..."
    ],
    "task_count": 0
  }
}

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

Errors

StatusCode
401missing_actor
401unauthorized
403forbidden

Example

curl -X POST "https://productivity.mattering.io/api/user/v1/query/project/" \
  -H "Authorization: Bearer $MATTERING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "config": "...",
  "space_id": "..."
}'

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

POST query/task/ User APIService tier

Return a single fully-serialized task.

Recognized config keys: task_id (required), include_fields, transcription_order.

This read is not paginated. It returns at most 8 rows and does not report a total, so a result of exactly 8 may be truncated.

URL

  • User APIhttps://productivity.mattering.io/api/user/v1/query/task/
  • Service tierhttps://productivity.mattering.io/api/internal/query/task/

Body keys (JSON)

KeyRequiredDefault
configoptional or conditionalnone
space_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.

Responses

200 bare JSON object (no envelope)

{
  "success": true,
  "data": {
    "type": "query",
    "query": "query_task",
    "error": "No task_id provided."
  }
}

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

Errors

StatusCode
401missing_actor
401unauthorized
403forbidden

Example

curl -X POST "https://productivity.mattering.io/api/user/v1/query/task/" \
  -H "Authorization: Bearer $MATTERING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "config": "...",
  "space_id": "..."
}'

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

POST query/widget/ User APIService tier

Return widget info + serialized tasks in the widget's backing list.

Recognized config keys: widget_id (required), include_fields, transcription_order, filters.

URL

  • User APIhttps://productivity.mattering.io/api/user/v1/query/widget/
  • Service tierhttps://productivity.mattering.io/api/internal/query/widget/

Body keys (JSON)

KeyRequiredDefault
configoptional or conditionalnone
meta_onlyoptional or conditionalnone
space_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. The response meta carries total, limit and offset.

Responses

200 bare JSON object (no envelope)

{
  "success": true,
  "meta": {
    "total": 0,
    "limit": 0,
    "offset": 0,
    "returned": 0,
    "has_more": true,
    "meta_only": true
  },
  "data": {
    "type": "query",
    "query": "query_widget",
    "widget": {
      "id": "...",
      "title": "...",
      "widget_type": "...",
      "widget_type_label": "..."
    },
    "tasks": [],
    "task_count": 0
  }
}

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

Errors

StatusCode
401missing_actor
401unauthorized
403forbidden

Example

curl -X POST "https://productivity.mattering.io/api/user/v1/query/widget/" \
  -H "Authorization: Bearer $MATTERING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "config": "...",
  "meta_only": "...",
  "space_id": "..."
}'

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

All Productivity resources
Start Free Explore our Products