HomeApp

Work Templates

List work templates

OAuth: This endpoint requires the default public scope.

List Work Templates

GEThttps://api.textmaster.com/v1/clients/work_templates
Authorization
Query parameters
Response

Lists Work Templates

Body
total_pagesinteger
countinteger
pageinteger
per_pageinteger
previous_pagenullable integer
next_pagenullable integer
work_templatesarray of WorkTemplate (object)
Request
const response = await fetch('https://api.textmaster.com/v1/clients/work_templates', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "work_templates": [
    {
      "name": "text",
      "description": "text",
      "image_preview_path": "text",
      "ctype": "public"
    }
  ]
}

Code samples

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

Get a work template

OAuth: This endpoint requires the default public scope.

Retrieve a Work Templates

GEThttps://api.textmaster.com/v1/clients/work_templates/{work_template_name}
Authorization
Path parameters
work_template_name*string

The Work Template name

Response

Gets a Work Templates

Body
name*string
descriptionnullable string
image_preview_pathnullable string
ctype*enum
publicprivate
Request
const response = await fetch('https://api.textmaster.com/v1/clients/work_templates/{work_template_name}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "name": "text",
  "description": "text",
  "image_preview_path": "text",
  "ctype": "public"
}

Code samples

curl -G "https://api.textmaster.com/v1/clients/work_templates/2_paragraphs" \
  -H "Authorization: Bearer 1435f72240cb208fac8cecd8d09a341b8f6260bd66d41c0cd890955e3ec9229c"
PreviousUsers

Last updated