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

GEThttps://api.textmaster.com/v1/clients/users/me

Authorization

oauth2

Response

200401403

Gets my information

Body

application/json

idstring

identstring

callbackobject

localestring

emailstring

walletobject

contact_informationobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.textmaster.com/v1/clients/users/me', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "ident": "text",
  "callback": {
    "waiting_assignment": {
      "url": "text",
      "format": "text"
    },
    "completed": {
      "url": "text",
      "format": "text"
    }
  },
  "locale": "text",
  "email": "text",
  "wallet": {
    "currency_code": "text",
    "current_money": 0
  },
  "contact_information": {
    "first_name": "text",
    "last_name": "text",
    "company": "text",
    "address": "text",
    "address2": "text",
    "city": "text",
    "zip_code": "text",
    "state_region": "text",
    "country": "text",
    "vat_number": "text",
    "profession": "text",
    "website": "text",
    "mother_tongue": "text"
  }
}

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

PUThttps://api.textmaster.com/v1/clients/users/{user_id}

Authorization

oauth2

Path parameters

user_id*string

Your own User ID

Body

application/json

userobject

Response

200401403

Information Updated

Body

application/json

idstring

identstring

callbackobject

localestring

emailstring

walletobject

contact_informationobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.textmaster.com/v1/clients/users/{user_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "ident": "text",
  "callback": {
    "waiting_assignment": {
      "url": "text",
      "format": "text"
    },
    "completed": {
      "url": "text",
      "format": "text"
    }
  },
  "locale": "text",
  "email": "text",
  "wallet": {
    "currency_code": "text",
    "current_money": 0
  },
  "contact_information": {
    "first_name": "text",
    "last_name": "text",
    "company": "text",
    "address": "text",
    "address2": "text",
    "city": "text",
    "zip_code": "text",
    "state_region": "text",
    "country": "text",
    "vat_number": "text",
    "profession": "text",
    "website": "text",
    "mother_tongue": "text"
  }
}

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"