Skip to main content
GET
/
v1
/
topics
List topics
curl --request GET \
  --url https://api.particle.pro/v1/topics \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "slug": "<string>",
      "ancestry": "<string>",
      "ancestry_path": "<string>",
      "episode_count": 123
    }
  ],
  "has_more": true,
  "cursor": "<string>"
}

Authorizations

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

Response

OK

data
object[] | null
required

List of results

has_more
boolean
required

Whether more results exist

cursor
string

Pass to next request for more results