Skip to main content
GET
List translation memory segments

Paginating with cursors

This endpoint pages with an opaque cursor, unlike List translation memories, which uses numbered page values. Omit page_cursor on the first request, then pass each response’s next_page_cursor to get the following page. A response with no next_page_cursor is the last page.
Treat the cursor as opaque. Its format is not part of the API contract, so do not construct, decode, or increment it yourself. Cursors also encode the filter they were issued under: if you change filter_text or filter_case_sensitive, start again without a cursor.
segment_count is the total for the whole translation memory and is not reduced by filter_text. A filtered request still reports the full count, so do not use it to decide how many pages of filtered results to expect. Stop paginating when next_page_cursor is absent.

Filtering

filter_text matches against both source text and every target translation, and must be at least 2 characters. Matching is case-insensitive unless you set filter_case_sensitive=true.

Authorizations

Authorization
string
header
default:DeepL-Auth-Key
required

Authentication with Authorization header and DeepL-Auth-Key authentication scheme. Example: DeepL-Auth-Key <api-key>

Path Parameters

translation_memory_id
string<uuid>
required

The ID of the translation memory whose segments you want to list. A unique ID assigned to a translation memory.

Example:

"a74d88fb-ed2a-4943-a664-a4512398b994"

Query Parameters

page_size
integer
default:50

The maximum number of segments to return per page. Values above 100 are reduced to 100.

Required range: 1 <= x <= 100
page_cursor
string

The next_page_cursor from a previous response. Omit this on your first call. Treat the value as opaque: do not build or modify it yourself.

filter_text
string

Return only segments where this text appears in the source or in any target translation. Must be at least 2 characters.

Minimum string length: 2
filter_case_sensitive
boolean
default:false

Whether filter_text is matched case-sensitively.

Response

Returns a page of segments.

segments
object[]
required

The segments on this page.

segment_count
integer
required

The total number of segments in the translation memory. This is not reduced by filter_text, so a filtered request still reports the full count. Do not use it to predict how many results a filtered query returns.

Example:

3542

next_page_cursor
string

The cursor to pass as page_cursor to retrieve the next page. Absent on the last page.

Example:

"eyJvZmZzZXQiOjUwfQ"