TextMaster's Developer Documentation
HomeApp
  • Welcome!
  • Quick Start
    • Postman
    • OpenAPI
  • Overview
    • Resources in the REST API
    • Authentication
    • Troubleshooting
    • Filters
    • Workflow
    • File uploads
    • Loop
  • Guides
    • Integrator best practices
  • Apps
    • About OAuth Apps
    • Building OAuth Apps
      • Creating an OAuth App
      • Authorizing OAuth Apps
      • Scopes for OAuth Apps
    • Managing OAuth Apps
      • Modifying an OAuth App
      • Deleting an OAuth App
  • Webhooks & Events
    • Webhooks
      • Creating webhooks
      • Configuring your server for webhooks
      • Securing webhooks
      • Troubleshooting webhooks
    • Events
  • Integrations
    • Akeneo
      • Getting Started
      • Configuration
      • Usage
      • Monitoring
      • Troubleshooting
    • Salesforce Commerce Cloud
      • Getting Started
      • Configuration
      • Usage
      • Monitoring
      • Troubleshooting
  • Reference
    • Abilities
    • Authors
    • Documents
    • Categories
    • Countries
    • Expertises
    • Glossaries
    • Languages
    • Levels
    • Locales
    • Preferred Authors
    • Projects
    • Project Templates
    • Negotiated Contracts
    • Support Messages
    • Transactions
    • Uploads
    • Users
    • Work Templates
Powered by GitBook
On this page

Was this helpful?

  1. Reference

Authors

PreviousAbilitiesNextDocuments

Last updated 1 year ago

Was this helpful?

List authors able to work on project

Returns a list of authors who have the skills to work on a project given its attributes without actually creating it.

OAuth: This endpoint requires the default public scope.

Code samples

curl -G "https://api.textmaster.com/v1/clients/authors" \
  --data-urlencode "activity_name=translation" \
  --data-urlencode "options[language_level]=premium" \
  --data-urlencode "options[quality]=yes" \
  --data-urlencode "language_from=fr" \
  --data-urlencode "language_to=en" \
  -H "Authorization: Bearer ad1ad5c7f13b73e215dff82b9bafd55b91c66a01dccf8b16a90c75af633087ca"

List all potential authors for a project

get
Authorizations
Query parameters
project[activity_name]string · enumOptional

Type of project to filter on.

Possible values:

  • translation
  • copywriting
  • proofreading
Possible values:
project[language_from]stringOptional

Source language for translation projects (ex: fr-FR).

Pattern: ^[a-z]{2}-[A-Z]{2}$
project[language_to]stringOptional

Target language (ex: en-US)

Pattern: ^[a-z]{2}-[A-Z]{2}$
project[options][expertise]stringOptional

An Expertise ID (See List Expertises for more info)

project[options][language_level]string · enumOptional

An Expertise ID (See List Expertises for more info)

Possible values:
pageintegerOptional

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

Responses
200
Lists Potential Authors
application/json
401
Unauthorized
application/json
get
GET /v1/clients/authors HTTP/1.1
Host: api.textmaster.com
Accept: */*
{
  "total_pages": 1,
  "count": 2,
  "page": 1,
  "per_page": 20,
  "previous_page": null,
  "next_page": null,
  "authors": [
    {
      "id": "61698a9a8b81926d91c0e28c",
      "ident": "A-988C-FM"
    },
    {
      "id": "61698a9a8b81926d91c0e299",
      "ident": "A-9899-FM"
    }
  ]
}
  • List authors able to work on project
  • GETList all potential authors for a project