Skip to content

List terms

GET/v1/wordlists/{id}/termsKey scope read

Lists the terms of a wordlist, oldest first.

Needs a key with the read scope. Authentication

curl "https://api.useinfrared.com/v1/wordlists/wl_5KcJIqikl2tXcuKJHvpzgO/terms?limit=2" \
  -H "Authorization: Bearer $INFRARED_KEY"
200 OKResponse
{
  "object": "list",
  "data": [
    {
      "object": "wordlist_entry",
      "id": "wle_1to4eNsIbVFc5HBXZpn8Xl",
      "term": "gift card",
      "canonical": null,
      "notes": null,
      "created_at": "2026-10-08T09:29:27.325Z"
    },
    {
      "object": "wordlist_entry",
      "id": "wle_1j49TIGIxx2aCL8OsJsz84",
      "term": "e-ticket",
      "canonical": "event ticket",
      "notes": null,
      "created_at": "2026-10-08T09:29:27.590Z"
    }
  ],
  "has_more": true,
  "next_cursor": "WyIyMDI2LTEwLTA4VDA5OjI5OjI3LjU5MFoiLCIzOGJkNzUzNC02ZTY2LTQ4M2UtODg1MC1kZTdmMTNjMjVmYTgiXQ"
}

Path parameters

idstringRequired

Id of the wordlist: wl_ plus 22 base62 characters.

Query parameters

limitintegerDefault 20

Number of terms to return, 1 to 500. Default 100.

cursorstring

The next_cursor of the previous page. Omit it for the first page.

Returns

A list object: data holds up to limit terms, has_more says whether another page exists and next_cursor is the value to send as cursor, or null on the last page.

  • 200 OKA list of wordlist entry objects

Errors

400
invalid_cursor

cursor is not a value returned by this endpoint.

404
not_found

The key's project has no wordlist with this id.

422
validation_error

limit is outside 1 to 500.

Every endpoint can also answer the errors any request can meet: a missing key, a rate limit, a malformed body. Errors

Something missing or unclear on this page? Write to support@useinfrared.com.