Skip navigation
Kinescope help center

Members and branding

Moderators, avatars, and utility dictionaries.

Dictionaries

Timezones list

GET {{baseHost}}/v1/dictionaries/timezones

Returns the list of IANA timezones accepted by the API (for scheduling, analytics, etc.).

The example below is trimmed. The endpoint returns every timezone it accepts, each with localized names in en and ru.

Responses
{ "data": [  {   "name": "America/Detroit",   "en": "America/Detroit",   "ru": "Америка/Детройт",   "abbr": "EST",   "offset": -18000  },  {   "name": "Africa/Conakry",   "en": "Africa/Conakry",   "ru": "Африка/Конакри",   "abbr": "GMT",   "offset": 0  },  {   "name": "Europe/Athens",   "en": "Europe/Athens",   "ru": "Европа/Афины",   "abbr": "EET",   "offset": 7200  },  {   "name": "Africa/Nairobi",   "en": "Africa/Nairobi",   "ru": "Африка/Найроби",   "abbr": "EAT",   "offset": 10800  },  {   "name": "Asia/Colombo",   "en": "Asia/Colombo",   "ru": "Азия/Коломбо",   "abbr": "+0530",   "offset": 19800  },  {   "name": "Pacific/Majuro",   "en": "Pacific/Majuro",   "ru": "Океания/Маджуро",   "abbr": "+12",   "offset": 43200  } ]}

User/avatar

Show avatar

GET {{baseHost}}/v1/user/avatar/:avatar_id

Returns the raw avatar image bytes.

Avatars

Set avatar

POST {{baseHost}}/v1/avatar

Uploads an avatar image for the current workspace or user. Replaces any existing avatar.

Responses
{  "data": {    "id": "uFVdjPmQr9nPBhVodLVyEF",    "email": "user@example.com",    "full_name": "User updated1",    "auto": false,    "password_digest": "",    "confirmation_token": "hwXCxeK7XiyGdQtifHRFxw",    "reset_password_token": "0000001111111111111111",    "language": "EN",    "system": false,    "confirmed_at": "2020-06-05T10:39:52.30272Z",    "created_at": "2020-06-04T21:08:35.432107Z",    "updated_at": "2020-08-27T12:36:36.580037Z",    "deleted_at": null  }}
{  "error": {    "code": 402402,    "message": "your request parameters didn't validate",    "invalid_params": [      {        "name": "language",        "reason": "oneof",        "message": "EN RU"      }    ]  }}

Delete avatar

DELETE {{baseHost}}/v1/avatar

Removes the avatar image. The default avatar is used afterwards.

Responses
{  "data": {    "id": "uFVdjPmQr9nPBhVodLVyEF",    "email": "user@example.com",    "full_name": "User updated1",    "auto": false,    "password_digest": "",    "confirmation_token": "hwXCxeK7XiyGdQtifHRFxw",    "reset_password_token": "0000001111111111111111",    "language": "EN",    "system": false,    "confirmed_at": "2020-06-05T10:39:52.30272Z",    "created_at": "2020-06-04T21:08:35.432107Z",    "updated_at": "2020-08-27T12:36:36.580037Z",    "deleted_at": null  }}
{  "error": {    "code": 402402,    "message": "your request parameters didn't validate",    "invalid_params": [      {        "name": "language",        "reason": "oneof",        "message": "EN RU"      }    ]  }}

Show avatar

GET {{baseHost}}/v1/workspace/avatar/:avatar_id

Returns the raw avatar image bytes.

Moderators

Get moderators

GET {{baseHost}}/v1/moderators

Returns a list of moderators. Results are paginated and can be filtered via query parameters.

Responses
{  "meta": {    "pagination": {      "page": 1,      "per_page": 10,      "total": 1    },    "order": {      "created_at": "asc"    }  },  "data": [    {      "user_id": "<UUID>",      "workspace_id": "<UUID>",      "username": "doc_test_mod_1776899949",      "email": "user@example.com",      "scope": {}    }  ]}

Add moderator

POST {{baseHost}}/v1/moderators

Creates a new moderator. Returns the newly created object on success.

Request body (json)
{  "username": "user_admin",  "email": "user@example.com",  "password": "password"}
Responses
{  "data": {    "user_id": "<UUID>",    "workspace_id": "<UUID>",    "username": "user_admin",    "email": "user@example.com"  }}
{  "data": {    "user_id": "<UUID>",    "workspace_id": "<UUID>",    "username": "doc_test_mod_1776899949",    "email": "user@example.com",    "scope": {}  }}

Get moderator

GET {{baseHost}}/v1/moderators/:moderator_id

Retrieves the details of a single moderator by its unique ID.

Responses
{  "data": {    "user_id": "<UUID>",    "workspace_id": "<UUID>",    "username": "user_admin",    "email": "user@example.com"  }}
{  "data": {    "user_id": "<UUID>",    "workspace_id": "<UUID>",    "username": "doc_test_mod_1776899949",    "email": "user@example.com",    "scope": {}  }}

Update moderator

PUT {{baseHost}}/v1/moderators/:moderator_id

Updates the specified moderator. Only fields provided in the request body are changed; others are left unchanged.

Request body (json)
{  "username": "user_admin_2",  "email": "user@example.com",  "password": "password"}
Responses
{  "data": {    "user_id": "<UUID>",    "workspace_id": "<UUID>",    "username": "user_admin_2",    "email": "user@example.com"  }}
{  "data": {    "user_id": "<UUID>",    "workspace_id": "<UUID>",    "username": "doc_test_mod_1776899949_upd",    "email": "user@example.com",    "scope": {}  }}

Delete moderator

DELETE {{baseHost}}/v1/moderators/:moderator_id

Permanently deletes the moderator. This action cannot be undone.

Responses
{  "data": {    "success": true  }}
{  "data": {    "success": true  }}