> ## Documentation Index
> Fetch the complete documentation index at: https://docs.textsetu.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List TM entries

> Return a paginated page of the TM's source entries, each with its per-language translations. Filter by source text, language, or translation status and sort as needed.



## OpenAPI

````yaml /openapi/textsetu.json get /translation-memories/{tmId}/entries
openapi: 3.1.0
info:
  title: TextSetu API
  version: 1.2.0
  description: >-
    Public REST API for TextSetu. Authenticate with a Personal Access Token
    (tsu_pat_…) or a project token (tsu_proj_…) via the `Authorization: Bearer
    <token>` header.


    **Authorization is permission-based.** Every token carries an explicit
    allow-list of RBAC permission keys (e.g. `translation_read`), and each
    endpoint declares the permission it requires (`x-permission`). A token's
    effective access is its underlying authority ∩ its allow-list — a PAT is
    further bounded by its owner's role-based permissions, so it can only
    narrow, never exceed, what the owner already has. A project token is bound
    to a single project. There are no coarse read/write/manage scopes.


    **Response envelope.** Every endpoint returns `{ "success": true, "data": …
    }` on success and `{ "success": false, "error": { "code", "message" } }` on
    failure.


    **Rate limit.** 600 requests/minute, keyed by token (or by IP when
    unauthenticated). Exceeding it returns 429 with the standard error envelope.
servers:
  - url: https://api.textsetu.com/api/v1
    description: Production
  - url: /api/v1
    description: This server (self-hosted / same-origin)
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: >-
      Read project metadata — settings, key separator, and the
      approval/branching flags that shape how the other endpoints behave.
  - name: Languages
    description: >-
      List and manage a project's target languages. Each language is referenced
      by its BCP-47 code; the source language is flagged separately.
  - name: Translations
    description: >-
      Manage a project's translations: create, read, update, and delete
      translation keys — the identifiers your app looks up, carrying metadata
      (description, tags, screenshot) — and set the translated value for a key
      in a given language. Value writes honor the project's approval workflow —
      non-approver writes land as `pending_review`.
  - name: Stats
    description: >-
      Per-language completeness and approval progress for a project — the
      numbers behind the dashboard.
  - name: Import/Export
    description: >-
      Bulk-load source files into a project or export the current translations.
      Supports the same file formats as the web app.
  - name: Branches
    description: >-
      Work on translations in isolation and merge them back. Branch reads/writes
      mirror the main endpoints but stage changes as a diff until merge. See the
      [branching guide](/docs/guides/branches).
  - name: Glossary
    description: >-
      Manage term bases — approved terminology and its translations — and check
      a string against them. See the [glossary guide](/docs/guides/glossary).
  - name: Translation Memory
    description: >-
      Reusable translation stores. Fuzzy-match and concordance-search prior
      translations to reuse them. See the [translation memory
      guide](/docs/guides/translation-memory).
  - name: AI
    description: >-
      Machine-translate a project with the org's configured AI engine (brand
      voice, glossary/TM grounding, and an optional review pass). Runs
      asynchronously — start a run and poll the returned `jobId`.
  - name: Webhooks
    description: >-
      Get notified when a project's translations change, instead of polling.
      Register an HTTPS endpoint, subscribe it to the events you care about, and
      TextSetu POSTs a signed payload whenever one occurs. Payloads follow the
      [Standard Webhooks](https://www.standardwebhooks.com) spec — verify the
      `webhook-signature` header with any compatible library. Delivery is
      at-least-once and unordered, so treat `webhook-id` as an idempotency key.
      Failed deliveries are retried five times over roughly seven hours, and
      every attempt is inspectable and replayable via the delivery log.
  - name: Meta
    description: Service-level and cross-cutting endpoints.
paths:
  /translation-memories/{tmId}/entries:
    get:
      tags:
        - Translation Memory
      summary: List TM entries
      description: >-
        Return a paginated page of the TM's source entries, each with its
        per-language translations. Filter by source text, language, or
        translation status and sort as needed.
      parameters:
        - name: tmId
          in: path
          required: true
          schema:
            type: string
          description: Translation memory id (UUID) or id-embedded path slug.
        - name: page
          in: query
          description: 1-based page number (default 1).
          schema:
            default: 1
            type: integer
            minimum: 1
        - name: limit
          in: query
          description: Entries per page, 1–200 (default 50).
          schema:
            default: 50
            type: integer
            minimum: 1
            maximum: 200
        - name: search
          in: query
          description: Substring match on the entry's source text.
          schema:
            type: string
        - name: language
          in: query
          description: Only entries that have a translation in this language code.
          schema:
            type: string
        - name: status
          in: query
          description: >-
            Keep only entries with a translation in this status (`approved`,
            `pending_review`, `draft`).
          schema:
            type: string
            enum:
              - approved
              - pending_review
              - draft
        - name: sort
          in: query
          description: >-
            Sort field: `sourceText`, `createdAt`, or `updatedAt` (default
            `sourceText`).
          schema:
            default: sourceText
            type: string
            enum:
              - sourceText
              - createdAt
              - updatedAt
        - name: order
          in: query
          description: 'Sort direction: `asc` or `desc` (default `asc`).'
          schema:
            default: asc
            type: string
            enum:
              - asc
              - desc
      responses:
        '200':
          description: A page of TM entries with their translations.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    type: object
                    properties:
                      entries:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Unique TM entry id (UUID).
                              examples:
                                - tme_7b1c4d90
                            tmId:
                              type: string
                              description: >-
                                Id of the translation memory this entry belongs
                                to.
                              examples:
                                - tm_3f2a9b1c
                            sourceText:
                              type: string
                              description: >-
                                The source-language segment this entry stores
                                translations for.
                              examples:
                                - Welcome
                            context:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: >-
                                Optional context note disambiguating this entry,
                                or `null`.
                              examples:
                                - Greeting on the home page
                            createdAt:
                              type: string
                              description: Creation timestamp (ISO 8601).
                              examples:
                                - '2026-01-15T09:24:00.000Z'
                            updatedAt:
                              type: string
                              description: Last-update timestamp (ISO 8601).
                              examples:
                                - '2026-02-02T14:05:00.000Z'
                            translations:
                              type: array
                              items:
                                type: object
                                properties:
                                  languageCode:
                                    type: string
                                    description: BCP-47 language code of this translation.
                                    examples:
                                      - fr
                                  value:
                                    type: string
                                    description: >-
                                      The current (approved or draft) translated
                                      text for this language.
                                    examples:
                                      - Bienvenue
                                  status:
                                    type: string
                                    description: >-
                                      Review state: `approved`,
                                      `pending_review`, or `draft`.
                                    examples:
                                      - approved
                                  approvedAt:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                    description: >-
                                      Timestamp the value was approved (ISO
                                      8601), or `null` if not approved.
                                    examples:
                                      - '2026-01-16T11:00:00.000Z'
                                  proposedValue:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                    description: >-
                                      A pending proposal awaiting approval that
                                      has not yet replaced `value`, or `null`
                                      when none is pending.
                                    examples:
                                      - null
                                required:
                                  - languageCode
                                  - value
                                  - status
                                  - approvedAt
                                  - proposedValue
                                additionalProperties: false
                              description: Per-language translations of this entry.
                          required:
                            - id
                            - tmId
                            - sourceText
                            - context
                            - createdAt
                            - updatedAt
                            - translations
                          additionalProperties: false
                      total:
                        type: integer
                      page:
                        type: integer
                      limit:
                        type: integer
                    required:
                      - entries
                      - total
                      - page
                      - limit
                    additionalProperties: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API token: tsu_pat_… (PAT) or tsu_proj_… (project token). The token's
        granted RBAC permissions determine access; see each operation's
        `x-permission`.

````