get https://api.textunited.com/segments/projects/custom/
This endpoint allows users to find a specific project using its unique custom ID. For detailed instructions on fetching projects by custom IDs, refer to the Project Listing guide.
Instructions
Ensure that your request includes the necessary headers. To test the request directly on the platform:
- Navigate to the HEADERS section below the Response Payload section:
- Enter the "Content-Type" header with the value "application/json".
- Include your "Authorization" token using either Basic Auth or JWT Access Token. For detailed instructions on obtaining these tokens, refer to the documentation on Obtaining your API key and company ID and Obtaining your JWT token.
- To test the functionality of your request with a specific path parameter:
- Locate the input field designated for the
{customId}parameter in the "Path Parameter" section, found under the "Response Payload" section.- Enter your desired value for {
customId}in this input field.- Execute the test directly on the platform by clicking the "Try It!" button at the top-right of your screen to initiate the request and view your response.
Sample Request and Response
To see a sample response, click the "EXAMPLES" dropdown at the top-right of your screen.
Response Payload
The following fields are returned after a successful request:
| Fields | Type | Description |
|---|---|---|
id | Integer | The unique identifier for the project. |
customId | String | A custom identifier for the project. |
taskId | Null/String | The unique identifier for the task associated with the project. Optional and may be null. |
name | String | The name of the project. |
description | String | A description of the project. |
creationDateUtc | DateTime | The date and time the project was created in UTC format. |
startDateUtc | DateTime | The start date and time of the project in UTC format. |
endDateUtc | DateTime | The end date and time of the project in UTC format. |
sourceLanguageId | Integer | The identifier for the source language of the project. |
sourceLanguageCode | String | The code for the source language of the project. |
targetLanguages | Array | An array of target languages for the project, including details such as language code and progress. |
domain | Null/String | The domain of the project. Optional and may be null. |
segments | Null/Array | An array of segments within the project. Optional and may be null. |
referenceNumber | String | A reference number for the project. |
customField1 | String | Additional information about the project. |
customField2 | String | Additional information about the project. |
Path Parameter
Enter the value of your Path parameter in the input field below for testing: