Menu

Custom fields

2 endpoints in the Mattering Productivity API.

POST custom-fields/manage/ User APIService tier

Create, update, or delete an organization-level custom field.

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

Body keys (JSON)

KeyRequiredDefault
actionoptional or conditionalnone
default_valueoptional or conditionalnone
descriptionoptional or conditionalnone
field_idoptional or conditionalnone
field_typeoptional or conditionalTEXT_SMALL
is_requiredoptional or conditionalfalse
nameoptional or conditionalNew Field
optionsoptional or conditional[]
space_idoptional or conditionalnone
user_idoptional or conditionalnone
widget_idsoptional 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,
  "field": {
    "id": "...",
    "public_id": "...",
    "name": "...",
    "field_type": "..."
  }
}

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

Errors

StatusCode
400invalid action message
400invalid_field_type
401missing_actor
401unauthorized
403forbidden
404field_not_found
404space_not_found

Example

curl -X POST "https://productivity.mattering.io/api/user/v1/custom-fields/manage/" \
  -H "Authorization: Bearer $MATTERING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "...",
  "default_value": "...",
  "description": "...",
  "field_id": "...",
  "field_type": "TEXT_SMALL",
  "is_required": false,
  "name": "New Field",
  "options": []
}'

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

GET v1/custom-fields/usage/ Service tier

Service tier, polled by the platform: this organization's usage keyed by the platform definition id. Needs the shared secret (InternalAPIGuard) and ``X-Internal-Org-Id``.

URL

  • Service tierhttps://productivity.mattering.io/api/internal/v1/custom-fields/usage/

Responses

200 bare JSON object (no envelope)

{
  "ok": true,
  "usage": "..."
}

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

Errors

StatusCode
400X-Internal-Org-Id header required message
401unauthorized
405method_not_allowed

Example

curl -X GET "https://productivity.mattering.io/api/internal/v1/custom-fields/usage/" \
  -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/cf_usage.py (cf_usage.internal_usage)

All Productivity resources
Start Free Explore our Products