List topics

Returns the hierarchical topic taxonomy. Use parent_id to navigate the tree, or q to find topics by name.

GET /v1/topics

cURL

cURL

curl -H "X-API-Key: $PARTICLE_API_KEY" \
  "https://api.particle.pro/v1/topics?limit=25"

200

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "slug": "<string>",
      "ancestry": "<string>",
      "ancestry_path": "<string>",
      "episode_count": 123
    }
  ],
  "has_more": true,
  "cursor": "<string>"
}

Prefer the terminal? This endpoint is also a command in the Particle CLI: pick Particle CLI in the request example’s language menu. Install the Particle CLI.

Authorizations

ApiKeyHeaderBearerAuth

X-API-Key · string · header · required

Pass your API key in the X-API-Key header (recommended).

Query Parameters

limit · integer<int64> · default: 25

Results per page

Required range: 1 <= x <= 100

cursor · string

Opaque pagination cursor from previous response

parent_id · string

Get children of this topic. Accepts topic ID, ancestry slug, or ancestry path hash. Omit for top-level roots.

ancestry_path · string

Filter by exact ancestry path hash.

Maximum string length: 50

ancestry_path_prefix · string

Filter by ancestry path prefix (all descendants).

Maximum string length: 50

q · string

Find topics by name: exact names first, then names starting with q, then (when q has a word of 3 or more characters) names containing it, each ranked by story coverage. With parent_id or ancestry_path_prefix, searches that topic's descendants. Name search covers topics with at least 5 story clusters; browse with parent_id to reach the long tail.

Required string length: 2 - 100

Example:

"artificial intelligence"

Response

200

application/json

OK

data · object[] · required

List of results

Show child attributes

has_more · boolean · required

Whether more results exist

cursor · string

Pass to next request for more results