Menu
POST projects/manage/ User APIService tier

Create, update, or delete a project.

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/projects/manage/
  • Service tierhttps://productivity.mattering.io/api/internal/projects/manage/

Body keys (JSON)

KeyRequiredDefault
actionoptional or conditionalnone
descriptionoptional or conditionalnone
due_dateoptional or conditionalnone
folder_idoptional or conditionalnone
nameoptional or conditionalUntitled Project
owner_usernameoptional or conditionalnone
project_idoptional or conditionalnone
space_idoptional or conditionalnone
statusoptional or conditionalNOT_STARTED
user_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,
  "project": {
    "id": "...",
    "name": "..."
  },
  "tab": {
    "id": "...",
    "name": "..."
  }
}

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

Errors

StatusCode
400folder_id_required
400invalid action message
401missing_actor
401unauthorized
403forbidden
404folder_not_found
404project_not_found
404space_not_found

Example

curl -X POST "https://productivity.mattering.io/api/user/v1/projects/manage/" \
  -H "Authorization: Bearer $MATTERING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "...",
  "description": "...",
  "due_date": "...",
  "folder_id": "...",
  "name": "Untitled Project",
  "owner_username": "...",
  "project_id": "...",
  "space_id": "..."
}'

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

GET projects/{project_id}/access/ Service tier

What role does a person hold on a project? ``?email=`` names the person (the email rule); the answer is ``{data: {role: editor|viewer|none}}``.

Service tier only. The platform file service asks this when a Drive folder or file hangs off a Productivity project (files/acl.py, "project grant"), so the project's own editor/viewer grants decide who may open it.

URL

  • Service tierhttps://productivity.mattering.io/api/internal/projects/{project_id}/access/

Path parameters

NameType
project_idstr

Query parameters

NameDefault
emailnone

Responses

200 bare JSON object (no envelope)

{
  "data": {
    "role": "editor",
    "project_id": "...",
    "space_id": "..."
  },
  "meta": {}
}

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

Errors

StatusCode
400missing_field
401unauthorized
404project_not_found

Example

curl -X GET "https://productivity.mattering.io/api/internal/projects/PROJECT_ID/access/?email=..." \
  -H "X-Internal-Secret: $MATTERING_INTERNAL_API_SECRET" \
  -H "X-Internal-Org-Id: $ORG_ID" \
  -H "X-Internal-User-Email: you@example.com"

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

GET projects/{project_id}/canvas/ User APIService tier

Get project tabs and widgets with full config.

Query keys: compact=1 returns, per widget, only id, widget_type, widget_type_label, title, task_count, list_id and (task widgets) statuses / custom_fields: no position, size, order or raw config. A compact read performs no writes; the default full canvas keeps the task-widget self-heal, which itself only writes when a widget is malformed (missing backing list, non-canonical type, orphaned tasks).

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/projects/{project_id}/canvas/
  • Service tierhttps://productivity.mattering.io/api/internal/projects/{project_id}/canvas/

Path parameters

NameType
project_idstr

Query parameters

NameDefault
compactnone

Responses

200 bare JSON object (no envelope)

{
  "project": {
    "id": "...",
    "name": "...",
    "status": "...",
    "space_id": "..."
  },
  "tabs": [
    {
      "id": "...",
      "name": "...",
      "order": 0,
      "is_default": true,
      "widgets": [
        {
          "id": "...",
          "widget_type": "...",
          "widget_type_label": "...",
          "title": "...",
          "order": 0,
          "position_x": "...",
          "position_y": "...",
          "width": "...",
          "height": "...",
          "config": {
            "...": "..."
          },
          "task_count": 0,
          "list_id": "..."
        }
      ]
    }
  ]
}

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
404project_not_found

Example

curl -X GET "https://productivity.mattering.io/api/user/v1/projects/PROJECT_ID/canvas/?compact=..." \
  -H "Authorization: Bearer $MATTERING_API_KEY"

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

All Productivity resources
Start Free Explore our Products