---
title: "List TM Segments"
method: GET
path: "/tms/{tmId}/segments"
tags: ["Translation Memory"]
---

# List TM Segments

`GET /tms/{tmId}/segments`

## Request

- Base URL: `https://api.crowdin.com/api/v2`
- URL: `https://api.crowdin.com/api/v2/tms/{tmId}/segments`
- Auth: none declared
- TypeScript: <https://skmtc.dev/crowdin/apis/crowdin-api-v2/docs/tms/:tmId/segments/get.ts> (a function with typed inputs; its response is checked against the schema)

**Required scopes:** `tm` (Read only).

Get list of translation unit segments

## Path parameters

- `tmId` integer, required

## Query parameters

- `orderBy` 'id'
- `limit` integer
- `offset` integer
- `croql` string

## Response `200`

TM segments list

- TmSegmentCollectionResource: Base schema of resource container. Container is a wrapper object that contains payload in required `data` property and provides space for adding any other metadata.
  - `data` TmSegmentResource[], required
    - `data` TmSegment, required
      - `id` integer: Segment Identifier
      - `records` object[]
        - `id` integer: Record Identifier
        - `languageId` string: Language Identifier
        - `text` string: Record text
        - `usageCount` integer: Count usage of segment record
        - `createdBy` integer: Creator User Identifier
        - `updatedBy` integer: Redactor User Identifier
        - `createdAt` string, date-time, nullable: Date in UTC, ISO 8601
        - `updatedAt` string, date-time, nullable: Date in UTC, ISO 8601
  - `pagination` Pagination: Pagination Response Model
    - `offset` integer
    - `limit` integer

## Other responses

- `400`: Invalid Request Parameters
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Tm with specified id was not found
- `405`: Method Not Allowed

---

[API](https://skmtc.dev/crowdin/apis/crowdin-api-v2.md) - [All operations](https://skmtc.dev/crowdin/apis/crowdin-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/crowdin/apis/crowdin-api-v2/revisions/27aae7751699?raw)