Managing your team with MyTeam API

MyTeam API allows you to manage your Smartcat team via API: searching, adding, and removing members and assigning team members to work on documents.

Adding a new team member via API

You can add a new member to your Smartcat team via API using the POST account/myteam method.

See our account/myteam example

Request URL: 
https://smartcat.ai/api/integration/v1/account/myteam

Headers:
Content-Type: application/json

Body:
{
"firstName": "John",
"lastName": "Doe",
"externalID": "1150",
"email": "johndoe@mailforspam.com",
"services": [{
     "serviceType": "translation",
     "specializations": ["education", "marketing"],
     "sourceLanguage": "ru",
     "targetLanguage": "fr",
     "unitsType": "word",
     "pricePerUnit": "0.07",
     "currency": "USD"
     }]
}

You team member should have an email, first and last names, and at least one service.

The service model should contain a language pair (or just a language depending on the service type), rate and currency. Smartcat will map rate units to the service types automatically.

You can also add a specialization for each service if needed. The list of the currently available specializations can be retrieved with the GET directory method using the specialization parameter.

See our directory example

Request URL: 
https://smartcat.ai/api/integration/v1/directory?type=language

Headers:
Authorization: Basic dGVzdGFwaToxMjM0NTY=

PS: 
There are many possible values for the "type" parameter such as vendor, domain, group, and so on. Check all the options here.

If you want to map the team member with a user in your own system, you can use the externalId parameter, it will be stored in the team member model. Please note, the externalId parameter should be unique in your account.

There are some restrictions:

  • The first and the last name cannot contain more than 99 characters.
  • You cannot add different rates for the different dialects of the same service. For example, $0.06 for English→French (France) translation and $0.08 for English→French (Canada) translation are not possible for the same person.

As for the rest, everything is possible.

Searching your team via API

If you want to get the information about more than one team member, use the POST account/searchmyteam method.

See our account/searchmyteam examples

Request URL: 
https://smartcat.ai/api/integration/v1/account/searchmyteam

Headers:
Authorization: Basic ZG0wMTpRd2VydHkxMjM=
Content-Type: application/json

Body to get the first 500 profiles:
{
"skip": 0,
"limit": 500
}

Body to get the profiles in order from 501 to 1000:
{
"skip": 500,
"limit": 500
}

Body with all parameters:
{
"skip": 0,
"limit": 500,
"serviceType": "translation",
"sourceLanguage": "en",
"targetLanguage": "af",
"onlyNativeSpeakers": false,
"allDialects": true,
"minRate": 0,
"maxRate": 7,
"rateRangeCurrency": "USD",
"specializations": [
"IT"
],
"specializationKnowledgeLevel": [
"tested"
],
"searchString": "batman",
"daytime": false,
}

You can filter your team by service types, language pairs, rates, specializations, daytime. You can also get team members who are native speakers in target language or those who passed the tests.

If you don’t specify any search filter you will get the whole list of your team members. It might be useful if you want to synchronize your list of the team members with your external system (TMS, ERP, etc.).

The maximum number of the team member models you can get at once is 500. 500 is the maximum value of the limit parameter. If you have a larger team, please use the skip parameter. For example, if your team consists of 600 members you can get the first 500 profiles in the first request and the rest in the second request: for that you need to set the skip parameter to 500, so the first 500 members will be skipped and you get the member profiles from 501 to 600.

Removing a team member via API

To remove a member from the team, use the DELETE account/myteam/{userid} method and send the Smartcat ID as a userId parameter value.

Please note, the user will be removed only from your team. The personal account of the specific user will be kept. If a user is a member of other teams, he/she will save this membership.

See our account/myteam/{userId} example

Request URL: 
https://smartcat.ai/api/integration/v1/account/myteam/6a097370-75a3-4bcc-b37b-2c3fd339b2dd

Headers:
Authorization: Basic dGVzdGFwaToxMjM0NTY=

Assigning your team to a document via API

To get an urgent job started in less time, try the POST document/assignFromMyTeam method.

Say, you need to translate a travel guide written in English into French ASAP. Call the method specifying the document ID, which contains information about the project and its language pair, the stage number and, if needed, one or multiple subjects.

See our document/assignFromMyTeam example

Request URL: 
https://smartcat.ai/api/integration/v1/document/assignFromMyTeam

Headers:
Authorization: Basic ZG0wMTpRd2VydHkxMjM=
Content-Type: application/json

Body:
{
  "documentIds": [
     "documentId_12"
  ],
  "stageNumber": 1,
  "specializations": [
     "tourismandtravel",
     "recreation"
  ]
}

This will send invitations specifically to the team members who provide English-to-French translation services and specialize in Tourism and travel OR Recreation. The first linguist who accepts the invitation will be automatically assigned to the job.

Like it?

1

Similar articles:

    No related articles