Project Templates

List project templates

OAuth: This endpoint requires one of the following scopes: project:manage, project:read or project:write.

List API Templates

GEThttps://api.textmaster.com/v1/clients/api_templates

Authorization

oauth2

Query parameters

Response

200401

Lists API Templates

Body

application/json

total_pagesinteger

countinteger

pageinteger

per_pageinteger

previous_pagenullable integer

next_pagenullable integer

api_templatesarray of ApiTemplate (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.textmaster.com/v1/clients/api_templates', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "total_pages": 0,
  "count": 0,
  "page": 0,
  "per_page": 0,
  "previous_page": 0,
  "next_page": 0,
  "api_templates": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "level_name": "enterprise",
      "activity_name": "translation",
      "language_from": "text",
      "language_to": "text",
      "project_briefing": "text",
      "options": {
        "language_level": "enterprise"
      },
      "textmasters": [
        "text"
      ],
      "cost_per_word": {
        "currency": "text",
        "amount": 0
      },
      "cost_per_word_in_currency": {
        "currency": "text",
        "amount": 0
      },
      "same_author_must_do_entire_project": false,
      "auto_launch": false,
      "created_at": {
        "day": 0,
        "month": 0,
        "year": 0,
        "full": "text"
      },
      "updated_at": {
        "day": 0,
        "month": 0,
        "year": 0,
        "full": "text"
      }
    }
  ]
}

Code samples

curl -G "https://api.textmaster.com/v1/clients/api_templates" \
  -H "Authorization: Bearer d90944ea5d7cd52b350b879cfc390f62cb24661eff398141ce6ab040dc5aee4e"

Filter project templates

OAuth: This endpoint requires one of the following scopes: project:manage, project:write or project:read.

Filter API Templates

GEThttps://api.textmaster.com/v1/clients/api_templates/filter

Authorization

oauth2

Query parameters

Response

200401403

Lists API Templates

Body

application/json

total_pagesinteger

countinteger

pageinteger

per_pageinteger

previous_pagenullable integer

next_pagenullable integer

api_templatesarray of ApiTemplate (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.textmaster.com/v1/clients/api_templates/filter', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "total_pages": 0,
  "count": 0,
  "page": 0,
  "per_page": 0,
  "previous_page": 0,
  "next_page": 0,
  "api_templates": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "level_name": "enterprise",
      "activity_name": "translation",
      "language_from": "text",
      "language_to": "text",
      "project_briefing": "text",
      "options": {
        "language_level": "enterprise"
      },
      "textmasters": [
        "text"
      ],
      "cost_per_word": {
        "currency": "text",
        "amount": 0
      },
      "cost_per_word_in_currency": {
        "currency": "text",
        "amount": 0
      },
      "same_author_must_do_entire_project": false,
      "auto_launch": false,
      "created_at": {
        "day": 0,
        "month": 0,
        "year": 0,
        "full": "text"
      },
      "updated_at": {
        "day": 0,
        "month": 0,
        "year": 0,
        "full": "text"
      }
    }
  ]
}

Parameters

You can use the Filter API to filter documents on a collection of criteria.

Name	Type	Description
id	string	The unique identifier of the project template.
name	string	The name of the project template.
activity_name	string	The activity of the project template.
created_at	string	Describes the time the project template was created. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
updated_at	string	Describes the time the project template was last updated. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
language_from_code	string	The source language code of the project template. One of the language code returned by the Language endpoint.
language_to_code	string	The target language code of the project template. One of the language code returned by the Language endpoint.
level_name	string	The level of the project template. One of the level names returned by the Level endpoint.

Code samples

curl -G "https://api.textmaster.com/v1/clients/api_templates/filter" \
  --data-urlencode 'where={"name":"Lorem","language_from_code":"fr","language_to_code":"en"}' \
  --data-urlencode 'order=level_name' \
  -H "Authorization: Bearer 423773845b670244f0d3025c0be48de100f29482665e98c89e8dd31051938f12"