API Reference

Get Segments by Custom ID

get
https://api.textunited.com/segments/projects/custom//segments

This endpoint lets you retrieve all the different translations for a particular project, using its custom ID. For comprehensive guidance on retrieving segments by custom IDs, including how to filter and sort the results, see the Getting Segments by Custom ID guide.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier for the project in the external system.

Query Params
string

Filters segments by their status (untranslated, draft, automatic, pretranslated, translated, proofread). Omitting this parameter retrieves all segments. (e.g., "status=translated")

string

Filters segments belonging to a specific task by its ID. (e.g., "taskId=task_001")

Headers
string
Defaults to application/json

Indicates the media type of the resource, specifying that the payload is in JSON format. (e.g. Content-Type: application/json)

string

Used for authenticating requests with a JWT token obtained from the "Obtain JWT" endpoint. (e.g. Authorization: Bearer <your_api_token>)

Responses

Updated 11 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago