NAV Navbar
Mellow

Обзор

API Mellow предназначен для интеграции Mellow в ваш проект. Эта документация API предоставляет разработчикам подробное описание всех доступных запросов.

Общая информация

API Mellow включает методы для работы с задачами и фрилансерами. После регистрации в качестве администратора вашей компании, вы можете приглашать и создавать фрилансеров, управлять задачами и инициировать выплаты на платежные методы фрилансеров.

Быстрый старт представляет наиболее популярный случай использования API.

API основан на наборе HTTP-методов, которые используются для отправки запросов и получения ответов по каждой операции. Все ответы возвращаются в формате JSON. Вы можете использовать любые инструменты и языки для работы с API. В этом руководстве мы используем PHP для демонстрации работы API.

Для удобства разработчиков Mellow предоставляет песочницу для тестирования перед внедрением в производство. Чтобы воспользоваться песочницей, свяжитесь с отделом продаж Mellow.

Базовый URL

Текущая версия API - v2. Все URL-адреса точек доступа API в этой документации включают следующий базовый URL: https://my.mellow.io/api

В заголовке каждого запроса вы должны передать Accept: application/json.

Аутентификация и авторизация

Аутентификация выполняется с использованием JSON Web Tokens. После получения JWT, вам необходимо передать его в заголовке запроса: Authorization: Bearer TOKEN_HERE.

Если у вас несколько компаний, вы можете передать параметр x-company-id в заголовке запроса. В этом случае вы можете одновременно делать запросы для всех компаний без обновления токена, просто передавая ID компании в каждом запросе.

Процесс аутентификации выглядит следующим образом:

Аутентификация

Запрос JWT

Пример запроса

curl --location \
    --request POST 'https://my.mellow.io/api/login' \
    --data-raw '{
        "username": "Ivan",
        "password": "123123",
        "code": 0
    }'

Пример ответа Если параметр code был передан корректно или у пользователя не включена двухфакторная аутентификация:

HTTP статус 200 OK

{
  "token": "eyJhbGciOiJIUzUxMiIsI...",
  "refreshToken": "c84f18a2-c6c7-4850-be15-93f9cbaef3b3"
}

Если параметр code не был передан и у пользователя включена двухфакторная аутентификация:

HTTP статус 200 OK

{
    "2FA": {
        "type": "SMS" | "Google",
        "number": "+8279823472"
    }
}

Этот запрос позволяет получить JWT, который используется для аутентификации всех других запросов.

Запрос

HTTP Запрос

https://my.mellow.io/api/login

Параметры
Имя параметра Тип Обязательный Описание
username string Да Имя пользователя
password string Да Пароль
code string Нет Код двухфакторной аутентификации. В зависимости от настроек учетной записи пользователя:
  • Если 2FA включена, этот параметр необходим для получения токена. Если не передан, будет отправлено SMS. После получения кода необходимо повторно вызвать этот запрос.
  • Если 2FA не включена, этот параметр не требуется.

Ответ

Имя свойства Тип Описание
token string JWT токен
refreshToken string JWT токен, используемый для обновления токена, действителен в течение 65 дней

Обновление JWT

Пример запроса

curl --location \
    --request POST 'https://my.mellow.io/api/token/refresh' \
    --data-raw '{
        "refreshToken": "c84f18a2-c6c7-4850-be15-93f9cbaef3b3"
    }'

Пример ответа

HTTP status 200 OK

{
  "token": "eyJhbGciOiJIUzUxMiIsI...",
  "refreshToken": "c84f18a2-c6c7-4850-be15-93f9cbaef3b3"
}

Этот запрос позволяет получить обновленный JWT, который используется для аутентификации всех других запросов.

Запрос

HTTP запрос

https://my.mellow.io/api/token/refresh

Параметры
Имя параметра Тип Обязательный Описание
refreshToken string Да JWT токен

Ответ

Имя свойства Тип Описание
token string JWT токен
refreshToken string JWT токен, используемый для обновления токена, действителен в течение 65 дней

Ответ API

Все ответы от API форматируются как JSON.

Коды ошибок и их описания

Ниже приведены все возможные коды состояния ответа.

HTTP Код Тип Описание
200 Успех Запрос выполнен успешно
401 Ошибка: Неавторизован Неверные данные аутентификации
403 Запрещено Доступ запрещен, ошибка авторизации
422 Ошибка валидации Запрос не может быть обработан из-за ошибки валидации. Детали ошибки указаны в теле ответа как {fieldName: errorText}
409 Ошибка при выполнении запроса Ошибка во время выполнения запроса. Детали указаны в теле ответа как {"error description"}

Быстрый старт

Руководство для быстрого старта служит введением в Mellow API и содержит инструкции по наиболее частым действиям в системе:

Быстрый старт

Прежде чем начать

Аутентификация

Аутентификация выполняется с использованием JSON Web Tokens (JWT). После получения JWT, его необходимо передать в заголовке запроса: Authorization: Bearer TOKEN_HERE.

Чтобы получить JWT, вам нужно отправить запрос JWT, где вы передаете имя пользователя, пароль и, при необходимости, код 2FA.

Метод и URI запроса: POST https://my.mellow.io/api/login

Примечание: Для тестовой среды используйте:
POST https://demo.mellow.io/api/login

Полученный JWT имеет срок действия 65 дней. По истечении этого периода вам будет необходимо сгенерировать новый токен, повторив процесс аутентификации. Токен должен передаваться в заголовке всех последующих запросов.

Чтобы узнать больше, смотрите Аутентификация и авторизация.

Примеры использования API

Основные сценарии использования API зависят от способа взаимодействия с фрилансерами:

Если ваши фрилансеры собираются зарегистрироваться и использовать Mellow, рекомендуемые шаги следующие:

Use_case_1

  1. Найти или пригласить фрилансера. Фрилансер получит пригласительное письмо со ссылкой для регистрации. Чтобы проверить статус регистрации, выполните запрос поиска фрилансера с фильтром по электронной почте: пользователи, которые завершили и подтвердили свою регистрацию, будут иметь параметр isRegistered как "true". Далее фрилансеру необходимо пройти верификацию.
  2. Создать новое задание.
  3. Фрилансер подтверждает и выполняет задание.
  4. Принять задание.
  5. Оплатить задание. Сумма платежа списывается с баланса клиента и зачисляется на баланс фрилансера.

Если ваши фрилансеры не собираются использовать Mellow самостоятельно (менять статусы заданий, добавлять способы оплаты или выводить оплату за задание), то рекомендуемые шаги следующие:

Use_case_1

  1. Найти или пригласить фрилансера.
  2. Создать новое задание.
  3. Изменить статусы задания по порядку: "Принято фрилансером", "Выполнено".
  4. Принять задание.
  5. Оплатить задание.
  6. Получить способ оплаты фрилансера или добавить новый. Только фрилансер может добавить новый способ оплаты. Чтобы добавить способ оплаты, необходимо отправить код подтверждения фрилансеру, а затем сгенерировать ссылку на экран, где фрилансер сможет ввести платежные данные.
  7. Создать выплату на способ оплаты фрилансера за оплаченное задание.

Приглашение фрилансеров

Чтобы добавить фрилансера в вашу команду, используйте запрос пригласить фрилансера.

Метод и URI запроса: POST https://my.mellow.io/api/customer/freelancers

Успешный запрос возвращает пустой ответ с кодом 200.

Создание задач

Чтобы создать задачу, используйте этот запрос, передав все необходимые параметры задачи: категорию, атрибуты, имя, описание и цену.

Метод и URI запроса: POST https://my.mellow.io/api/tasks

Успешный запрос возвращает пустой ответ с кодом 200.

Изменение статусов задачи

Этапы выполнения задачи следующие:

При использовании API необходимо выполнять эти этапы последовательно. Оплата задачи производится через отдельный запрос (оплата производится только на баланс фрилансера). Все другие переходы статусов обрабатываются с помощью запроса на изменение статуса задачи. Другими словами, при отправке запроса необходимо соблюдать последовательность со следующими статусами:

Метод и URI запроса: PUT https://my.mellow.io/api/customer/tasks/{taskId||uuid}

Успешный запрос возвращает пустой ответ с кодом 200.

Оплата задачи

Чтобы оплатить задачу, вам нужно указать только ID задачи в этом запросе.

Метод и URI запроса: POST https://my.mellow.io/api/customer/tasks/pay

Успешный запрос возвращает пустой ответ с кодом 200.

Задачи

API включает в себя ряд запросов для управления задачами.

Статусы задач

Это статусы задач, доступные в Mellow (на диаграмме представлены только основные, см. полный список статусов в таблице ниже):

Статусы задач

Статус ID Описание Инициировано
Draft ID=17 Задача создана как черновик Клиент
Unconfirmed ID=1 Задача создана Клиент
In progress ID=2 Фрилансер принял задачу для выполнения Фрилансер
Pending review ID=3 Фрилансер завершил задачу, ожидается проверка клиентом Фрилансер
Pending payment ID=4 Задача принята клиентом и ожидает оплаты Клиент
Completed ID=5 Задача оплачена Клиент
Rejected by freelancer ID=6 Фрилансер отклонил задачу Фрилансер
Rejected by customer ID=8 Клиент отклонил выполненную фрилансером задачу Клиент
Awaiting freelancer’s confirmation of cancellation ID=11 Клиент отклонил задачу, ожидается подтверждение отмены от фрилансера Клиент
Queued for payment ID=12 Клиент инициировал оплату, но платеж еще обрабатывается. После обработки статус задачи автоматически изменится на Завершено (ID=5). Если задача слишком долго находится в этом статусе, пожалуйста, свяжитесь со службой поддержки Клиент
Dispute initiated ID=13 Фрилансер инициировал спор и ожидает ответа от клиента Фрилансер
Customer review required ID=14 Если фрилансер не завершил задачу к сроку, клиент должен выбрать, продлить ли срок или отменить задачу Автоматически по достижении срока
Changes under review ID=16 Клиент предложил изменения в параметрах задачи и ожидает ответа фрилансера Клиент

Управление задачами

Этот раздел включает запросы на получение, создание задач и изменение статуса задач.

Получение списка задач

Пример запроса

curl -X GET "https://my.mellow.io/api/customer/tasks?filter[creatorId]=123" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."

Пример ответа

HTTP status code: 200 OK

{
  "items": [
    {
      "additionalAttributes": null,
      "category": {
        "id": 20,
        "title": "Управление размещением медийной рекламы",
        "titleEn": "ATL advertising management",
        "titleDoc": "Услуги по управлению размещением рекламных материалов  на интернет сайтах",
        "titleDocEn": "Services on managing  advertising materials' placement at websites"
      },
      "parentCategory": {
        "id": 2,
        "title": "Интернет-реклама",
        "titleEn": "Internet advertising"
      },
      "commissionAmount": 7.29,
      "commissionPercent": 9,
      "copyright": false,
      "createType": "API",
      "currency": {
        "currency": "EUR",
        "id": 3
      },
      "customer": {
        "id": 2955,
        "title": "Olimp LLC"
      },
      "creator": {
        "id": 100740,
        "fullName": "Ivan Petrov"
      },
      "worker": {
        "id": 100871,
        "email": "[email protected]",
        "firstName": "Nina",
        "lastName": "Malina",
        "isVerified": true
      },
      "dateCreated": "2021-08-06 11:17:13",
      "dateAccepted": null,
      "dateEnd": "2021-08-07 14:17:13",
      "dateFinished": null,
      "datePaid": "2021-08-06 14:17:13",
      "datePayAt": null,
      "documentDate": "2021-08-06 14:17:13",
      "description": "Task related to social media analysis",
      "uuid": "123e4567-e89b-12d3-a456-426655440000",
      "files": [
        {
          "id": 252479,
          "name": "analysis_report.pdf",
          "typeId": 5,
          "ownerId": 100556
        }
      ],
      "id": 583689,
      "needReport": false,
      "price": 150,
      "state": 5,
      "title": "Freelancer Thailand Project",
      "deadline": {
        "type": 0,
        "triggerDate": null,
        "isComingUp": false
      },
      "hold": {
        "type": "without_hold",
        "isActive": false
      },
      "group": {
        "id": 654,
        "title": "Market Analysis Group"
      },
      "messageCount": 0,
      "activeDispute": null,
      "activeChangesetId": null
    }
  ]
  "pagination": {
    "count": 20,
    "total": 102,
    "perPage": 20,
    "page": </

Запрос

HTTP запрос
Параметры
Параметр Тип Обязательный Описание
filter[creatorId] integer Нет ID пользователя, создавшего задачу
filter[workerId] integer Нет ID исполнителя. Для получения списка фрилансеров используйте этот запрос
filter[companyId] integer Нет ID компании. Для списка компаний смотрите этот запрос
filter[dateCreatedFrom] string Нет Дата создания задачи (начало диапазона). Формат: YYYY-MM-DD (например, 2020-09-03), время по умолчанию 00:00:00
filter[dateCreatedTo] string Нет Дата создания задачи (конец диапазона). Формат: YYYY-MM-DD (например, 2020-09-03), время по умолчанию 23:59:59
filter[dateEndFrom] string Нет Срок выполнения задачи (начало диапазона). Формат: YYYY-MM-DD (например, 2020-09-03), время по умолчанию 00:00:00
filter[dateEndTo] string Нет Срок выполнения задачи (конец диапазона). Формат: YYYY-MM-DD (например, 2020-09-03), время по умолчанию 23:59:59
filter[dateFinishedFrom] string Нет Дата завершения задачи (начало диапазона). Формат: YYYY-MM-DD (например, 2020-09-03), время по умолчанию 00:00:00
filter[dateFinishedTo] string Нет Дата завершения задачи (конец диапазона). Формат: YYYY-MM-DD (например, 2020-09-03), время по умолчанию 23:59:59
filter[dateReportFrom] string Нет Дата создания отчета (начало диапазона). Формат: YYYY-MM-DD (например, 2020-09-03), время по умолчанию 00:00:00
filter[dateReportTo] string Нет Дата создания отчета (конец диапазона). Формат: YYYY-MM-DD (например, 2020-09-03), время по умолчанию 23:59:59
filter[dateAcceptedFrom] string Нет Дата принятия задачи клиентом (начало диапазона). Формат: YYYY-MM-DD (например, 2020-09-03), время по умолчанию 00:00:00
filter[dateAcceptedTo] string Нет Дата принятия задачи клиентом (конец диапазона). Формат: YYYY-MM-DD (например, 2020-09-03), время по умолчанию 23:59:59
filter[datePaidFrom] string Нет Дата оплаты задачи (начало диапазона). Формат: YYYY-MM-DD (например, 2020-09-03), время по умолчанию 00:00:00
filter[datePaidTo] string Нет Дата оплаты задачи (конец диапазона). Формат: YYYY-MM-DD (например, 2020-09-03), время по умолчанию 23:59:59
filter[hasPayout] boolean Нет Показатель для возврата только оплаченных задач. Значение 0 возвращает задачи без выплат (см. здесь для запросов на выплату).
filter[priceFrom] integer Нет Цена задачи (начало интервала)
filter[priceTo] integer Нет Цена задачи (конец интервала)
filter[search] string Нет Название или описание задачи. Поиск текста в заголовке или описании задачи.
filter[state] array of integers Нет Статус задачи. Можно передать одно или несколько значений (например, state[]=2&state[]=3)
filter[currencyId] integer Нет ID валюты. Возможные значения:
  • 1: RUB
  • 2: USD
  • 3: EUR
filter[groupId] integer Нет ID группы задач
filter[deadlineType] integer Нет ID типа срока. Возможные значения:
  • 1: Мягкий срок
  • 2: Жесткий срок
filter[workerTaxationStatus] integer Нет Налоговый статус фрилансера. Возможные значения:
  • 1: Физическое лицо
  • 3: Самозанятый
  • 4: Индивидуальный предприниматель
filter[hasCopyright] boolean Нет Указывает на необходимость передачи прав интеллектуальной собственности
filter[hasReport] boolean Нет Указывает, что при завершении задачи требуется отчет
filter[payedBy] integer Нет ID пользователя, оплатившего задачу
filter[externalId] string Нет Внешний ID задачи, который можно установить при создании задачи (merchant_txid)
sort string Нет Атрибут для сортировки. Возможные значения:
  • date_end: Срок выполнения задачи
  • date_finished: Дата завершения задачи
  • price: Цена задачи
direction string Нет Порядок сортировки. Возможные значения:
  • asc: По возрастанию
  • desc: По убыванию
page integer Нет Номер страницы для пагинации
size integer Нет Количество элементов на странице (по умолчанию 20, максимум 500)
Ответ

Успешный запрос возвращает следующий ответ:

Свойство Тип Описание
items list Список элементов
id integer ID задачи
additionalAttributes object Дополнительные атрибуты задачи
category object Категория задачи
category.id integer ID категории
category.title string Название категории
category.titleEn string Название категории на английском
category.titleDoc string Название категории для бухгалтерских документов
category.titleDocEn string Название категории для бухгалтерских документов (на английском)
parentCategory object Родительская категория задачи
category.id string ID категории задачи
category.title string Название категории задачи
category.title_en string Название категории задачи на английском
commissionAmount float Сумма комиссии
commissionPercent float Процент комиссии
copyright string Индикатор передачи прав интеллектуальной собственности
createType string Метод создания задачи (через API или интерфейс)
currency object Валюта задачи
currency.currency string Название валюты задачи
currency.id integer ID валюты задачи
workerCurrency object Валюта, в которой фрилансер получит средства
workerCurrency.currency string Название валюты
workerCurrency.id integer ID валюты
customer object Клиент
customer.id string ID компании
customer.title string Название компании
creator object Создатель задачи
creator.id integer ID пользователя-создателя
creator.fullName string Полное имя создателя</

Получение задач по их идентификаторам

Пример запроса

curl -X GET "https://my.mellow.io/api/customer/tasks/c6e8e285-1e0a-4a11-a676-89211c0adccc" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."

Пример ответа

HTTP status code: 200 OK

{
  "attributes": [
    {
      "attribute": {
        "title": "URL-адрес ",
        "titleEn": "URL-address",
        "type": "1"
      },
      "attributeType": {
        "title": "Адрес сайта",
        "titleEn": "URL adress ",
        "type": "text"
      },
      "values": [
        {
          "title": "http://some.domain.com"
        }
      ]
    }
  ],
  "messages": [],
  "creator": {
    "id": 100740,
    "fullName": "Andrey Smirnov"
  },
  "worker": {
    "id": 100871,
    "email": "[email protected]",
    "firstName": "Nina",
    "lastName": "Malina",
    "isVerified": true
  },
  "files": [],
  "links": [],
  "messageCount": 0,
  "additionalAttributes": null,
  "category": {
    "id": 20,
    "title": "Управление размещением медийной рекламы",
    "titleEn": "ATL advertising management",
    "titleDoc": "Услуги по управлению размещением рекламных материалов  на интернет сайтах",
    "titleDocEn": "Services on managing  advertising materials' placement at websites"
  },
  "parentCategory": {
    "id": 2,
    "title": "Интернет-реклама",
    "titleEn": "Internet advertising"
  },
  "commissionAmount": 7.29,
  "commissionPercent": 9,
  "copyright": false,
  "createType": "API",
  "currency": {
    "currency": "EUR",
    "id": 3
  },
  "customer": {
    "id": 3021,
    "title": "OOO Tekhnoprom"
  },
  "dateCreated": "2021-09-15 09:45:00",
  "dateAccepted": "2021-09-15 12:00:00",
  "dateEnd": "2021-09-20 18:00:00",
  "dateFinished": null,
  "datePaid": "2021-09-20 18:30:00",
  "datePayAt": null,
  "documentDate": "2021-09-20 18:00:00",
  "description": "Website development task",
  "uuid": "987e1234-a89b-56d3-b123-427677440000",
  "id": 584123,
  "needReport": true,
  "price": 250,
  "state": 3,
  "title": "WebDev Singapore Project",
  "deadline": {
    "type": 0,
    "triggerDate": null,
    "isComingUp": false
  },
  "hold": {
    "type": "without_hold",
    "isActive": false
  },
  "activeDispute": <

Запрос

HTTP запрос
Параметры пути

В качестве параметра пути необходимо передать либо taskId, либо taskUuid, которые можно получить в указанном запросе.

Ответ

Успешный запрос возвращает следующий ответ:

Свойство Тип Описание
id integer ID задачи
additionalAttributes object Дополнительные атрибуты задачи
category object Категория задачи
category.id integer ID категории
category.title string Название категории
category.titleEn string Название категории на английском
category.titleDoc string Название категории для бухгалтерских документов
category.titleDocEn string Название категории для бухгалтерских документов (на английском)
parentCategory object Родительская категория задачи
category.id string ID категории задачи
category.title string Название категории задачи
category.title_en string Название категории задачи на английском
commissionAmount float Сумма комиссии
commissionPercent float Процент комиссии
copyright string Это свойство касается передачи прав интеллектуальной собственности
createType string Указывает, как была создана задача (через API или интерфейс)
currency object Валюта задачи
currency.currency string Название валюты задачи
currency.id integer ID валюты задачи
workerCurrency object Валюта, в которой фрилансер получит средства
workerCurrency.currency string Название валюты
workerCurrency.id integer ID валюты
customer object Клиент
customer.id string ID компании
customer.title string Название компании
creator object Пользователь, создавший задачу
creator.id integer ID пользователя, создавшего задачу
creator.fullName string Полное имя пользователя, создавшего задачу
worker object Фрилансер
worker.id integer ID фрилансера (возвращается в запросе получения списка фрилансеров)
worker.email string Email фрилансера
worker.firstName string Имя фрилансера
worker.lastName string Фамилия фрилансера
worker.isVerified boolean Указывает, верифицирован ли фрилансер
dateCreated string Дата создания задачи
dateAccepted string Дата принятия задачи клиентом
dateEnd string Дата окончания срока выполнения задачи
dateFinished string Дата завершения выполнения задачи фрилансером
datePaid string Дата поступления оплаты за задачу
datePayAt string Дата инициации оплаты за задачу
documentDate string Дата создания бухгалтерских документов
needReport boolean Указывает, требуется ли отчет по задаче
description string Описание задачи
uuid uuid UUID задачи
price float Цена задачи
state integer Статус задачи
title string Название задачи
files object Файлы, прикрепленные к задаче
files.id string ID файла
files.name string Имя файла
files.typeId string Тип файла
files.ownerId string ID пользователя, добавившего файл (файлы могут добавлять как клиенты, так и фрилансеры)
deadline object Срок выполнения
deadline.type integer Тип срока выполнения (1 для мягкого, 2 для жесткого)
deadline.triggerDate string Дата срока выполнения
deadline.isComingUp boolean Указывает, что срок выполнения наступает менее чем через 3 дня
hold object Удержание средств (эскроу)
hold.type string Тип удержания (эскроу)
hold.isActive boolean Указывает, активно ли удержание (эскроу) для задачи
hasPayout boolean Указывает, произошла ли выплата или нет
messageCount integer Количество сообщений
activeDispute boolean Указывает, есть ли открытый спор
activeChangesetId integer Указывает, идет ли согласование изменений по задаче
serviceFeeCompensation integer Сумма компенсации комиссии фрилансера
shareCommission boolean Указывает, компенсирует ли клиент комиссионные сборы фрилансера
serviceFeeCompensationPercent integer Процент от стоимости задачи для компенсации комиссии фрилансера

Создание задачи

Пример запроса

curl -X POST "https://my.mellow.io/api/customer/tasks" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -d '{
        "uuid": "9b1c5a73-2f9e-4c18-9bc6-8390a12d6fb8",
        "categoryId": 42,
        "attributes": [
          {
            "id": 42,
            "value": "5"
          }
        ],
        "acceptanceFileIds": [
          102, 105
        ],
        "copyright": true,
        "needReport": false,
        "title": "Market Analysis Report",
        "description": "Detailed report on market trends and projections for Q3 2022",
        "externalId": "MAR-20220622",
        "fileIds": [
          102, 103, 104
        ],
        "workerId": 15,
        "editGroup": [
          105, 107
        ],
        "deadline": "2022-07-15T17:00:00.000Z",
        "price": 1500,
        "validateOnly": true,
        "shareCommission": true,
        "advData": {
          "endContracts": [
            {
              "uuid": "ab2c9d18-f712-4f8a-91d7-5fa3a7bc7b8e",
              "sum": 300
            },
            {
              "uuid": "dfe546b8-3a9d-4e4c-b49c-7ad2c99f1b2e",
              "sum": 450
            },
            {
              "uuid": "c123f0b5-568d-4b3f-91d4-2b2e7d71f8ae",
              "sum": 500
            }
          ]
        }
      }
'

Пример ответа

HTTP status code: 200 OK

Метод используется для создания новых задач.

Теперь конечная точка поддерживает параметр workerCurrency, позволяющий указать валюту (USD, EUR, RUB), в которой фрилансер получит оплату. Если выбранная валюта отличается от валюты баланса вашего счета, система автоматически конвертирует сумму задачи по курсу сервиса на момент создания задачи. Если средств недостаточно, задача будет создана в статусе черновика.

Запрос

HTTP Запрос
Тело запроса
Параметр Тип Обязательно Описание
uuid string Нет UUID задачи (если не указан, параметр определяется автоматически)
categoryId integer Да ID категории услуги/работы задачи. Чтобы получить список всех доступных услуг и работ, используйте этот запрос
attributes object Да Атрибуты задачи. Требуется как минимум 3 атрибута. Чтобы получить список всех доступных атрибутов задач, используйте этот запрос
attributes.id integer Да ID атрибута
attributes.value string Да Значение атрибута задачи. Для атрибутов типа "выбор" необходимо указать текстовое значение
acceptanceFileIds array Нет Файлы, которые фрилансер должен подписать для принятия задачи
copyright boolean Нет Указывает на необходимость передачи прав интеллектуальной собственности
needReport boolean Нет Указывает на необходимость прикрепления отчёта к выполненной задаче
title string Да Название задачи
description string Да Описание задачи
fileIds string Нет Файлы, которые нужно прикрепить к задаче
workerId integer Да ID фрилансера. Чтобы получить список фрилансеров, используйте этот запрос
editGroup array Нет Группа задач. Чтобы получить список доступных групп, используйте этот запрос
externalId string Нет ID, который можно установить при создании задачи (merchant_txid)
deadline date Да Срок выполнения задачи (например, 2022-05-19 11:53:03)
price float Да Цена задачи
workerCurrency string Нет Валюта, в которой фрилансер получит средства. Поддерживаемые значения можно получить, используя Получить разрешённые валюты для мультивалютных задач. Если отличается от валюты баланса заказчика, сумма будет автоматически конвертирована по текущему курсу сервиса. Если средств недостаточно, задача будет создана в статусе черновика. Позже вы можете опубликовать черновик, используя запрос Публикация черновика задачи.
validateOnly boolean Нет Определяет, должен ли API только проверить предоставленные параметры задачи, вместо того чтобы создавать задачу. Если true, система проверяет все бизнес-правила, необходимые для создания задачи (такие как значения атрибутов, действительность ID услуги, достаточность баланса) и возвращает найденные ошибки валидации, а также рассчитанную стоимость в случае мультивалютности. Сама задача не создаётся. Это не проверяет действия со стороны фрилансера, такие как подписание предложения или верификация — проверяются только условия, необходимые для создания задачи.
shareCommission boolean Нет Указывает, делится ли комиссия с фрилансером (если 0, комиссия полностью оплачивается клиентом, если 1, 1% комиссии клиента компенсируется фрилансером). Если не указано, комиссия оплачивается клиентом
Ответ

Успешный запрос возвращает UUID созданной задачи.

Публикация черновика задачи

Пример запроса

curl -X POST "https://my.mellow.io/api/customer/tasks/publish-draft" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..." 
    -d '{
        "taskId": 12345,
        "uuid": "8e947213-c114-41ec-a9ae-0242ac130002",
        "companyId": 2
    }'

Пример ответа

HTTP status code: 200 OK

{
  "uuid": "8e947213-c114-41ec-a9ae-0242ac130002"
}

Этот метод используется для публикации ранее созданного черновика задачи и перевода его в активный статус.

Задача будет опубликована только в случае, если на счету достаточно средств. Если публикация проходит успешно, задача становится доступной для фрилансера.

Запрос

HTTP Запрос
Тело запроса
Параметр Тип Обязательный Описание
taskId integer Нет ID задачи. Если указаны и taskId, и uuid, будет использован taskId
uuid string Нет UUID задачи. Может использоваться вместо taskId
companyId integer Да ID компании (арендатора). Обязателен, если вы управляете несколькими компаниями в рамках вашего аккаунта
Ответ
Свойство Тип Описание
uuid string UUID опубликованной задачи

Если произойдет ошибка (например, недостаточно средств), будет возвращено соответствующее сообщение об ошибке.

Получение разрешенных валют для задач с мультивалютными опциями

Пример запроса

curl -X GET "https://my.mellow.io/api/customer/tasks/allowed-currencies?companyId=YOUR_COMPANY_ID" \
  -H "accept: */*" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Пример ответа

HTTP статус код: 200 OK

[
  {
    "id": 1,
    "currency": "USD"
  },
  {
    "id": 2,
    "currency": "EUR"
  }
]

Получает список разрешенных валют для задач с мультивалютными опциями, специфичных для определенной компании.

Запрос

HTTP Запрос
Параметры
Параметр Тип Обязательный Описание
companyId number yes Уникальный идентификатор компании

Ответ

Свойство Тип Описание
id number Уникальный идентификатор валюты
currency string Код валюты (например, "USD", "EUR")

Расчет общей стоимости задачи

Пример запроса

curl -X POST "https://my.mellow.io/api/customer/tasks/total-cost" \
  -H "accept: */*" \
  -H "Authorization: Bearer At__4mVoDg_6dx4TEXOKc_azImBl..." \
  -H "Content-Type: application/json" \
  -d '{
    "uuid": "cbe8003e-e9e0-46a9-b15b-7c0227273b2e",
    "price": 1,
    "workerCurrency": "USD",
    "shareCommission": false,
    "workerId": 101048,
    "categoryId": 18,
    "companyId": 2853
}'

Пример ответа

HTTP статус код: 200 OK

{
  "price": 0.95,
  "commission": 0.1,
  "commissionPercent": 10,
  "shareCommission": false,
  "sharedCommission": 0,
  "salesTax": 0,
  "total": 1.05,
  "amountForWorker": 1,
  "VAT": 0.21,
  "VATPercent": 20,
  "currency": {
    "id": 3,
    "currency": "EUR"
  },
  "workerCurrency": {
    "id": 2,
    "currency": "USD"
  },
  "priceWithActualCurrencyExchangeRate": {
    "isChanged": false,
    "price": 0.95,
    "commission": 0.1,
    "commissionPercent": 10,
    "shareCommission": false,
    "sharedCommission": 0,
    "salesTax": 0,
    "total": 1.05,
    "amountForWorker": 1,
    "VAT": 0.21,
    "VATPercent": 20,
    "currency": {
      "id": 3,
      "currency": "EUR"
    },
    "workerCurrency": {
      "id": 2,
      "currency": "USD"
    }
  },
  "exchangeRate": {
    "base": {
      "id": 2,
      "currency": "USD"
    },
    "target": {
      "id": 3,
      "currency": "EUR"
    },
    "rate": 1.0576
  }
}

Рассчитывает общую стоимость, налог с продаж и текущий обменный курс валют для задачи, включающей несколько валют. Это особенно полезно для проектов, где валюта выплаты фрилансеру отличается от валюты баланса клиента.

Запрос

HTTP Запрос
Тело запроса
Параметр Тип Обязательный Описание
uuid string yes UUID задачи
price number yes Цена задачи
workerCurrency string yes Код валюты работника (например, "USD")
shareCommission boolean yes Разделить комиссию
workerId number yes ID работника
categoryId number yes ID категории
companyId number yes ID компании

Ответ

Свойство Тип Описание
price number Базовая цена, используемая для расчета
commission number Сумма комиссии
commissionPercent number Процент комиссии
shareCommission boolean Делится ли комиссия
sharedCommission number Сумма делёжки комиссии
salesTax number Сумма налога с продаж (применимо только для компаний в США)
total number Общая сумма, включая налоги и комиссии
amountForWorker number Сумма, выделенная для работника
VAT number Сумма налога на добавленную стоимость (НДС)
VATPercent number Процент НДС
currency object Целевая валюта (id, currency)
workerCurrency object Валюта работника (id, currency)
priceWithActualCurrencyExchangeRate object Расчет с текущим обменным курсом (полный объект, как корень)
exchangeRate object Обменный курс валюты (base, target, rate)

Изменение статуса задачи

Пример запроса

curl -X PUT "https://my.mellow.io/api/customer/tasks/c6e8e285-1e0a-4a11-a676-89211c0adccc" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."

Пример ответа

HTTP статус код: 200 OK

{
  "state": 3
}

Этот метод используется для изменения статуса задачи на основе действий фрилансера. Перед использованием этого запроса, пожалуйста, свяжитесь со службой поддержки Mellow для добавления дополнительных прав доступа к сервису. Вы можете переключаться на следующие статусы: Начать задачу (ID=2), Завершить задачу (ID=3), Отклонить задачу (ID=6), и Подтвердить отклонение, если задача была отклонена клиентом (ID=8).

Существуют дополнительные запросы для отклонения/прекращения задачи или возобновления работы.

Запрос

HTTP запрос
Параметры пути
Параметр Тип Обязательно Описание
taskId integer Требуется либо taskId, либо uuid ID задачи. Чтобы получить список задач, используйте этот запрос.
uuid string Требуется либо taskId, либо uuid UUID задачи
Тело запроса
Параметр Тип Обязательно Описание
state integer Да Статус задачи. Доступные статусы: начать задачу (ID=2), завершить задачу (ID=3), отклонить задачу (ID=6), и подтвердить отказ, если задача была отклонена клиентом (ID=8).
Ответ

Успешный запрос возвращает пустой ответ.

Возможные ошибки:

{ "error": "Для начала задачи, пожалуйста, подпишите предложение соглашения", "code": 11 }

Изменение срока

Пример запроса

curl -X POST "https://my.mellow.io/api/customer/tasks/prolong-deadline" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."

Пример ответа

HTTP status code: 200 OK

Этот метод используется для продления срока выполнения задачи только для задач в статусе "Ожидание действий от клиента".

Запрос

HTTP Запрос
Тело запроса
Параметр Тип Обязательный Описание
taskId integer Требуется либо taskId, либо uuid ID задачи. Для получения списка задач используйте этот запрос.
uuid string Требуется либо taskId, либо uuid UUID задачи.
deadline date Да Дата нового срока в формате 2022-07-25T15:00:58.295Z
Ответ

Успешный запрос возвращает пустой ответ.

Проверка на наличие проблем перед началом задачи

Пример запроса

curl -X GET "http://my.mellow.io/api/customer/freelancers/check-task-requirements?taskUuid=837843c9-72e5-48e2-a133-e97e347373af&freelancerUuid=ec304480-5e3f-4bb7-a9e5-dbb49fb673e9" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -H  "Content-Type: application/json"

Пример ответа

HTTP status code: 200 OK

{
  "url": "http://my.mellow.io/agreement",
  "templateUuid": "1as7ac19-5y33-4a3a-94b3-b4a26374de4d"
}

Этот запрос указывает, может ли фрилансер начать задачу или есть ли препятствия, мешающие этому (например, необходимость повторно подписать договор предложения или пройти верификацию). Поэтому этот запрос должен быть выполнен перед изменением статуса задачи на «Начать задачу» (ID=2). Возможные проблемы:

С 9 августа 2025 года этот запрос также будет проверять, полностью ли заполнены профиль фрилансера и налоговая информация. В частности, должны быть предоставлены taxNumber и taxResidenceCountry. Вы можете предоставить идентификационный номер налогоплательщика фрилансера, используя точку доступа для добавления идентификационного номера налогоплательщика фрилансера. Если эти поля отсутствуют, ответ будет содержать сведения о неполных данных, и фрилансер не сможет принять задачу, пока не будут предоставлены все необходимые сведения.

Запрос

HTTP запрос
Параметры пути
Параметр Тип Обязательный Описание
taskUuid uuid Да UUID задачи, который возвращается при вызове запроса получение задачи по ID или запроса "получение списка задач"
freelancerUuid uuid Да UUID фрилансера, который возвращается при вызове запроса пригласить нового фрилансера

Ответ

Если проблем не обнаружено, ответ возвращается пустым.

Имя свойства Тип Описание
name string Название проблемы
data object Детали документа, который необходимо подписать (или любое другое ограничение, которое должно быть соблюдено для начала работы над задачей). Если ограничение связано с проверкой (name=verification), это поле будет содержать пустой объект.
data.url string URL документа, который необходимо переподписать
data.templateUuid string UUID документа
data.code string Код проблемы
reason string Причина проблемы (например, задача находится в санкционном списке и, следовательно, требует подписания договора предложения перед началом работы)

Принятие задачи

Пример запроса

curl -X POST "https://my.mellow.io/api/customer/tasks/accept" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -d '{
      "uuid": "123e4567-e89b-12d3-a456-426655440000"
    }'

Пример ответа

HTTP status code: 200 OK

Этот метод используется для принятия результатов работы фрилансера. Его можно вызывать только для задач в статусе «Завершено» (ID=3).

Запрос

HTTP Запрос
Тело запроса
Параметр Тип Обязательный Описание
taskId integer Требуется либо taskId, либо uuid ID задачи. Чтобы получить список задач, используйте этот запрос.
uuid string Требуется либо taskId, либо uuid UUID задачи
Тело запроса

Дополнительные параметры не требуются.

Ответ

Успешный запрос возвращает пустой ответ.

Оплата задания

Пример запроса

curl -X POST "https://my.mellow.io/api/customer/tasks/pay" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -d '{
      "uuid": "123e4567-e89b-12d3-a456-426655440000"
    }'

Пример ответа

HTTP status code: 200 OK

Этот метод используется для оплаты заданий. Средства списываются с баланса клиента и зачисляются на баланс фрилансера. Этот метод можно использовать только для оплаты задания, которое находится в статусе "Ожидание оплаты" (ID = 4).

Запрос

HTTP Запрос
Тело запроса
Тело запроса
Параметр Тип Обязательный Описание
taskId integer Требуется либо taskId, либо uuid ID задачи. Чтобы получить список задач, используйте этот запрос.
uuid string Требуется либо taskId, либо uuid UUID задачи.
Ответ

Успешный запрос возвращает пустой ответ.

Оплата задания при создании

Пример запроса

curl -X POST "https://my.mellow.io/api/customer/tasks/quick-pay" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -d '{
      "taskId": 1
    } '

Пример ответа

HTTP status code: 200 OK

Этот метод используется для оплаты заданий, находящихся в статусе New. Вы можете создать новое задание и сразу вызвать этот запрос, после чего статус задания изменится на Paid (в отличие от предыдущего запроса, который может изменить статус задания только на Paid из статуса Pending payment). Этот метод работает только для заданий, которые не требуют от фрилансера подписания дополнительных документов (договоров оферты, NDA).

Запрос

HTTP Запрос
Тело запроса
Параметр Тип Обязательный Описание
taskId integer Требуется либо taskId, либо uuid ID задачи. Чтобы получить список задач, используйте этот запрос.
uuid string Требуется либо taskId, либо uuid UUID задачи
companyId integer Нет ID компании
Ответ

Успешный запрос возвращает пустой ответ.

Отклонение/Отказ от задачи

Пример запроса

curl -X POST "https://my.mellow.io/api/customer/tasks/decline 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -d '{
      "taskId": 180012
    }'

Пример ответа

HTTP status code: 200 OK

Этот метод используется для отклонения (отказа) от задачи. В зависимости от статуса задачи до запроса, после выполнения запроса статус изменится на:

Запрос

HTTP Запрос
Тело запроса
Параметр Тип Обязательный Описание
taskId integer Да ID задачи. Чтобы получить список задач, используйте этот запрос.
Ответ

Успешный запрос возвращает пустой ответ.

Возобновление задачи

Пример запроса

curl -X POST "https://my.mellow.io/api/customer/tasks/return-to-work
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -d '{
      "taskId": 180012
    }'

Пример ответа

HTTP статус-код: 200 OK

Этот метод используется для возобновления работы над задачей. Задачу можно вернуть только в статус В процессе (ID=2) из статуса Проверка клиентом (ID=3). Для всех других статусов будет возвращена ошибка. Смотрите подробную схему основных статусов задач здесь.

Запрос

HTTP Запрос
Тело запроса
Параметр Тип Обязательно Описание
taskId integer Да ID задачи. Чтобы получить список задач, используйте этот запрос.
Ответ

Успешный запрос возвращает пустой ответ.

Чат задач

Клиенты и фрилансеры могут оставлять сообщения в рамках задач. Этот раздел описывает, как вы можете просматривать существующие сообщения или отправлять новые.

Получение сообщений задачи

Пример запроса

curl -X GET "https://my.mellow.io/api/customer/tasks/583689/messages" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."

Этот метод используется для получения сообщений из заданной задачи.

Запрос

HTTP Запрос
Параметры пути

В качестве параметра пути вы должны передать идентификатор задачи.

Добавление сообщений к задаче

Пример запроса

curl -X POST "https://my.mellow.io/api/customer/tasks/messages" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -H  "Content-Type: application/json" 
    -d "{
            "taskId":583689,
            "message":"Task is ready, let's go"
        }"

Пример ответа

HTTP status code: 200 OK

Этот метод используется для добавления сообщения к задаче. Отправителем сообщений является авторизованный пользователь.

Запрос

HTTP Запрос
Тело запроса
Параметр Тип Обязательный Описание
taskId integer Да ID задачи
message string Да Текст сообщения
Ответ

Успешный запрос возвращает пустой ответ.

Группа задач

Получение групп задач

Пример запроса

curl -X GET "https://my.mellow.io/api/customer/task-groups" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."

Пример ответа

HTTP status code: 200 OK

{
  "items": [
    {
      "id": 650,
      "companyId": 2955,
      "color": "FFFFFF",
      "title": "string",
      "createdAt": "2021-12-01 20:59:52"
    }
  ],
  "pagination": {
    "count": 3,
    "total": 3,
    "perPage": 20,
    "page": 1,
    "pages": 1
  }
}

Этот метод используется для получения списка групп задач.

Запрос

HTTP Запрос
Параметры

Дополнительные параметры запроса отсутствуют.

Ответ
Имя свойства Тип Описание
items object Группы задач
items.id integer ID группы задач
items.companyId integer ID клиента
items.color string Цвет иконки группы
items.title string Название группы
items.createdAt string Дата создания группы задач
pagination object Страницы
pagination.count integer Текущая страница
pagination.total integer Количество страниц
pagination.perPage integer Количество задач на страницу
pagination.page integer Текущая страница
pagination.pages integer Количество страниц

Переименование группы задач

Пример запроса

curl -X PUT "https://my.mellow.io/api/customer/task-groups" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -H  "Content-Type: application/json" 
    -d "{
        "groupId":650,
        "title":"new name"
    }"

Пример ответа

HTTP status code: 200 OK

{
  "actorId": 100740,
  "companyId": 2955,
  "groupId": 650,
  "title": "new name"
}

Этот метод используется для изменения названия группы задач.

Запрос

HTTP Запрос
Тело запроса
Параметр Тип Обязательно Описание
groupId integer Да ID группы
title string Да Новое название группы задач
Ответ
Имя свойства Тип Описание
actorId integer ID пользователя, который обновил название группы задач
companyId integer ID компании
groupId integer ID группы задач
title string Название группы задач

Создание групп задач

Пример запроса

curl -X POST "https://my.mellow.io/api/customer/task-groups" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -H  "Content-Type: application/json" 
    -d "{
        "title": "new task group"
    }"

Пример ответа

HTTP status code: 200 OK

{
  "actorId": 100740,
  "companyId": 2955,
  "title": "new task group"
}

Этот метод используется для создания группы задач.

Запрос

HTTP Запрос
Тело запроса
Параметр Тип Обязательно Описание
title string Да Название новой группы задач
Ответ
Имя свойства Тип Описание
actorId integer ID пользователя, запросившего создание задач
companyId integer ID компании
title string Название группы задач

Удаление групп задач

Пример запроса

curl -X DELETE "https://my.mellow.io/api/customer/task-groups" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -H  "Content-Type: application/json" 
    -d "{
        "groupId": 650
    }"

Пример ответа

HTTP status code: 200 OK

{
  "actorId": 100740,
  "companyId": 2955,
  "groupId": 650
}

Этот метод используется для удаления группы задач.

Запрос

HTTP Запрос
Тело запроса
Параметр Тип Обязательный Описание
groupId integer Да ID группы задач
Ответ
Имя свойства Тип Описание
actorId integer ID пользователя, запросившего создание задач
companyId integer ID компании
groupId integer ID группы задач

Файлы задания

Добавление файлов к задаче

Пример запроса

curl -X POST "https://my.mellow.io/api/customer/tasks/files" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -d '{
      "uuid": "123e4567-e89b-12d3-a456-426655440000",
      "file": "/Users/solar/tmp/1c_report_example.xml",
      "type": "5"
    }'

Пример ответа

HTTP status code: 200 OK

Этот метод используется для добавления файлов к задаче.

Запрос

HTTP Запрос
Тело запроса
Параметр Тип Обязательно Описание
file string Да Путь к файлу (например, /Users/solar/tmp/1c_report_example.xml)
taskId integer Требуется либо taskId, либо uuid ID задачи. Чтобы получить список задач, используйте этот запрос.
uuid string Требуется либо taskId, либо uuid UUID задачи.
type integer Да Тип файла. Возможные значения:
  • 5: Передача прав в задаче
Ответ

Успешный запрос возвращает пустой ответ.

Фрилансеры

Этот раздел содержит методы управления фрилансерами, включая:

Приглашение фрилансера

Пример запроса

curl -X POST "https://my.mellow.io/api/customer/freelancers" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -H  "Content-Type: application/json" 
    -d "{
        "email": "[email protected]",
        "note": "Опытный фронтенд-разработчик с акцентом на React и TypeScript.",
        "inEnglish": true,
        "sendEmail": true
      }
      "

Пример ответа

HTTP status code: 200 OK

{
  "uuid": "b2e2671d-f850-493f-83ba-f236d3192974",
  "freelancerId": 123
}

Создает новый профиль фрилансера и добавляет фрилансера в вашу команду, отправляя ему приглашение по электронной почте.
Существует два основных способа организации работы фрилансера в Mellow:

1. Самостоятельная регистрация фрилансера:
Когда вы приглашаете фрилансера по электронной почте, он получает ссылку для регистрации и самостоятельно завершает регистрацию в интерфейсе Mellow. В этом случае фрилансер самостоятельно вводит всю необходимую личную и налоговую информацию во время регистрации. Клиенту требуется только указать адрес электронной почты фрилансера в запросе.

2. Регистрация от имени фрилансера:
Если фрилансер не будет регистрироваться сам, вы (клиент) должны предоставить все личные данные и налоговую информацию непосредственно в запросе API. Все обязательные поля должны быть заполнены до того, как фрилансер сможет принимать задания. Этот путь требует от вас предоставления личных данных фрилансера, адреса, гражданства и информации о налоговом резидентстве.

С 9 августа 2025 года поле email становится обязательным, и приглашение фрилансеров по номеру телефона больше не поддерживается. Если вы используете второй способ, поля, такие как citizenship,birthdate, address, postalCode, city, state, и country должны быть указаны в запросе.

Требования к налоговым данным

Предоставление информации о налогоплательщике обязательно для поддержания активного профиля фрилансера.
См. Добавление идентификационного номера налогоплательщика фрилансера.

Требования к соглашению о предложении фрилансера

Для начала работы в сервисе фрилансер должен подписать соглашение о предложении. Если фрилансер регистрируется самостоятельно, ему будет предложено подписать соглашение перед принятием первого задания. Если вы завершаете регистрацию от его имени, вы должны убедиться, что соглашение подписано, прежде чем он сможет начать работу. Перед изменением статуса задания на "Начать задание" или выполнением любого действия, переводящего в этот статус (например, быстрая оплата задания), выполните проверку на наличие ограничений, используя Проверка на наличие проблем перед началом задания. Если соглашение не подписано, используйте точку доступа Принять предложение от имени фрилансера для продолжения.

Эти требования применяются для активации профиля фрилансера и также проверяются при создании предложений или счетов.

Запрос возвращает UUID фрилансера, который можно использовать в последующих вызовах API, таких как получение деталей фрилансера, удаление фрилансера из вашей команды или управление его платежными методами.
Указать свой UUID невозможно: он генерируется автоматически.

Кроме того, вы можете самостоятельно сгенерировать ссылку для регистрации, используя возвращенный UUID, и отправить ее напрямую фрилансеру.
Для формирования ссылки на регистрацию используйте следующий формат:

https://my.mellow.io/registration/invite?utm_source=company_invite&utm_medium=invite&invite_from={company_id}&hashtoken={freelancer_uuid}&type=freelancer-registration

Все параметры URL, кроме invite_from и hashtoken, остаются неизменными, как показано выше.

Запрос

HTTP Запрос

Тело запроса

Параметр Тип Обязательно Описание
email string Да Электронная почта фрилансера
phone string Нет Телефон фрилансера (только цифры, без пробелов и специальных символов)
firstName string Нет Имя фрилансера
lastName string Нет Фамилия фрилансера
middleName string Нет Отчество фрилансера
citizenship string Нет Гражданство. Это поле необходимо заполнить, если фрилансер не будет регистрироваться в сервисе самостоятельно.
address string Нет Улица, дом
postalCode string Нет Почтовый индекс
city string Нет Город
state string Нет Штат/регион
country string Нет Страна. Это поле необходимо заполнить, если фрилансер не будет регистрироваться в сервисе самостоятельно.
birthdate string Нет Дата рождения фрилансера
birthCountry string Нет Страна рождения фрилансера
specialization string Нет Специализация фрилансера
note string Нет Описание фрилансера
inEnglish boolean Нет Указывает, что приглашение должно быть отправлено на английском языке
sendEmail boolean Нет Указывает, следует ли отправлять электронное письмо. Если нет, то фрилансер будет добавлен в команду клиента без получения электронного письма.

Ответ

Имя свойства Тип Описание
uuid string UUID фрилансера
freelancerId string ID фрилансера

Редактирование профиля фрилансера

Пример запроса

curl -X PATCH "https://my.mellow.io/api/customer/freelancers/profile" \
    -H "accept: application/json" \
    -H "Content-Type: application/json" \
    -d "{
        "freelancerId": "152",
        "firstName": "Emily",
        "lastName": "Roberts",
        "middleName": "Jane",
        "residenceCountry": "US",
        "citizenship": "CA",
        "birthDate": "1991-04-15",
        "city": "San Francisco",
        "address": "200 Market St, Apt 5B",
        "postalCode": "94111",
        "state": "CA",
        "language": "EN"
    }
    "

Пример ответа

HTTP status code: 200 OK

Редактируйте данные профиля фрилансера. Этот метод можно использовать только для фрилансеров, которые еще не активировали свой аккаунт и не прошли верификацию. Он особенно полезен, если фрилансер еще не принял приглашение или не зарегистрировался самостоятельно, но вам необходимо дополнить или исправить информацию в его профиле (такую как имя, адрес или другие необходимые данные) до завершения процесса регистрации и ввода в деятельность.

Запрос

HTTP Запрос
Параметры запроса
Параметр Тип Обязательный Описание
freelancerId integer Требуется один из freelancerId или freelancerUuid Внутренний ID фрилансера
freelancerUuid string Требуется один из freelancerId или freelancerUuid UUID фрилансера
firstName string Нет Имя фрилансера
lastName string Нет Фамилия фрилансера
middleName string Нет Отчество фрилансера
residenceCountry string Нет Страна проживания (код страны ISO)
citizenship string Нет Гражданство (код страны ISO)
birthDate string Нет Дата рождения (строка даты-времени ISO 8601)
birthCountry string Нет Страна рождения фрилансера
city string Нет Город
address string Нет Улица, дом
postalCode string Нет Почтовый индекс
state string Нет Штат или регион
language string Нет Предпочитаемый язык интерфейса. Enum: EN, RU

Ответ

Успешный запрос возвращает пустой ответ.

Получение списка фрилансеров

Пример запроса

curl -X GET "https://my.mellow.io/api/customer/freelancers?filter[taxationStatusId]=1" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -H  "Content-Type: application/json"

Пример ответа

HTTP status code: 200 OK

{
  "items": [
    {
      "id": 1,
      "uuid": "9b2cf17c-8f33-4e7a-89b4-c5a1d2630de4",
      "email": "[email protected]",
      "name": "Алексей Миронов",
      "taxationStatusId": 3,
      "taxationBlockedTill": "2022-12-31",
      "categoryTitle": "Консультант",
      "categoryTitleEn": "Consultant",
      "details": {
        "firstName": "Алексей",
        "lastName": "Миронов",
        "note": "Специалист по финансовым вопросам",
        "specialization": "Финансовый консультант"
      },
      "country": "RU",
      "isVerified": true,
      "isInviteSent": true,
      "inviteSentAt": "2021-12-23T18:48:40.800Z",
      "registerDate": "2021-12-23T18:48:40.800Z",
      "isRegistered": true
    }
  ],
  "pagination": {
    "count": 20,
    "total": 41,
    "perPage": 20,
    "page": 1,
    "pages": 3
  }
}

Этот запрос используется для получения списка фрилансеров.

Запрос

HTTP Запрос
Параметры запроса
Параметр Тип Обязательный Описание
filter[taxationStatusId] integer Нет ID налогового статуса. Возможные значения:
  • 1: Физическое лицо
  • 3: Самозанятый
  • 4: Индивидуальный предприниматель
filter[isVerified] boolean Нет Указывает, верифицирован ли аккаунт фрилансера
filter[isInviteEmailSent] boolean Нет Указывает, было ли отправлено приглашение фрилансеру
filter[dateInvitedFrom] string Нет Дата приглашения (начало интервала)
filter[dateInvitedTo] string Нет Дата приглашения (конец интервала)
page integer Нет Номер страницы для пагинации
size integer Нет Количество элементов на странице (по умолчанию 20, максимум 500)

Ответ

Имя свойства Тип Описание
items list Список фрилансеров
items.id integer ID фрилансера
items.uuid uuid UUID фрилансера UUID
items.email string Электронная почта фрилансера
items.name string Имя фрилансера
items.taxationStatusId integer Налоговый статус фрилансера
items.taxationBlockedTill integer Дата, до которой нельзя изменить налоговый статус
items.categoryTitle string Специализация фрилансера
items.categoryTitleEn string Название специализации на английском
items.details object Личные данные фрилансера
items.details.firstName string Имя фрилансера
items.details.lastName string Фамилия фрилансера
items.details.note string Описание фрилансера
items.details.specialization string Специализация фрилансера
items.country string Код страны фрилансера (две буквы, например, AM для Армении)
items.isVerified boolean Указывает, верифицирован ли аккаунт
items.isInviteSent boolean Указывает, что приглашение было отправлено
items.inviteSentAt string Дата отправки приглашения
items.registerDate string Дата регистрации
items.isRegistered boolean Указывает, что фрилансер принял приглашение и предоставил личные данные
items.isTaxPaymentAllowed boolean Указывает, разрешена ли автоматическая оплата налогов
pagination list Пагинированный вывод
pagination.count integer Количество возвращенных элементов
pagination.total integer Общее количество элементов, доступных с запрошенным фильтром
pagination.perPage integer Количество элементов на странице
pagination.page integer Текущий номер страницы
pagination.pages integer Общее количество страниц

Поиск фрилансеров по электронной почте

Пример запроса

curl -X GET "https://my.mellow.io/api/customer/freelancer-by-email/{email}" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -H  "Content-Type: application/json"

Пример ответа

HTTP status code: 200 OK

{
  "id": 12,
  "email": "[email protected]",
  "name": "Michael Adams",
  "taxationStatusId": 0,
  "taxationBlockedTill": "",
  "categoryTitle": "Developer",
  "categoryTitleEn": "Developer",
  "details": {
    "firstName": "Michael",
    "lastName": "Adams",
    "note": "Experienced in building scalable web applications using modern technologies like React, Node.js, and PostgreSQL.",
    "specialization": "Full-Stack Developer"
  },
  "country": "US",
  "isVerified": true,
  "isInviteSent": true,
  "inviteSentAt": "2021-12-23T18:48:40.800Z",
  "registerDate": "2021-12-23T18:48:40.800Z",
  "isRegistered": true
}

Этот запрос используется для поиска фрилансера по его электронной почте.

Запрос

HTTP Запрос
Параметры пути

В качестве параметра пути необходимо передать email фрилансера.

Ответ

Название свойства Тип Описание
id integer ID фрилансера
uuid integer UUID фрилансера
email string Электронная почта фрилансера
name string Имя фрилансера
taxationStatusId integer Налоговый статус фрилансера
taxationBlockedTill integer Дата, до которой нельзя изменить налоговый статус
categoryTitle string Специализация фрилансера
categoryTitleEn string Название специализации на английском
details object Личные данные фрилансера
details.firstName string Имя фрилансера
details.lastName string Фамилия фрилансера
details.note string Описание фрилансера
details.specialization string Специализация фрилансера
country string Код страны фрилансера (например, "AM" для Армении)
isVerified boolean Указывает, верифицирован ли аккаунт
isInviteSent boolean Указывает, что приглашение было отправлено
inviteSentAt string Дата отправки приглашения
registerDate string Дата регистрации
isRegistered boolean Указывает, что фрилансер принял приглашение
isTaxPaymentAllowed boolean Указывает, разрешена ли автоматическая оплата налогов
emailConfirmationStatus boolean Указывает, подтверждена ли электронная почта фрилансера
phoneConfirmationStatus boolean Указывает, подтвержден ли телефон фрилансера

Поиск фрилансеров по номеру телефона

Пример запроса

curl -X GET "https://my.mellow.io/api/customer/freelancer-by-phone/{phone number}" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -H  "Content-Type: application/json"

Пример ответа

HTTP status code: 200 OK

{
  "id": 45,
  "email": "[email protected]",
  "name": "Alex Smith",
  "taxationStatusId": 2,
  "taxationBlockedTill": "2023-10-01",
  "categoryTitle": "Software Engineer",
  "categoryTitleEn": "Software Engineer",
  "details": {
    "firstName": "Alex",
    "lastName": "Smith",
    "note": "Skilled in backend development with extensive experience in Python, Django, and cloud infrastructure.",
    "specialization": "Backend Developer"
  },
  "country": "CA",
  "isVerified": true,
  "isInviteSent": true,
  "inviteSentAt": "2022-01-15T12:30:00.000Z",
  "registerDate": "2022-01-16T09:00:00.000Z",
  "isRegistered": true
}

Этот запрос используется для поиска фрилансера по его номеру телефона.

Запрос

HTTP запрос
Параметры пути

В качестве параметра пути необходимо передать номер телефона фрилансера.

Ответ

Имя свойства Тип Описание
id integer ID фрилансера
uuid integer UUID фрилансера
email string Электронная почта фрилансера
name string Имя фрилансера
taxationStatusId integer Налоговый статус фрилансера
taxationBlockedTill integer Дата, до которой нельзя изменить налоговый статус
categoryTitle string Специализация фрилансера
categoryTitleEn string Название специализации на английском
details object Личные данные фрилансера
details.firstName string Имя фрилансера
details.lastName string Фамилия фрилансера
details.note string Описание фрилансера
details.specialization string Специализация фрилансера
country string Код страны фрилансера (например, "AM" для Армении)
isVerified boolean Указывает, верифицирован ли аккаунт
isInviteSent boolean Указывает, что приглашение было отправлено
inviteSentAt string Дата отправки приглашения
registerDate string Дата регистрации
isRegistered boolean Указывает, что фрилансер принял приглашение
isTaxPaymentAllowed boolean Указывает, разрешена ли автоматическая оплата налогов
emailConfirmationStatus boolean Указывает, подтверждена ли электронная почта фрилансера
phoneConfirmationStatus boolean Указывает, подтвержден ли телефонный номер фрилансера

Получение данных фрилансера

Пример запроса

curl -X GET "https://my.mellow.io/api/customer/freelancers/12" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -H  "Content-Type: application/json"

Пример ответа

HTTP status code: 200 OK

{
  "id": 78,
  "email": "[email protected]",
  "name": "Sophia Johnson",
  "taxationStatusId": 4,
  "taxationBlockedTill": "2025-01-01",
  "categoryTitle": "UI/UX Designer",
  "categoryTitleEn": "UI/UX Designer",
  "details": {
    "firstName": "Sophia",
    "lastName": "Johnson",
    "note": "Эксперт в создании дизайнов, ориентированных на пользователя, с акцентом на удобство использования и эстетику. Владеет Figma и Adobe XD.",
    "specialization": "UI/UX Design"
  },
  "country": "DE",
  "isVerified": true,
  "isInviteSent": true,
  "inviteSentAt": "2023-05-20T14:15:00.000Z",
  "registerDate": "2023-05-21T10:00:00.000Z",
  "isRegistered": true
}

Этот запрос используется для получения данных фрилансера по их ID или UUID.

Запрос

HTTP Запрос
Параметры пути

В качестве параметра пути необходимо передать либо ID фрилансера, либо UUID.

Ответ

Имя свойства Тип Описание
id integer ID фрилансера
uuid integer UUID фрилансера
email string Электронная почта фрилансера
name string Имя фрилансера
taxationStatusId integer Налоговый статус фрилансера
taxationBlockedTill integer Дата, до которой нельзя изменить налоговый статус
categoryTitle string Специализация фрилансера
categoryTitleEn string Название специализации на английском
details object Личные данные фрилансера
details.firstName string Имя фрилансера
details.lastName string Фамилия фрилансера
details.note string Описание фрилансера
details.specialization string Специализация фрилансера
country string Код страны фрилансера (например, "AM" для Армении)
isVerified boolean Указывает, верифицирован ли аккаунт
isInviteSent boolean Указывает, что приглашение было отправлено
inviteSentAt string Дата отправки приглашения
registerDate string Дата регистрации
isRegistered boolean Указывает, что фрилансер принял приглашение
isTaxPaymentAllowed boolean Указывает, разрешена ли автоматическая оплата налогов
emailConfirmationStatus boolean Указывает, подтверждена ли электронная почта фрилансера
phoneConfirmationStatus boolean Указывает, подтвержден ли телефон фрилансера

Редактирование деталей профиля

Пример запроса

curl -X PUT "https://my.mellow.io/api/customer/freelancers" 
    -H  "Accept: application/json" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -H  "Content-Type: application/json" 
    -d "{
        "freelancerId": 25,
        "firstName": "Emma",
        "lastName": "Brown",
        "note": "Skilled backend developer with expertise in Node.js and MongoDB.",
        "specialization": "Backend Developer",
        "freelancerUuid": "a7d53c21-e6f2-42f8-b78b-1f9b90b4c123",
        "companyId": 5
      }"

Этот запрос используется для изменения деталей профиля фрилансера, таких как имя, фамилия, специализация или описание.

Запрос

HTTP Запрос
Тело запроса
Параметр Тип Обязательный Описание
freelancerId integer Да ID фрилансера
firstName string Нет Имя фрилансера
lastName string Нет Фамилия фрилансера
note string Нет Описание фрилансера
specialization string Нет Специализация фрилансера. Для получения списка специализаций используйте этот запрос.
freelancerUuid uuid Нет UUID фрилансера
companyId integer Нет ID компании

Ответ

Успешный запрос возвращает пустой ответ.

Запрос кода для изменения контактных данных

Пример запроса

curl -X POST "https://my.mellow.io/api/customer/freelancers/request-code-for-change-contacts" 
    -H  "Accept: application/json" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -H  "Content-Type: application/json" 
    -d "{
        "freelancerId": 1,
        "email": "[email protected]",
        "phone": "+1234567890"
      } "

Этот запрос позволяет вам обновить контактные данные фрилансера, в частности их номер телефона или электронную почту. При отправке запроса укажите обновленную контактную информацию фрилансера и его ID. После запроса фрилансеру будет отправлен код, который затем должен быть включен в запрос /api/customer/freelancers/change-contacts для дальнейшей верификации.

Запрос

HTTP запрос
Тело запроса
Параметр Тип Обязательный Описание
freelancerId integer Да ID фрилансера
email string Нет Электронная почта фрилансера
phone string Нет Телефон фрилансера

Ответ

После успешного выполнения запроса возвращается код, который должен быть включен в запрос /api/customer/freelancers/change-contacts (см. дополнительные сведения ниже).

Подтверждение изменения контактных данных

Пример запроса

curl -X POST "https://my.mellow.io/api/customer/freelancers/change-contacts" 
    -H  "Accept: application/json" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -H  "Content-Type: application/json" 
    -d "{
          "freelancerId": 1,
          "code": "123123",
      }"

Для изменения контактных данных фрилансера (номер телефона, электронная почта или оба), используйте нижеприведенный запрос в формате JSON. Убедитесь, что запрос включает уникальный код, полученный после первоначального запроса на изменение контактных данных, а также ID фрилансера. Если код действителен, контактные данные фрилансера будут обновлены в соответствии с указанными в запросе на изменение.

Запрос

HTTP Запрос
Тело запроса
Параметр Тип Обязательный Описание
freelancerId integer Да ID фрилансера
code string Да Код, полученный в запросе на изменение контактных данных

Ответ

Успешный запрос возвращает пустой ответ.

Пример запроса

curl -X GET "https://my.mellow.io/api/customer/freelancers/verification-link?freelancerId=123" 
    -H  "Accept: application/json" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -H  "Content-Type: application/json"

Пример ответа

HTTP status code: 200 OK

{
  "terminal_url":"https://link-to-verification-terminal"
}

Верификация аккаунта - это процесс подтверждения данных личности и документов. Чтобы узнать больше о верификации, смотрите Центр помощи.

Этот запрос используется для генерации ссылки на верификацию, которую вы можете отправить фрилансеру.

Запрос

HTTP Запрос
Параметры запроса
Параметр Тип Обязательный Описание
freelancerId integer Да ID фрилансера
redirectUrl string Нет URL, на который будет перенаправлен фрилансер после верификации

Ответ

Имя свойства Тип Описание
terminal_url string URL страницы верификации

Изменение налогового статуса фрилансера

Пример запроса

curl -X POST "https://my.mellow.io/api/customer/freelancers/change-taxation-status" 
    -H  "Accept: application/json" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -H  "Content-Type: application/json" 
    -d "{
        "freelancerId": 123,
        "taxationStatusId": 1
      }"


Пример запроса с UUID:


curl -X POST "https://my.mellow.io/api/customer/freelancers/change-taxation-status" 
    -H  "Accept: application/json" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -H  "Content-Type: application/json" 
    -d "{
        "freelancerUuid": "8e947213-c114-41ec-a9ae-0242ac130002",
        "taxationStatusId": 1
      }"

Пример ответа

HTTP status code: 200 OK

{
  "linkToTerminal": "http://link.com"
}

Этот запрос используется для изменения налогового статуса фрилансера (применимо только к фрилансерам из России):

Для получения дополнительной информации о налоговых статусах для российских фрилансеров смотрите здесь).

Запрос

HTTP Запрос
Тело запроса
Параметр Тип Обязательный Описание
freelancerId integer Требуется один из freelancerId или freelancerUuid ID фрилансера
freelancerUuid uuid Требуется один из freelancerId или freelancerUuid UUID фрилансера, например, 8e947213-c114-41ec-a9ae-0242ac130002
taxationStatusId integer Да ID налогового статуса. Возможные значения:
  • 1 - физическое лицо
  • 3 - самозанятый
  • 4 - индивидуальный предприниматель

Ответ

Имя свойства Тип Описание
linkToTerminal string URL терминала для изменения налогового статуса

Добавление идентификационного номера налогоплательщика фрилансера

Пример запроса

curl -X POST "https://my.mellow.io/api/customer/freelancers/tax-info" 
    -H  "Accept: application/json" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -H  "Content-Type: application/json" 
    -d "{
        "freelancerId": 100934,
        "taxResidenceCountry": "RU",
        "type": "INN",
        "taxNumber": "709849850606"
      } "


Пример запроса с UUID:


curl -X POST "https://my.mellow.io/api/customer/freelancers/tax-info" 
    -H  "Accept: application/json" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -H  "Content-Type: application/json" 
    -d "{
          "freelancerId": null,
          "freelancerUuid": "8e947213-c114-41ec-a9ae-0242ac130002",
          "taxResidenceCountry": "RU",
          "type": "INN",
          "taxNumber": "709849850606"
        }"

Этот запрос используется для добавления идентификационного номера налогоплательщика фрилансера, например ИНН в России или другого типа ИНН.

Обратите внимание: С 9 августа 2025 года этот эндпоинт заменяет POST /api/customer/freelancers/add-tax-document. Все новые и обновленные отправки налоговой информации должны быть отправлены на POST /api/customer/freelancers/tax-info. Новый эндпоинт вводит более строгую логику проверки, требует поля taxResidenceCountry и проверяет типы документов для всех комбинаций страны/документа.

Запрос

HTTP Запрос
Тело запроса
Параметр Тип Обязательный Описание
freelancerId string Требуется либо freelancerId, либо freelancerUuid Уникальный идентификатор фрилансера
freelancerUuid string Требуется либо freelancerId, либо freelancerUuid Уникальный UUID фрилансера
taxResidenceCountry string да Страна налогового резидентства (например, "RU", "US")
type string да Тип налогового документа (например, "ИНН"). Список доступных документов смотрите здесь
taxNumber string да Номер налогового документа
vatNumber string нет Номер НДС (только для фрилансеров из ЕС)
regNumber string нет Регистрационный номер (если применимо)

Ответ

Успешный запрос возвращает пустой ответ.

Получение налоговой информации фрилансера

Пример запроса

curl -X GET "https://my.mellow.io/api/customer/freelancers/tax-info/100934" \
    -H "Accept: application/json" \
    -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."

Пример ответа

HTTP status code: 200 OK

{
    "taxResidenceCountry": "RU",
    "type": "INN",
    "taxNumber": "709849850606",
    "vatNumber": null,
    "regNumber": "315774600024875"
}

Получает данные налоговых документов фрилансера, если он входит в состав команды заказчика. Возвращает детали налоговых документов (или null/пустые поля, если они не установлены).

Запрос

HTTP Запрос
Параметры пути

В качестве параметра пути необходимо передать ID фрилансера.

Ответ
Свойство Тип Описание
taxResidenceCountry string Страна налогового резидентства, указанная в приложенном документе, если таковой имеется; null, если не предоставлено
type string Тип налогового документа (например, "ИНН"); null, если не предоставлено
taxNumber string Номер налогового документа; null, если не предоставлено
vatNumber string Номер НДС ЕС, если доступен; null, если не предоставлено
regNumber string Регистрационный номер (например, ОГРНИП для российских фрилансеров со статусом ИП), или значение из пользовательских настроек; пустая строка, если не установлено

Удаление фрилансеров из команды

Пример запроса

curl -X DELETE "https://my.mellow.io/api/customer/freelancers" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -H  "Content-Type: application/json" 
    -d "{
        "freelancerId": 12
      }"

Пример ответа

HTTP status code: 200 OK

Успешный запрос возвращает пустой ответ.

Этот запрос используется для удаления фрилансера из команды.

Запрос

HTTP запрос
Параметры запроса
Параметр Тип Обязательный Описание
freelancerId integer Требуется либо freelancerId, либо freelancerUuid ID фрилансера
freelancerUuid string Требуется либо freelancerId, либо freelancerUuid UUID фрилансера (например, 8e947213-c114-41ec-a9ae-0242ac130002)

Ответ

Успешный запрос возвращает пустой ответ.

Принятие предложения о соглашении

Пример запроса

curl -X POST "https://my.mellow.io/api/customer/freelancers/sign-agreement" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -H  "Content-Type: application/json" 
    -d "{
        "templateUuid": "1as7ac19-5y33-4a3a-94b3-b4a26374de4d",
        "freelancerId": 100934
      }"

Пример ответа

HTTP status code: 200 OK

Успешный запрос возвращает пустой ответ.

Этот запрос позволяет подписать соглашение о предложении от имени фрилансера. Запрос, который проверяет новые предложения, возвращает идентификатор предложения, который необходимо предоставить в запросе на принятие предложения о соглашении. Кроме того, предоставляется ссылка для просмотра предложения, чтобы вы могли показать его фрилансеру.

Запрос

HTTP Запрос
Тело запроса
Параметр Тип Обязательный Описание
freelancerId integer Требуется либо freelancerId, либо freelancerUuid ID фрилансера
freelancerUuid uuid Требуется либо freelancerId, либо freelancerUuid UUID фрилансера (например, 8e947213-c114-41ec-a9ae-0242ac130002)
templateUuid uuid Да UUID предложения

Ответ

Успешный запрос возвращает пустой ответ.

Финансы

В Mellow баланс — это средства пользователя в системе. По функционалу и возможностям он схож с банковским счетом. У каждого фрилансера есть три баланса, каждый в своей валюте: рубли, доллары и евро. Компания может иметь баланс только в одной из этих валют. По этой причине запросы информации о балансе фрилансера всегда возвращают информацию только о балансе в той валюте, которая совпадает с валютой компании.

Этот раздел содержит следующие инструкции:

Создание выплаты за задание

Пример запроса

curl --location 
  --request POST 'https://my.mellow.io/api/customer/tasks/payout' \
  --data-raw '{
        "taskId": 583695,
        "payoutEndpointType": 1,
        "payoutEndpointId": 79093
    }'

Пример ответа

HTTP status 200 OK

Успешный запрос возвращает пустой ответ.

Этот запрос используется для перевода оплаты за платное задание с баланса фрилансера на его банковскую карту, банковский счет или электронный кошелек. Вы можете использовать этот запрос только для отправки средств за оплаченное задание: вы не можете просто перевести средства, которые не связаны с каким-либо заданием, с баланса фрилансера. В запросе передайте идентификатор задания и целевой способ оплаты. В качестве дополнительного параметра вы можете указать базовую валюту, которая будет конвертирована в целевую валюту. Например, вывод средств с баланса в рублях на казахстанскую банковскую карту требует конвертации в евро, иначе платеж не произойдет.

Запрос

HTTP запрос
Тело запроса
Имя Тип Обязательно Описание
taskId integer Требуется либо taskId, либо uuid ID задачи. Чтобы получить список задач, используйте этот запрос.
uuid string Требуется либо taskId, либо uuid UUID задачи
payoutEndpointType string Да Тип метода выплаты. Возможные значения:
  • 1: Банковская карта
  • 2: WebMoney
  • 6: Банковский счет
.
payoutEndpointId integer Да ID добавленного метода выплаты фрилансером. Вы можете либо добавить новый метод выплаты, либо выбрать метод выплаты из уже добавленных фрилансером.
currencyId integer Нет ID целевой валюты. Чтобы просмотреть значения ID, используйте запрос на получение списка валют.

Ответ

Успешный запрос возвращает пустой ответ.

Получение статуса выплаты по номеру задачи

Пример запроса

curl --location 
  --request GET 'https://my.mellow.io/api/customer/tasks/payout/432453' \

Пример ответа

HTTP status 200 OK

{
  "payoutStatus": 2
}

Этот запрос используется для получения статуса выплаты. После создания выплаты, вы можете вызвать этот запрос, чтобы убедиться, что выплата была завершена и деньги достигли фрилансера.

Запрос

HTTP Запрос
Параметры пути

В качестве параметра пути необходимо передать либо идентификатор задачи, либо UUID. Чтобы получить список задач, используйте этот запрос.

Ответ

Имя свойства Тип Описание
payoutStatus integer Статус выплаты. Возможные значения:
  • 1: В процессе
  • 2: Завершено
  • 3: Отклонено
  • 5: Частично завершено
  • 10: Создано
.

Получение списка транзакций

Пример запроса

curl --location 
  --request GET 'https://my.mellow.io/api/customer/transactions' \

Пример ответа

HTTP статус 200 OK

{
  "items": [
    {
      "id": 1710153,
      "type": 2,
      "amount": 1030,
      "createdAt": "2021-01-28 10:34:12",
      "currency": {
        "currency": "RUB",
        "id": 1
      },
      "balanceId": 246709
    }
  ],
  "pagination": {
    "count": 20,
    "total": 383,
    "perPage": 20,
    "page": 1,
    "pages": 20
  }
}

Этот запрос используется для получения списка всех транзакций.

Запрос

HTTP запрос
Тело запроса

Дополнительных параметров запроса нет.

Ответ

Название свойства Тип Описание
id integer ID транзакции
type integer Тип транзакции. Возможные значения:
  • 1: Пополнение
  • 2: Снятие
  • 3: Возврат
.
amount float Сумма транзакции
createdAt string Дата транзакции
currency.currency string Название валюты
paycurrency.id integer ID валюты
balanceId integer ID баланса

Получение способов оплаты фрилансера

Пример запроса

curl --location 
  --request GET 'https://my.mellow.io/api/customer/freelancers/payout-endpoints?freelancerId=1' \

Пример ответа

HTTP status 200 OK

{
  "wallets": [
    {
      "createdAt": "2021-07-20 06:33:14",
      "currency": {
        "currency": "RUB",
        "id": 1
      },
      "id": 48998,
      "number": "2099772984",
      "status": 1,
      "walletType": 2,
      "type": 2,
      "ownerId": 100870,
      "autoPay": true
    }
  ],
  "cards": [
    {
      "createdAt": "2021-01-25 10:32:47",
      "currency": {
        "currency": "EUR",
        "id": 3
      },
      "expire": "03/26",
      "holder": "DINA BOOM",
      "id": 79082,
      "number": "5213 24** **** 9877",
      "status": 4,
      "cardType": 1,
      "type": 1,
      "ownerId": 100870,
      "country": "RU",
      "autoPay": true
    }
  ],
  "ibans": []
}

Этот запрос используется для получения списка доступных способов оплаты для фрилансера.

Запрос

HTTP Запрос
Параметры запроса
Имя Тип Обязательно Описание
freelancerId integer Требуется либо freelancerId, либо freelancerUuid ID фрилансера
freelancerUuid string Требуется либо freelancerId, либо freelancerUuid UUID фрилансера (например, 8e947213-c114-41ec-a9ae-0242ac130002)

Ответ

Имя свойства Тип Описание
wallets string Электронные кошельки, добавленные фрилансером
wallets.createdAt string Дата добавления
wallets.currency object Валюта
wallets.currency.currency string Название валюты
wallets.currency.id integer ID валюты
wallets.id integer ID электронного кошелька
wallets.number string Номер электронного кошелька
wallets.status string Статус
wallets.walletType string Тип электронного кошелька. Возможные значения:
  • 3: WebMoney
.
wallets.type string Тип способа оплаты. Возможные значения:
  • 1: Банковская карта
  • 2: Электронный кошелек
  • 6: Банковский счет
.
wallets.ownerId string ID фрилансера
wallets.autoPay boolean Указывает на активацию автоматических платежей для способа оплаты.
cards string URL страницы для добавления способа оплаты
cards.createdAt string Дата добавления
cards.currency object Валюта
cards.currency.currency string Название валюты
cards.currency.id integer ID валюты
cards.expire string Дата истечения срока действия карты
cards.holder string Имя и фамилия держателя карты
cards.id string ID карты
cards.number string Номер карты (возвращаются первые 6 и последние 4 цифры)
cards.status string Статус. Возможные значения:
  • 1: Процесс привязки карты начат
  • 3: Карта заблокирована
  • 4: Карта добавлена и проверена
  • 7: Карта удалена
.
cards.cardType string Тип банковской карты. Возможные значения:
  • 1: Visa
  • 2: Mastercard
  • 3: Maestro
  • 8: Мир
  • 0: Неопределен
.
cards.type string Тип способа оплаты. Возможные значения:
  • 1: Банковская карта
  • 2: Электронный кошелек
  • 6: Банковский счет
.
cards.ownerId string ID фрилансера
cards.country string Страна происхождения банковской карты
cards.autoPay boolean Указывает на активацию автоматических платежей для способа оплаты.
iban string Банковские счета, добавленные фрилансером
iban.createdAt string Дата добавления
iban.currency object Валюта
iban.currency.currency string Название валюты
iban.currency.id integer ID валюты
iban.id integer ID банковского счета
iban.number string Номер банковского счета
iban.status string Статус. Возможные значения:
  • 3: Счет добавлен, но не проверен
  • 1: Счет проверен
  • 2: Счет удален
.
iban.bankAccountType string Тип счета. Возможные значения:
  • 1: SEPA
  • 2: SWIFT
  • 6: BIC
.
iban.type string Тип способа оплаты. Возможные значения:
  • 1: Банковская карта
  • 2: Электронный кошелек
  • 6: Банковский счет
.
iban.ownerId integer ID фрилансера
iban.autoPay boolean Указывает на активацию автоматических платежей для способа оплаты.

Добавление банковской карты

Пример запроса

curl --location 
  --request POST 'https://my.mellow.io/api/customer/freelancers/cards' \
  --data-raw '{
        "code": 583695,
        "freelancerId": 1
    }'

Пример ответа

HTTP status 200 OK

{
  "redirect": "https://link-to-payment-terminal"
}

Этот запрос используется для добавления нового способа оплаты для фрилансера. Он возвращает ссылку на страницу добавления способа оплаты. Перед вызовом запроса также необходимо запросить код, который будет отправлен на номер телефона фрилансера. Добавление нового способа оплаты происходит следующим образом:

  1. Запросить код, который будет отправлен на телефон фрилансера.
  2. Вызвать запрос на добавление способа оплаты, передав код, полученный на предыдущем этапе, в качестве входного параметра. Затем запрос возвращает ссылку на страницу, где фрилансер может ввести данные способа оплаты.
    После этого фрилансер вводит данные нового способа оплаты.

Запрос

HTTP Запрос
Тело запроса
Имя Тип Обязательно Описание
code integer Да Код, отправленный на номер телефона фрилансера
freelancerId integer Требуется либо freelancerId, либо freelancerUuid ID фрилансера
freelancerUuid string Требуется либо freelancerId, либо freelancerUuid UUID фрилансера (например, 8e947213-c114-41ec-a9ae-0242ac130002)
redirectUrl string Нет URL, на который перенаправляется фрилансер после привязки способа оплаты

Ответ

Имя свойства Тип Описание
redirect string URL страницы для добавления способа оплаты
uuid string UUID способа оплаты (например, 8e947213-c114-41ec-a9ae-0242ac130002)

Добавление банковского счета

Пример запроса

curl --location 
  --request POST 'https://my.mellow.io/api/customer/freelancers/bank-accounts' \
  --data-raw '{
        "code": 583695,
        "freelancerId": 1
    }'

Пример ответа

HTTP status 200 OK

{
  "redirect": "https://link-to-payment-terminal"
}

Этот запрос используется для добавления нового банковского счета фрилансера. Он возвращает ссылку на страницу добавления способа оплаты. Перед вызовом запроса также необходимо запросить код, который будет отправлен на номер телефона фрилансера. Добавление нового банковского счета происходит следующим образом:

  1. Запросить код, который будет отправлен на телефон фрилансера.
  2. Вызвать запрос на добавление способа оплаты, передав полученный на предыдущем этапе код в качестве входного параметра. Затем запрос возвращает ссылку на страницу, где фрилансер может ввести данные способа оплаты.
    После этого фрилансер заполняет данные нового способа оплаты.

Запрос

HTTP Запрос
Тело запроса
Имя Тип Обязательно Описание
code integer Да Код, отправленный на номер телефона фрилансера
freelancerId integer Требуется либо freelancerId, либо freelancerUuid ID фрилансера
freelancerUuid string Требуется либо freelancerId, либо freelancerUuid UUID фрилансера (например, 8e947213-c114-41ec-a9ae-0242ac130002)
bankAccountType integer Да Тип банковского счета. Возможные значения:
  • 1: Счет в стране еврозоны (SEPA)
  • 2: Счет SWIFT
  • 6: Российский банковский счет (БИК)
.
redirectUrl integer Нет URL, на который перенаправляется фрилансер после привязки способа оплаты
uuid string Нет UUID способа оплаты (например, 8e947213-c114-41ec-a9ae-0242ac130002)

Ответ

Имя свойства Тип Описание
redirect string URL страницы для добавления способа оплаты

Добавление электронного кошелька

Пример запроса

curl --location 
  --request POST 'https://my.mellow.io/api/customer/freelancers/wallets' \
  --data-raw '{
        "code": 583695,
        "freelancerId": 1
    }'

Пример ответа

HTTP status 200 OK

{
  "redirect": "https://link-to-payment-terminal"
}

Этот запрос используется для добавления нового электронного кошелька фрилансеру. Он возвращает ссылку на страницу добавления способа оплаты. Перед вызовом запроса также необходимо запросить код, который будет отправлен на номер телефона фрилансера. Добавление нового электронного кошелька происходит следующим образом:

  1. Запросить код, который будет отправлен на телефон фрилансера.
  2. Вызвать запрос на добавление способа оплаты, передав полученный на предыдущем этапе код в качестве входного параметра. Затем запрос возвращает ссылку на страницу, где фрилансер может ввести данные способа оплаты.
    После этого фрилансер вводит данные нового способа оплаты.

Запрос

HTTP запрос
Тело запроса
Имя Тип Обязательно Описание
code integer Да Код, отправленный на номер телефона фрилансера
freelancerId integer Требуется либо freelancerId, либо freelancerUuid ID фрилансера
freelancerUuid string Требуется либо freelancerId, либо freelancerUuid UUID фрилансера (например, 8e947213-c114-41ec-a9ae-0242ac130002)
walletType integer Да Тип электронного кошелька. Возможные значения:
  • 3: WebMoney
redirectUrl integer Нет URL, на который перенаправляется фрилансер после привязки способа оплаты

Ответ

Имя свойства Тип Описание
redirect string URL страницы для добавления способа оплаты
uuid string UUID способа оплаты (например, 8e947213-c114-41ec-a9ae-0242ac130002)

Удаление банковской карты

Пример запроса

curl --location 
  --request DELETE 'https://my.mellow.io/api/customer/freelancers/cards/123?freelancerId=123' \

Пример ответа

HTTP статус 200 OK

Этот запрос используется для удаления банковской карты.

Запрос

HTTP Запрос
Параметры пути

В качестве параметра пути необходимо передать идентификатор банковской карты.

Параметры запроса
Имя Тип Обязательно Описание
freelancerId или freelancerUuid integer Да ID или UUID фрилансера

Ответ

Успешный запрос возвращает пустой ответ.

Удаление электронного кошелька

Пример запроса

curl --location 
  --request DELETE 'https://my.mellow.io/api/customer/freelancers/wallets/123?freelancerId=123' \

Пример ответа

HTTP status 200 OK

Этот запрос используется для удаления электронного кошелька фрилансера.

Запрос

HTTP запрос
Параметры пути

В качестве параметра пути необходимо передать ID электронного кошелька.

Параметры запроса
Имя Тип Обязательно Описание
freelancerId или freelancerUuid integer Да ID или UUID фрилансера

Ответ

Успешный запрос возвращает пустой ответ.

Удаление банковского счета

Пример запроса

curl --location 
  --request DELETE 'https://my.mellow.io/api/customer/freelancers/bank-accounts/123?freelancerId=123' \

Пример ответа

HTTP status 200 OK

Этот запрос используется для удаления банковского счета фрилансера.

Запрос

HTTP запрос
Параметры пути

В качестве параметра пути необходимо передать ID банковского счета.

Параметры запроса
Имя Тип Обязательно Описание
freelancerId или freelancerUuid integer Да ID или UUID фрилансера

Ответ

Успешный запрос возвращает пустой ответ.

Запрос кода для добавления нового способа оплаты

Пример запроса

curl --location 
  --request POST 'https://my.mellow.io/api/customer/freelancers/request-code-for-new-payout-endpoint' \
  --data-raw '{
        "freelancerId": 583695
    }'

Пример ответа

HTTP status 200 OK

{
  "type": "SMS",
  "number": "412341"
}

Этот запрос используется для отправки кода подтверждения на номер телефона фрилансера. Для добавления нового способа оплаты фрилансер должен подтвердить действие.

Запрос

HTTP Запрос
Тело запроса
Имя Тип Обязательно Описание
freelancerId integer Требуется либо freelancerId, либо freelancerUuid ID фрилансера
freelancerUuid string Требуется либо freelancerId, либо freelancerUuid UUID фрилансера (например, 8e947213-c114-41ec-a9ae-0242ac130002)

Ответ

Имя свойства Тип Описание
type string Тип сообщения (SMS или Google)
number string Номер телефона фрилансера (если тип сообщения SMS)

Компания

Этот раздел описывает методы управления компанией.

Работа с несколькими компаниями в API

В Mellow одна учетная запись может включать несколько компаний.
Вы можете добавить несколько компаний в свою учетную запись, управлять их данными отдельно и автоматизировать рабочие процессы для каждой из них через API.

Все запросы API (задачи, валюты, исполнители и т.д.) выполняются в контексте определенной компании.
Вы не можете выполнять действия с данными, принадлежащими одной компании, используя контекст другой: например, вы не можете обновить или опубликовать задачу от Компании А, если контекст запроса установлен на Компанию B. Попытка сделать это приведет к ошибке. Этот контекст компании всегда требуется — либо вы устанавливаете его как вашу активную компанию, либо указываете его в каждом запросе.

API Mellow поддерживает два способа указания контекста компании, используемого для запроса:

  1. Установка активной компании (PATCH /customer/companies)

Используйте метод PATCH /customer/companies для установки компании по умолчанию.
Все последующие запросы выполняются в контексте этой компании, если вы не переопределите его с помощью x-company-id.
Этот подход подходит для работы с компаниями по одной (последовательно или изолированно).

  1. Передача x-company-id в заголовке

Добавьте заголовок x-company-id к каждому запросу:
x-company-id: {company_id}

Это позволяет вам работать с разными компаниями параллельно, без необходимости переключения активной компании или повторной аутентификации.

Получение данных о компаниях пользователя

Пример запроса

curl -X GET "https://my.mellow.io/api/customer/companies" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."

Пример ответа

HTTP status code: 200 OK

{
  "items": [
    {
      "id": 2955,
      "companyName": "Skyline Ltd",
      "brandName": "Skyline",
      "safeDealEnabled": true,
      "isDefault": true,
      "currency": {
        "currency": "USD",
        "id": 2
      }
    }
  ],
  "pagination": {
    "count": 1,
    "total": 1,
    "perPage": 20,
    "page": 1,
    "pages": 1
  }
}

Этот запрос используется для получения данных о компаниях авторизованного пользователя.

Запрос

HTTP запрос

Параметры

Дополнительные параметры запроса отсутствуют.

Ответ

Имя свойства Тип Описание
id integer ID компании
companyName string Название компании
brandName string Название проекта
safeDealEnabled boolean Указывает, включена ли функция Безопасная Сделка
isDefault boolean Указывает, является ли это компанией по умолчанию
currency object Валюта
currency.currency string Название валюты
currency.id integer ID валюты

Смена компании

Пример запроса

curl -X POST "/api/customer/companies/123/default" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."

Пример ответа

HTTP status code: 200 OK

{
  "token": "eyJhbGciOiJIUzUxMiIsI...",
  "refreshToken": "c84f18a2-c6c7-4850-be15-93f9cbaef3b3"
}

Этот запрос используется для выбора компании: если вы добавили несколько компаний в свой аккаунт, это способ выбрать одну из них. Запрос возвращает новый JWT, который должен использоваться для аутентификации всех последующих запросов.

С 9 августа 2025 года конечная точка POST /api/customer/companies/{companyId}/default заменяет предыдущую PATCH /api/customer/companies для изменения основной компании. Предыдущая конечная точка будет устаревшей на более позднюю дату.

Запрос

HTTP запрос

Параметры пути
Параметр Тип Обязательно Описание
companyId integer Да ID компании. Список доступных вам компаний возвращается с этим запросом

Ответ

Имя свойства Тип Описание
token string JWT
refreshToken string JWT, используемый для обновления токена

Получение баланса компании

Пример запроса

curl -X GET "https://my.mellow.io/api/customer/balance 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."

Пример ответа

HTTP status code: 200 OK

{
  "currency": {
    "currency": "RUB",
    "id": 1
  },
  "showVat": true,
  "balanceAmount": 1067273.53,
  "balanceAmountVat": 213454.71,
  "holdAmount": 149225.08,
  "holdAmountVat": 29845.02
}

Этот запрос используется для получения баланса компании.

Запрос

HTTP запрос

Параметры

Дополнительные параметры запроса отсутствуют.

Ответ

Имя свойства Тип Описание
currency object Валюта
currency.currency string Название валюты
currency.id integer ID валюты
showVat boolean Показывает, отображается ли НДС в задачах
balanceAmount string Баланс
balanceAmountVat string НДС с баланса
holdAmount string Заблокированная (на эскроу) сумма
holdAmountVat string НДС с заблокированной суммы

Документы

Этот раздел описывает методы управления документами.

Получение списка документов

Пример запроса

curl -X GET "https://my.mellow.io/api/customer/documents" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -H  "Content-Type: application/json"

Пример ответа

HTTP status code: 200 OK

{
  "items": [
    {
      "fileId": 252345,
      "type": 6,
      "documentId": 10743,
      "invoiceStatusId": 1,
      "reportStatusId": null,
      "amount": 100,
      "number": "2955-211126-18",
      "currency": {
        "currency": "RUB",
        "id": 1
      },
      "createdAt": "2021-11-26 04:54:39",
      "topUpBalanceDate": "-0001-11-30 00:00:00",
      "sfFileId": null
    }
}

Этот запрос используется для получения списка документов.

Запрос

HTTP запрос

Параметры запроса
Параметр Тип Обязательный Описание
filter[type] integer Нет Тип документа. Возможные значения:
  • 6: Счет-фактура
  • 7: Сертификат
filter[dateFrom] date Нет Дата начала действия документа (начало интервала)
filter[dateTo] date Нет Дата окончания действия документа (конец интервала)
sort string Нет Параметр для сортировки результатов. Возможные значения:
  • createdAt: Дата создания документа
  • id: ID документа
  • fileId: ID файла
.
direction string Нет Порядок сортировки. Возможные значения:
  • asc: Обычный (по возрастанию)
  • desc: Обратный (по убыванию)
.

Ответ

Имя свойства Тип Описание
fileId integer ID файла
type integer Тип документа. Возможные значения:
  • 6: Счет-фактура
  • 7: Сертификат
.
documentId integer ID документа
invoiceStatusId integer ID статуса счета-фактуры
reportStatusId integer ID статуса сертификата
amount string Сумма документа
number string Номер документа
currency object Валюта
currency.currency string Название валюты
currency.id string ID валюты
createdAt string Дата создания документа
topUpBalanceDate string Дата пополнения баланса
sfFileId boolean ID счета-фактуры (применяется к счетам-фактурам, созданным для операций пополнения баланса)

Загрузка документов

Пример запроса

curl -X GET "https://my.mellow.io/api/customer/documents/download" 
    -H  "accept: */*" 
    -H  "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..."
    -H  "Content-Type: application/json"

Пример ответа

HTTP status code: 200 OK

Успешный запрос возвращает пустой ответ

Этот запрос используется для загрузки документов. После вызова запроса ссылка для загрузки документа отправляется на вашу электронную почту.

Запрос

HTTP запрос

Параметры запроса
Параметр Тип Обязательный Описание
filter[type] integer Нет Тип документа. Возможные значения:
  • 6: Счет-фактура
  • 7: Сертификат
filter[dateFrom] date Нет Дата начала действия документа
filter[dateTo] date Нет Дата окончания действия документа

Ответ

Успешный запрос возвращает пустой ответ, начиная процесс отправки электронного письма, содержащего ссылку для скачивания документа (в формате ZIP).

Профиль пользователя

Этот раздел содержит запросы для работы с профилем пользователя.

Получение личных данных

Пример запроса

curl --location 
    --request POST 'https://my.mellow.io/api/profile' \

Пример ответа

HTTP status code: 200 OK

{
  "languageStringValue": "EN",
  "name": "John Doe",
  "postCode": "90210",
  "physicalAddress": "Los Angeles, Sunset Blvd 123",
  "city": "Los Angeles",
  "inn": "456456456",
  "ip": "192.168.0.1",
  "birthDate": "1985-07-12",
  "gridsSettings": "{}",
  "loginNotification": true,
  "id": 100,
  "uuid": "2b69eb5d-e0e3-11ec-95b5-fa84c4fedfee",
  "email": "[email protected]",
  "username": "[email protected]",
  "firstName": "John",
  "middleName": "",
  "lastName": "Doe",
  "regDate": "2020-10-30",
  "twoFaMethod": "sms",
  "taxationStatus": 1,
  "phone": "+1-555-5555",
  "country": "US",
  "state": null,
  "flags": 0,
  "type": "customer",
  "defaultSmsGate": null,
  "language": "EN",
  "isVerified": false,
  "specialization": null
}

Этот метод используется для получения личных данных авторизованного пользователя.

Запрос

HTTP запрос

Параметры

Дополнительные параметры запроса отсутствуют. Применимо только для авторизованных пользователей.

Ответ

Имя Тип Описание
postCode string Почтовый индекс пользователя
physicalAddress string Адрес пользователя
city string Город
inn string ИНН (идентификационный номер налогоплательщика, применимо для пользователей в России)
ip string Разрешенные IP-адреса
birthDate string Дата рождения
gridsSettings object [Системное поле] Настройки интерфейса аккаунта
id integer ID пользователя
email string Электронная почта пользователя
username string Логин пользователя
firstName string Имя пользователя
middleName string Отчество пользователя
lastName string Фамилия пользователя
regDate string Дата регистрации
twoFaMethod boolean Указывает, включена ли двухфакторная аутентификация
taxationStatus string Налоговый статус пользователя (применимо только для фрилансеров)
phone string Телефонный номер пользователя
country string Страна пользователя
state string Регион пользователя
flags string [Системное поле]
type string [Системное поле] Тип пользователя (клиент или фрилансер)
language string Язык интерфейса пользователя
isVerified string Указывает, верифицирован ли пользователь (применимо только для фрилансеров)

Смена языка

Пример запроса

curl -X PUT "https://my.mellow.io/api/profile/language" \
    -H "accept: */*" \
    -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ..." \
    -H "Content-Type: application/json" \
    -d '{
          "language": "EN"
        }'

Пример ответа

HTTP status code: 200 OK

Успешный запрос должен возвращать пустой ответ.

Этот метод используется для смены языка всех сообщений, категорий задач и т.д. Доступные варианты: русский (RU) и английский (EN).

Запрос

HTTP запрос

Тело запроса

Имя Тип Обязательность Описание
language string Да Название языка. Возможные варианты:
  • EN: Английский
  • RU: Русский
.

Ответ

Успешный запрос должен вернуть пустой ответ.

Справочник

Этот раздел содержит запросы для получения различных значений разных параметров (например, валют, типов сроков и налоговых статусов).

Список валют

Пример запроса

curl --location 
  --request GET 'https://my.mellow.io/api/lookups/currencies' \

Пример ответа

HTTP status 200 OK

{
  "RUB": 1,
  "USD": 2,
  "EUR": 3
}

Этот метод используется для получения списка валют и их идентификаторов.

Запрос

HTTP запрос

Параметры

Дополнительные параметры запроса отсутствуют.

Ответ

Имя Тип Описание
<currency code> integer ID валюты

Курс валютного обмена

Пример запроса

curl --location 
  --request GET 'https://my.mellow.io/api/exchanges' \

Пример ответа

HTTP status 200 OK

[
  {
    "base": {
      "currency": "EUR",
      "id": 3
    },
    "target": {
      "currency": "RUB",
      "id": 1
    },
    "rate": 79.401
  },
  {
    "base": {
      "currency": "USD",
      "id": 2
    },
    "target": {
      "currency": "RUB",
      "id": 1
    },
    "rate": 74.329
  },
  {
    "base": {
      "currency": "EUR",
      "id": 3
    },
    "target": {
      "currency": "USD",
      "id": 2
    },
    "rate": 1.0576
  },
  {
    "base": {
      "currency": "RUB",
      "id": 1
    },
    "target": {
      "currency": "EUR",
      "id": 3
    },
    "rate": 81.8194
  },
  {
    "base": {
      "currency": "RUB",
      "id": 1
    },
    "target": {
      "currency": "USD",
      "id": 2
    },
    "rate": 76.5928
  },
  {
    "base": {
      "currency": "USD",
      "id": 2
    },
    "target": {
      "currency": "EUR",
      "id": 3
    },
    "rate": 1.0898
  }
]

Этот метод используется для получения текущего курса конверсии.

Примеры конверсий:

Валюта снятия Валюта выплаты Курс конверсии Расчёт
EUR RUB 79.401 1000 EUR * 79.401 = 79401 RUB
USD RUB 74.329 1000 USD * 74.329 = 74329 RUB
EUR USD 1.0576 1000 EUR * 1.0576 = 1057.6 USD
RUB EUR 81.8194 1000 RUB / 81.8194 = 12.23 EUR
RUB USD 76.5928 1000 RUB / 76.5928 = 13.06 USD
USD EUR 1.0898 1000 USD / 1.0898 = 917.43 EUR

Запрос

HTTP запрос

Параметры

Дополнительные параметры запроса отсутствуют.

Ответ

Имя Тип Описание
base.currency string Название базовой валюты для конвертации
base.id integer ID базовой валюты
target.currency string Название целевой валюты конвертации
target.id integer ID целевой валюты конвертации
rate float Курс конвертации

Налоговые статусы

Пример запроса

curl --location 
  --request GET 'https://my.mellow.io/api/lookups/taxation-statuses' \

Пример ответа

HTTP status 200 OK

{
  "NATURAL": 1,
  "NATURAL_TITLE": "Физическое лицо",
  "SELF_EMPLOYED": 3,
  "SELF_EMPLOYED_TITLE": "Самозанятый",
  "SOLE_PROPRIETOR": 4,
  "SOLE_PROPRIETOR_TITLE": "Индивидуальный предприниматель"
}

Этот метод используется для получения налоговых статусов и их идентификаторов.

Запрос

HTTP запрос

Параметры

Дополнительные параметры запроса отсутствуют.

Ответ

Имя Тип Описание
<Tax status> integer ID налогового статуса
<Tax status>_TITLE string Название налогового статуса

Категории задач

Пример запроса

curl --location 
  --request GET 'https://my.mellow.io/api/customer/lookups/categories' \

Пример ответа

HTTP status 200 OK

{
  "items": [
    {
      "id": 1,
      "title": "Печатные СМИ",
      "titleEn": "Printed mass media"
    },
    {
      "id": 2,
      "title": "Интернет-реклама",
      "titleEn": "Internet advertising"
    }
  ]
}

Устарело с 13 октября 2025 года. Используйте услуги и атрибуты вместо этого.

Этот метод используется для получения категорий задач.

Запрос

HTTP запрос

Параметры

Дополнительные параметры запроса отсутствуют.

Ответ

Имя Тип Описание
id integer ID категории
title string Название категории задач
titleEn string Название категории задач (на английском)

Названия услуг и работ

Пример запроса

curl --location 
  --request GET 'https://my.mellow.io/api/lookups/services' \

Пример ответа

HTTP статус 200 OK

{
  "items": [
    {
      "id": 3,
      "title": "Копирайтинг",
      "titleEn": "Copywriting",
      "titleDoc": "Написание текстов статей/обзоров",
      "titleDocEn": "Сopywriting of texts of articles/reviews"
    },
    {
      "id": 2,
      "title": "Работы по созданию иллюстраций к текстам (включая фотографию)",
      "titleEn": "Work on creation of illustrations for  texts (incl. photos)",
      "titleDoc": "Работы по созданию иллюстраций (включая фотографические) к текстам статей периодического СМИ",
      "titleDocEn": "Work on creation of illustrations (incl. photos) for  texts of articles of periodic mass media"
    }
  ]
   "pagination": {
    "count": 20,
    "total": 23,
    "perPage": 9999,
    "page": 1,
    "pages": 1
  }
}

Этот метод используется для получения названий услуг и работ.

Начиная с 13 октября 2025 года, параметр пути categoryID для конечной точки /api/customer/lookups/services был удален. Запрос /api/customer/lookups/services теперь всегда возвращает список всех доступных услуг для текущей компании.

Запрос

HTTP запрос

Параметры
Имя Тип Обязательный Описание
page integer Нет Номер страницы для постраничного вывода
size integer Нет Количество элементов на странице (по умолчанию 20, максимум 500)

Ответ

Имя Тип Описание
id integer ID услуг и/или работ
title string Название услуг и/или работ
titleEn string Название услуг и/или работ (на английском)
titleDoc string Название услуг и/или работ, указанное в сертификате
titleDocEn string Название услуг и/или работ, указанное в сертификате (на английском)
pagination list Постраничный вывод
pagination.count integer Количество возвращенных элементов
pagination.total integer Общее количество доступных элементов с запрошенным фильтром
pagination.perPage integer Количество элементов на страницу
pagination.page integer Номер страницы
pagination.pages integer Всего страниц

Атрибуты задач

Пример запроса

curl --location 
  --request GET 'https://my.mellow.io/api/lookups/service-attributes' \

Пример ответа

HTTP статус 200 OK

{
  "items": [
    {
      "id": 6,
      "title": "Наименование СМИ",
      "titleEn": "Name of mass media",
      "type": "text"
    },
    {
      "id": 9,
      "title": "Номер издания",
      "titleEn": "Issue",
      "type": "text"
    },
    {
    "id": 31,
    "title": "Формат видео",
    "titleEn": "Video format",
    "type": "select",
    "attrTypeId": 11,
    "options": [
      {
        "id": 26,
        "value": "SD",
        "valueEn": "SD"
      },
      {
        "id": 27,
        "value": "HD",
        "valueEn": "HD"
      },
      {
        "id": 29,
        "value": "FullHD",
        "valueEn": "FullHD"
      },
      {
        "id": 28,
        "value": "UHD",
        "valueEn": "UHD"
      },
      {
        "id": 30,
        "value": "4K",
        "valueEn": "4K"
      }
    ]
  },
  ],
 "pagination": {
    "count": 20,
    "total": 23,
    "perPage": 9999,
    "page": 1,
    "pages": 1
  }
}

Этот метод возвращает все доступные атрибуты задач для компании.

Начиная с 13 октября 2025 года, параметры пути для конечной точки /api/lookups/service-attributes были удалены. Запрос GET /api/lookups/service-attributes всегда возвращает полный список всех доступных атрибутов задач для текущей компании. Параметры пути не требуются.

Запрос

HTTP запрос

Параметры
Имя Тип Обязательно Описание
id integer Да ID услуги
page integer Нет Номер страницы для пагинации
size integer Нет Количество элементов на странице (по умолчанию 20, максимум 500)

Ответ

Имя Тип Описание
items list Список элементов
items.id integer ID атрибута
items.title string Название атрибута
items.titleEn string Название атрибута (на английском)
items.attrTypeId integer ID типа атрибута
options object Значения атрибутов (для типа "select")
options.id integer ID значения
options.value string Текст
options.valueEn string Текст на английском
pagination list Постраничный вывод
pagination.count integer Количество возвращенных элементов
pagination.total integer Общее количество элементов, доступных с запрошенным фильтром
pagination.perPage integer Количество элементов на странице
pagination.page integer Номер страницы
pagination.pages integer Общее количество страниц

Дополнительные документы для принятия задания

Пример запроса

curl --location 
  --request GET 'https://my.mellow.io/api/customer/lookups/acceptance-files' \

Пример ответа

HTTP status 200 OK

{
  "items": [
    {
      "id": 1049,
      "fileId": 123,
      "title": "Соглашение о неразглашении (NDA)",
      "titleEn": "Non-disclosure agreement"
    }
  ]
}

Этот метод используется для получения списка документов, которые фрилансер должен принять перед началом работы над заданиями. В их число входят NDA и другие документы. Для загрузки такого документа на сервис, пожалуйста, свяжитесь со службой поддержки.

Запрос

HTTP запрос

Параметры

Дополнительные параметры запроса отсутствуют.

Ответ

Имя Тип Описание
id integer ID документа
fileId integer ID файла документа
title string Название документа
titleEn string Название документа (на английском)

Специализации фрилансеров

Пример запроса

curl --location 
  --request GET 'https://my.mellow.io/api/lookups/specializations' \

Пример ответа

HTTP status 200 OK

{
  "items": [
    {
      "id": 1049,
      "title": "Латвия"
    }
  ]
}

Метод используется для получения специализаций фрилансера.

Запрос

HTTP запрос

Параметры

Дополнительные параметры запроса отсутствуют.

Ответ

Имя Тип Описание
id integer ID специализации
title string Название специализации
titleEn string Название специализации (на английском)

Коды стран

Пример запроса

curl --location 
  --request GET 'https://my.mellow.io/api/customer/ord/get-arccw-codes' \

Пример ответа

HTTP status 200 OK

{
  "items": [
    {
      "id": 1049,
      "title": "Латвия"
    }
  ]
}

Этот метод используется для получения списка стран и их идентификаторов из Общероссийского классификатора стран мира (ОКСМ).

Запрос

HTTP запрос

Параметры

Дополнительные параметры запроса отсутствуют.

Ответ

Имя Тип Описание
id integer ID страны
title string Название страны

Получение типов налоговых документов

Пример запроса

curl --location \
  --request GET 'https://my.mellow.io/api/customer/get-tax-document-types?taxResidenceCountry=AU'

Пример ответа

HTTP status code: 200 OK

[
  {
    "country": "AU",
    "type": "TFN",
    "regexp": "^[0-9]{8,9}$",
    "typeTitle": "Tax File Number",
    "isMandatory": false
  }
]

Этот метод извлекает список всех доступных налоговых документов для клиентов. Если параметр taxResidenceCountry указан, ответ включает документы, доступные только для указанной страны.

Запрос

HTTP Запрос
Параметры
Параметр Тип Обязательный Описание
taxResidenceCountry string Нет Двухбуквенный код страны для фильтрации документов по стране

Ответ

Свойство Тип Описание
country string Двухбуквенный код страны
type string Код типа налогового документа
regexp string Регулярное выражение для проверки кода документа
typeTitle string Название типа налогового документа
isMandatory boolean Указывает, является ли документ обязательным

WebHooks

Webhooks — это сообщения, которые уведомляют сервисы о событиях внутри Mellow. Вы можете добавить пользовательский URL, куда будут отправляться все уведомления о событиях. Используйте этот запрос для добавления такого URL. После этого вы можете настроить его таким образом, чтобы обрабатывались только необходимые полученные события. Mellow всегда отправляет все уведомления о событиях на добавленный вами URL, и вы можете фильтровать эти события по желанию (поле name поможет вам определить тип события).

Доступные события:

Пример сообщения, отправляемого на указанный URL:

{  
  "timestamp": 1674539549,
  "name": "cardAdded",
  "payload": {
    "ownerId": 6,
    "id": 11
  }
}

Параметры:

Событие Описание Полезная нагрузка
bankAccountAdded Добавлен банковский счет id - UUID банковского счета, ownerId - ID фрилансера, uuid - UUID банковского счета
bankAccountRemoved Банковский счет удален id - UUID банковского счета, ownerId - ID фрилансера, uuid - UUID банковского счета
cardAdded Добавлен способ оплаты (банковская карта) id - UUID карты, ownerId - ID фрилансера, uuid - UUID карты
cardRemoved Способ оплаты (банковская карта) удален id - UUID карты, ownerId - ID фрилансера, uuid - UUID карты
walletAdded Кошелек добавлен id - UUID кошелька, ownerId - ID фрилансера, uuid - UUID кошелька
walletRemoved Кошелек удален id - UUID кошелька, ownerId - ID фрилансера, uuid - UUID кошелька
freelancerRegistered Фрилансер зарегистрирован (webhook срабатывает после того, как фрилансер завершает начальный этап регистрации аккаунта — это происходит, когда пользователь устанавливает пароль и подтверждает свою электронную почту по ссылке регистрации) uuid - UUID фрилансера
freelancerVerified Фрилансер успешно проверен uuid - UUID фрилансера
taxationStatusChanged Изменен налоговый статус фрилансера uuid - UUID фрилансера, taxationStatusId - ID нового налогового статуса

Каждый запрос содержит специальный заголовок X-Sign с подписью. Подпись выглядит как sha256(body . secret), где:

Если у вас несколько компаний, настройка webhook для каждой требует перехода в компанию и вызова запроса на создание webhook.

Если клиент не отвечает (или отвечает с HTTP-кодом, отличным от 200), Mellow будет продолжать пытаться отправить уведомление в течение следующих 24 часов.

Получение вебхука

Пример запроса

curl --location 
  --request GET 'https://my.mellow.io/api/customer/web-hook' \

Пример ответа

HTTP статус 200 OK

{
  "url": "https://webhook.site/588190fc-47d6-47f2-bded-17216bfe6e92",
  "status": "enabled",
  "secret": "bb940556f36a5ae58063f151e51f5318",
  "lastTriggered": null,
  "lastError": null
}

Этот метод используется для получения информации о вебхуке.

Запрос

HTTP запрос

Параметры

Дополнительные параметры запроса отсутствуют.

Ответ

Имя Тип Описание
url string Целевой URL для уведомлений
status string Статус. Доступные варианты:
  • enabled: Включено
  • disabled: Отключено
.
secret string Секретный ключ, который должен быть включен в каждое уведомление
lastTriggered string Указывает, когда было отправлено последнее уведомление
lastError string Указывает, когда последнее уведомление не удалось доставить

Создание или обновление веб-хука

Пример запроса

curl --location 
  --request POST 'https://my.mellow.io/api/customer/web-hook' \
  --data-raw '{
        "status" : "enabled",
        "url" : "https://test.com"
    }'

Пример ответа

HTTP status 200 OK

Этот метод используется для добавления или обновления веб-хука. Другими словами, вы добавляете URL, на который будут отправляться все события (например, добавление или удаление способа оплаты фрилансера). Чтобы включить или отключить отправку уведомлений о событиях, передайте соответственно enabled или disabled в status.

Запрос

HTTP запрос

Параметры

Имя Тип Обязательность Описание
status string Да Статус. Доступные варианты:
  • enabled: Включено
  • disabled: Отключено
.
url string Да Целевой URL для уведомлений

Ответ

Успешный запрос возвращает пустой ответ.

Удаление вебхука

Пример запроса

curl --location 
  --request DELETE 'https://my.mellow.io/api/customer/web-hook' \
  --data-raw '{
        "status" : "enabled",
        "url" : "https://test.com"
    }'

Пример ответа

HTTP status 200 OK

Этот метод используется для удаления вебхуков.

Запрос

HTTP запрос

Параметры

Дополнительные параметры запроса отсутствуют.

Ответ

Успешный запрос возвращает пустой ответ.

Коллекция запросов Postman

API Mellow поддерживает предварительно созданные коллекции запросов Postman. Эти коллекции содержат краткие инструкции по использованию переменных и отправке запросов в Postman.

Запустить в Postman

Чтобы использовать коллекцию запросов Postman:

Шаг 1
Откройте коллекцию запросов Postman.

Шаг 2
Нажмите Создать копию коллекции, чтобы скопировать коллекцию запросов в ваше рабочее пространство Postman.

В открывшемся окне укажите название копии коллекции и рабочее пространство, где эта копия будет создана. Отметьте "Следить за оригинальной коллекцией", если хотите получать уведомления об изменениях в оригинальной коллекции запросов.

Введите название и выберите рабочее пространство.
Введите название и выберите рабочее пространство.

Шаг 3
Перейдите к запросу токена и укажите свои данные авторизации.

Данные авторизации
Данные авторизации

Шаг 4
Перейдите в настройки коллекции -> Авторизация и скопируйте полученный токен.

Скопировать токен

Примечания к выпуску

Октябрь 2025

Изменено:

Август 2025

Изменено:

Июнь 2025

Добавлено:

Август 2024

Добавлено:

Июнь 2024

Добавлено:

Апрель 2024

Добавлено:

Ноябрь 2023

Добавлено:

Октябрь 2023

Добавлено:

Август 2023

Добавлено:

Июль 2023

Добавлено: