Menu
GETPOST learn/articles/list User APIService tier

List learn articles, or create one with POST. derived from route

URL

  • User APIhttps://www.mattering.io/api/user/v1/learn/articles/list
  • Service tierhttps://www.mattering.io/api/internal/v1/learn/articles/list

Pagination

Accepts limit and offset. The response meta carries total, limit and offset.

Responses

200 data and meta envelope

{
  "data": {
    "articles": [
      {
        "slug": "...",
        "title": "...",
        "excerpt": "...",
        "topic_slug": "...",
        "tags": [
          "..."
        ],
        "difficulty_level": "...",
        "related_products": "...",
        "featured": "...",
        "published": "...",
        "published_at": "2026-01-01T00:00:00Z",
        "reading_time": "...",
        "seo_title": "...",
        "seo_description": "...",
        "canonical_url": "...",
        "has_schema": true,
        "url_path": "...",
        "updated_at": "2026-01-01T00:00:00Z",
        "content": "...",
        "schema_jsonld": "..."
      }
    ]
  },
  "meta": {
    "total": 0,
    "limit": 0,
    "offset": 0
  }
}

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

Errors

StatusCode
400invalid_json
401unauthorized
500server_misconfigured

Example

curl -X GET "https://www.mattering.io/api/user/v1/learn/articles/list" \
  -H "Authorization: Bearer $MATTERING_API_KEY"

Source: education/api.py (api.list_articles)

POST learn/articles/manage User APIService tier

POST to learn/articles/manage. derived from route

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

URL

  • User APIhttps://www.mattering.io/api/user/v1/learn/articles/manage
  • Service tierhttps://www.mattering.io/api/internal/v1/learn/articles/manage

Body keys (JSON)

KeyRequiredDefault
actionoptional or conditionalnone
canonical_urloptional or conditionalnone
contentrequirednone
difficulty_leveloptional or conditionalnone
excerptrequirednone
featuredoptional or conditionalnone
publishedoptional or conditionalfalse
published_atoptional or conditionalnone
reading_timeoptional or conditionalnone
related_productsoptional or conditionalnone
schema_jsonldoptional or conditionalnone
seo_descriptionoptional or conditionalnone
seo_titleoptional or conditionalnone
slugrequirednone
tagsoptional or conditionalnone
titlerequirednone
topicoptional or conditionalnone
topic_slugrequirednone

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 data and meta envelope

{
  "data": {
    "article": {
      "slug": "...",
      "title": "...",
      "excerpt": "...",
      "topic_slug": "...",
      "tags": [
        "..."
      ],
      "difficulty_level": "...",
      "related_products": "...",
      "featured": "...",
      "published": "...",
      "published_at": "2026-01-01T00:00:00Z",
      "reading_time": "...",
      "seo_title": "...",
      "seo_description": "...",
      "canonical_url": "...",
      "has_schema": true,
      "url_path": "...",
      "updated_at": "2026-01-01T00:00:00Z",
      "content": "...",
      "schema_jsonld": "..."
    }
  }
}

200 data and meta envelope

{
  "data": {
    "deleted": "..."
  }
}

201 data and meta envelope

{
  "data": {
    "article": {
      "slug": "...",
      "title": "...",
      "excerpt": "...",
      "topic_slug": "...",
      "tags": [
        "..."
      ],
      "difficulty_level": "...",
      "related_products": "...",
      "featured": "...",
      "published": "...",
      "published_at": "2026-01-01T00:00:00Z",
      "reading_time": "...",
      "seo_title": "...",
      "seo_description": "...",
      "canonical_url": "...",
      "has_schema": true,
      "url_path": "...",
      "updated_at": "2026-01-01T00:00:00Z",
      "content": "...",
      "schema_jsonld": "..."
    }
  }
}

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

Errors

StatusCode
400field_too_long
400invalid_action
400invalid_json
400missing_field
401unauthorized
404article_not_found
409slug_exists
500server_misconfigured

Example

curl -X POST "https://www.mattering.io/api/user/v1/learn/articles/manage" \
  -H "Authorization: Bearer $MATTERING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "content": "...",
  "excerpt": "...",
  "slug": "...",
  "title": "...",
  "topic_slug": "...",
  "action": "...",
  "canonical_url": "...",
  "difficulty_level": "..."
}'

Source: education/api.py (api.manage_article)

GET learn/articles/{slug} User APIService tier

Read one of the learn articles by id. derived from route

URL

  • User APIhttps://www.mattering.io/api/user/v1/learn/articles/{slug}
  • Service tierhttps://www.mattering.io/api/internal/v1/learn/articles/{slug}

Path parameters

NameType
slugslug

Responses

200 data and meta envelope

{
  "data": {
    "article": {
      "slug": "...",
      "title": "...",
      "excerpt": "...",
      "topic_slug": "...",
      "tags": [
        "..."
      ],
      "difficulty_level": "...",
      "related_products": "...",
      "featured": "...",
      "published": "...",
      "published_at": "2026-01-01T00:00:00Z",
      "reading_time": "...",
      "seo_title": "...",
      "seo_description": "...",
      "canonical_url": "...",
      "has_schema": true,
      "url_path": "...",
      "updated_at": "2026-01-01T00:00:00Z",
      "content": "...",
      "schema_jsonld": "..."
    }
  }
}

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

Errors

StatusCode
401unauthorized
404article_not_found
500server_misconfigured

Example

curl -X GET "https://www.mattering.io/api/user/v1/learn/articles/SLUG" \
  -H "Authorization: Bearer $MATTERING_API_KEY"

Source: education/api.py (api.get_article)

POST learn/topics/manage User APIService tier

POST to learn/topics/manage. derived from route

URL

  • User APIhttps://www.mattering.io/api/user/v1/learn/topics/manage
  • Service tierhttps://www.mattering.io/api/internal/v1/learn/topics/manage

Body keys (JSON)

KeyRequiredDefault
actionoptional or conditionalnone
coloroptional or conditionalnone
cta_typeoptional or conditionalnone
descriptionoptional or conditionalnone
iconoptional or conditionalnone
namerequirednone
orderoptional or conditionalnone
slugrequirednone

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 data and meta envelope

{
  "data": {
    "deleted": true,
    "slug": "..."
  }
}

200 data and meta envelope

{
  "data": {
    "topic": {
      "slug": "...",
      "name": "...",
      "description": "...",
      "icon": "...",
      "color": "...",
      "cta_type": "...",
      "order": 0
    }
  }
}

201 data and meta envelope

{
  "data": {
    "topic": {
      "slug": "...",
      "name": "...",
      "description": "...",
      "icon": "...",
      "color": "...",
      "cta_type": "...",
      "order": 0
    }
  }
}

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

Errors

StatusCode
400invalid_action
400invalid_json
400missing_field
401unauthorized
404topic_not_found
409slug_exists
409topic_has_articles
500server_misconfigured

Example

curl -X POST "https://www.mattering.io/api/user/v1/learn/topics/manage" \
  -H "Authorization: Bearer $MATTERING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "...",
  "slug": "...",
  "action": "...",
  "color": "...",
  "cta_type": "...",
  "description": "...",
  "icon": "...",
  "order": "..."
}'

Source: education/api.py (api.manage_topic)

All Website resources
Start Free Explore our Products