Project Templates

List project templates

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

List API Templates

get

Authorizations

oauth2

OAuth2authorizationCodeRequired

OAuth2 Bearer token authentication

Authorization URL: Token URL: Refresh URL:

Available scopes:

• : Allow read & write access to My Authors
• : Allow read access to My Authors
• : Allow write access to My Authors

Query parameters

pageintegerOptional

Search results are limited to 100 items. Specify page number to read more than the first page.

Responses

200

Lists API Templates

application/json

401

Unauthorized

application/json

get

/v1/clients/api_templates

HTTPcURLJavaScriptPython

GET /v1/clients/api_templates HTTP/1.1
Host: api.textmaster.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "api_templates": [
    {
      "id": "e1e452a3-9bcd-408e-810e-91d63175ebc1",
      "name": "Foo Bar 2021-10-15 16:05:13 +0200",
      "description": "[TM] Enterprise Translation (en-us > fr-fr)",
      "level_name": "enterprise",
      "activity_name": "translation",
      "language_from": "en-us",
      "language_to": "fr-fr",
      "project_briefing": "Bacon ipsum dolor amet ribeye tenderloin pancetta ground round cow turducken shankle beef ribs.",
      "options": {
        "language_level": "enterprise"
      },
      "textmasters": [],
      "cost_per_word": {
        "currency": "credits",
        "amount": 10
      },
      "cost_per_word_in_currency": {
        "currency": "USD",
        "amount": 0.014
      },
      "same_author_must_do_entire_project": true,
      "auto_launch": true,
      "created_at": {
        "day": 15,
        "month": 10,
        "year": 2021,
        "full": "2021-10-15 14:05:14 UTC"
      },
      "updated_at": {
        "day": 15,
        "month": 10,
        "year": 2021,
        "full": "2021-10-15 14:05:14 UTC"
      }
    }
  ],
  "total_pages": 1,
  "count": 1,
  "page": 1,
  "per_page": 20,
  "previous_page": null,
  "next_page": null
}

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

get

Authorizations

oauth2

OAuth2authorizationCodeRequired

OAuth2 Bearer token authentication

Authorization URL: Token URL: Refresh URL:

Available scopes:

• : Allow read & write access to My Authors
• : Allow read access to My Authors
• : Allow write access to My Authors

Query parameters

wherestringOptional

URL encoded JSON selector composed of one or several criteria.

orderstringOptional

Comma separated order list

pageintegerOptional

Search results are limited to 100 items. Specify page number to read more than the first page.

Responses

200

Lists API Templates

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/v1/clients/api_templates/filter

HTTPcURLJavaScriptPython

GET /v1/clients/api_templates/filter HTTP/1.1
Host: api.textmaster.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "api_templates": [
    {
      "id": "e1e452a3-9bcd-408e-810e-91d63175ebc1",
      "name": "Foo Bar 2021-10-15 16:05:13 +0200",
      "description": "[TM] Enterprise Translation (en-us > fr-fr)",
      "level_name": "enterprise",
      "activity_name": "translation",
      "language_from": "en-us",
      "language_to": "fr-fr",
      "project_briefing": "Bacon ipsum dolor amet ribeye tenderloin pancetta ground round cow turducken shankle beef ribs.",
      "options": {
        "language_level": "enterprise"
      },
      "textmasters": [],
      "cost_per_word": {
        "currency": "credits",
        "amount": 10
      },
      "cost_per_word_in_currency": {
        "currency": "USD",
        "amount": 0.014
      },
      "same_author_must_do_entire_project": true,
      "auto_launch": true,
      "created_at": {
        "day": 15,
        "month": 10,
        "year": 2021,
        "full": "2021-10-15 14:05:14 UTC"
      },
      "updated_at": {
        "day": 15,
        "month": 10,
        "year": 2021,
        "full": "2021-10-15 14:05:14 UTC"
      }
    }
  ],
  "total_pages": 1,
  "count": 1,
  "page": 1,
  "per_page": 20,
  "previous_page": null,
  "next_page": null
}

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"