Skip to content

List vocabulary entries

One page of entries from one place: personal (the caller's private entries), list (one list the caller can read; needs list_id) or shared_with_me (other people's entries shared with the caller).

GEThttps://api.aitronos.com/v1/vocabulary/entries

Query Parameters

scope string required

Which entries to page: personal, list or shared_with_me.

list_id string optional

The list, for scope=list.

q string optional

Matches the written form or a spoken form, case-insensitively.

language string optional

A language tag.

kind string optional

bias or replace.

source string optional

How the entry was created.

enabled boolean optional

Only enabled or disabled entries.

sort string optional · Defaults to written

written, recent, applied, heard or corrected.

limit integer optional · Defaults to 50

Page size, 1 to 200.

offset integer optional · Defaults to 0

Entries to skip, up to 10000.


Returns

A page of entries:

object string

Always list.

data array of object

The entries on this page, each a vocabulary entry object as below.

total integer

All entries that match the filters.

id string

The entry ID: pdict_… for a private entry, tdict_… for one in a list.

scope string

personal for a private entry, list for an entry in a list.

list_id string or null

The list the entry belongs to, if any.

written string

How the word is written.

sounds_like array of string

How the word may be spoken or misheard.

language string or null

The language tag; null for all languages.

kind string

bias makes the word more likely to be recognised; replace also rewrites the spoken forms to the written form.

source string

How the entry was created.

weight number

How strongly the word is favoured, above 0 and up to 10.

enabled boolean

Whether the entry is used in transcripts.

visibility string

private for a private entry; list when everyone who reads the list sees it; restricted when only the people it is shared with see it.

shared boolean

Whether the entry is shared on its own.

owner_user_id string

The person who created the entry.

reached_through string

How the entry reached the caller.

can_edit boolean

Whether the caller may change the entry.

can_share boolean

Whether the caller may share the entry.

stats object

Usage counters: applied_count, heard_count, corrected_count, last_applied_at, last_heard_at.

created_at string

When the entry was created.

updated_at string

When the entry last changed.

cURL
curl -X GET "https://api.aitronos.com/v1/vocabulary/entries?scope=list&list_id=voclist_8f2a61c4e0b94d7a&sort=heard&limit=50" \
  -H "X-API-Key: $FREDDY_API_KEY"

Response:

200 OK
{
  "object": "list",
  "data": [
    {
      "id": "tdict_5a9c2e7b1d3f4068",
      "scope": "list",
      "list_id": "voclist_8f2a61c4e0b94d7a",
      "written": "Kubernetes",
      "sounds_like": [
        "cube ernetes",
        "kuber netties"
      ],
      "language": null,
      "kind": "bias",
      "source": "manual",
      "weight": 1.0,
      "enabled": true,
      "visibility": "list",
      "shared": false,
      "owner_user_id": "usr_3c91d0a2b7e4",
      "reached_through": "owner",
      "can_edit": true,
      "can_share": true,
      "stats": {
        "applied_count": 14,
        "heard_count": 9,
        "corrected_count": 0,
        "last_applied_at": "2026-10-24T09:30:00Z",
        "last_heard_at": "2026-10-24T09:30:00Z"
      },
      "created_at": "2026-10-24T09:30:00Z",
      "updated_at": "2026-10-24T09:30:00Z"
    }
  ],
  "total": 1
}