Users

Get my user information

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

Warning: Only OAuth Apps with the user:email scope will be able to access the authenticated user's private email address.

Retrieve my information

get

Required scopes

This endpoint requires the following scopes:

Authorizations

oauth2

OAuth2authorizationCodeRequired

OAuth2 Bearer token authentication

Authorization URL: Token URL: Refresh URL:

Responses

200

Gets my information

application/json

idstringOptional

identstringOptional

localestringOptional

emailstringOptional

401

Unauthorized

application/json

403

Forbidden

application/json

get/v1/clients/users/me

HTTPcURLJavaScriptPython

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

{
  "ident": "C-982C-FM",
  "callback": {
    "waiting_assignment": {
      "url": "http://my.host/waiting_assignment_callback",
      "format": "json"
    },
    "completed": {
      "url": "http://my.host/completed_callback",
      "format": "json"
    }
  },
  "locale": "en",
  "email": "[e-mail]",
  "wallet": {
    "current_money": 0,
    "currency_code": "USD"
  },
  "id": "61698aff8b81926d91c0f72c",
  "contact_information": {
    "first_name": "john",
    "last_name": "doe",
    "company": "company",
    "address": "12, street",
    "address2": null,
    "city": "Plougasnou",
    "zip_code": "29188",
    "state_region": null,
    "country": "FR",
    "vat_number": null,
    "profession": "lost",
    "website": null,
    "mother_tongue": null
  }
}

Code samples

curl -G "https://api.textmaster.com/v1/clients/users/me" \
  -H "Authorization: Bearer c6446be4ac320b1a5dd746a349ac0f750e4867ea7fa474092dfde404c1dfb64b"

Update callbacks for my user

OAuth: This endpoint requires one of the following scopes: user:manage or user:write.

Update my callback information

put

Required scopes

This endpoint requires the following scopes:

Authorizations

oauth2

OAuth2authorizationCodeRequired

OAuth2 Bearer token authentication

Authorization URL: Token URL: Refresh URL:

Path parameters

user_idstringRequired

Your own User ID

Body

application/json

Responses

200

Information Updated

application/json

idstringOptional

identstringOptional

localestringOptional

emailstringOptional

401

Unauthorized

application/json

403

Forbidden

application/json

put/v1/clients/users/{user_id}

HTTPcURLJavaScriptPython

PUT /v1/clients/users/{user_id} HTTP/1.1
Host: api.textmaster.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 118

{
  "user": {
    "callback": {
      "waiting_assignment": {
        "url": "text",
        "format": "text"
      },
      "completed": {
        "url": "text",
        "format": "text"
      }
    }
  }
}

{
  "ident": "C-982C-FM",
  "callback": {
    "waiting_assignment": {
      "url": "http://my.host/waiting_assignment_callback",
      "format": "json"
    },
    "completed": {
      "url": "http://my.host/completed_callback",
      "format": "json"
    }
  },
  "locale": "en",
  "email": "[e-mail]",
  "wallet": {
    "current_money": 0,
    "currency_code": "USD"
  },
  "id": "61698aff8b81926d91c0f72c",
  "contact_information": {
    "first_name": "john",
    "last_name": "doe",
    "company": "company",
    "address": "12, street",
    "address2": null,
    "city": "Plougasnou",
    "zip_code": "29188",
    "state_region": null,
    "country": "FR",
    "vat_number": null,
    "profession": "lost",
    "website": null,
    "mother_tongue": null
  }
}

Code samples

curl "https://api.textmaster.com/v1/clients/users/61698aff8b81926d91c0f72c" \
  -X PUT \
  -d '{
    "user": {
      "callback": {
        "waiting_assignment": {
          "url": "https://example.com/waiting_assignment_callback",
          "format": "json"
        },
        "completed": {
          "url": "https://example.com/completed_callback",
          "format": "json"
        }
      }
    }
  }' \
  -H "Authorization: Bearer ac343d393b0041cb8f73b92010a09a543f55605b7877bff63ae359dcd103ad4a" \
  -H "Content-Type: application/json"