Справочник API

Команда

Владелец аккаунта X может открыть к нему доступ другим пользователям Gemlead. Каждый участник работает с ним на тарифе и кредитах владельца, а его роль определяет, что он может менять, по разделам. Оплата и подключение аккаунта X остаются за владельцем.

Владелец и админы приглашают и меняют участников. Назначать и менять админов может только владелец. В аккаунте X не больше 50 участников, вместе с приглашениями.

Участник, чья роль позволяет менять настройки, может создать свой API-ключ или подключить ИИ-приложение. Такой ключ работает с правами роли участника, не больше, и перестаёт работать, как только он выходит из команды.

Эндпоинты

GET/v1/team
POST/v1/team/members
PATCH/v1/team/members/:member_id
DELETE/v1/team/members/:member_id
POST/v1/team/leave

Объект команды

Кто работает с аккаунтом X в Gemlead, начиная с владельца, и что пользователь ключа может там делать.

Атрибуты

objectstring
Всегда team.
account_idstring
ID аккаунта X, как в объекте аккаунта.
your_rolestring
Роль пользователя ключа. owner для ключей владельца.
ownerviewersettereditoradmincustom
your_member_idstring или null
Пользователь ключа в виде участника команды, null для владельца.
ownerobject
Пользователь Gemlead, который подключил аккаунт X и платит за него.
membersмассив objects
Участники и приглашения в виде объектов участника команды.
max_membersinteger
Максимальное число участников у аккаунта X, вместе с приглашениями.

Объект команды

{
  "object": "team",
  "account_id": "a9PzK2vRtM",
  "your_role": "owner",
  "your_member_id": null,
  "owner": {
    "name": "Alex Moreau",
    "email": "alex@acme.com",
    "profile_image_url": "https://pbs.twimg.com/profile_images/1180044592/acme_400x400.jpg"
  },
  "members": [
    {
      "id": "Tm4kQ9wZrB",
      "object": "team_member",
      "email": "sara@acme.com",
      "name": "Sara Kim",
      "profile_image_url": "https://pbs.twimg.com/profile_images/1733920571/sara_400x400.jpg",
      "role": "setter",
      "zones": {
        "personas": "view",
        "campaigns": "view",
        "chat": "edit",
        "leads": "edit",
        "settings": "view"
      },
      "status": "active",
      "created_at": "2026-09-14T09:21:05.300Z"
    },
    {
      "id": "Tm8vX2pLnC",
      "object": "team_member",
      "email": "dev@acme.com",
      "name": null,
      "profile_image_url": null,
      "role": "custom",
      "zones": {
        "personas": "edit",
        "campaigns": "view",
        "chat": "view",
        "leads": "edit",
        "settings": "view"
      },
      "status": "invited",
      "created_at": "2026-11-06T07:45:12.904Z"
    }
  ],
  "max_members": 50
}

Получение команды

GET/v1/teamПраво readMCPget_team

Возвращает владельца аккаунта X, затем каждого участника и каждое приглашение с ролью и разделами, и роль пользователя ключа.

Возвращает

Объект команды.

GET/v1/team

curl https://gemlead.ai/api/v1/team \
  -H "Authorization: Bearer $GEMLEAD_API_KEY"

Ответ200

{
  "object": "team",
  "account_id": "a9PzK2vRtM",
  "your_role": "owner",
  "your_member_id": null,
  "owner": {
    "name": "Alex Moreau",
    "email": "alex@acme.com",
    "profile_image_url": "https://pbs.twimg.com/profile_images/1180044592/acme_400x400.jpg"
  },
  "members": [
    {
      "id": "Tm4kQ9wZrB",
      "object": "team_member",
      "email": "sara@acme.com",
      "name": "Sara Kim",
      "profile_image_url": "https://pbs.twimg.com/profile_images/1733920571/sara_400x400.jpg",
      "role": "setter",
      "zones": {
        "personas": "view",
        "campaigns": "view",
        "chat": "edit",
        "leads": "edit",
        "settings": "view"
      },
      "status": "active",
      "created_at": "2026-09-14T09:21:05.300Z"
    },
    {
      "id": "Tm8vX2pLnC",
      "object": "team_member",
      "email": "dev@acme.com",
      "name": null,
      "profile_image_url": null,
      "role": "custom",
      "zones": {
        "personas": "edit",
        "campaigns": "view",
        "chat": "view",
        "leads": "edit",
        "settings": "view"
      },
      "status": "invited",
      "created_at": "2026-11-06T07:45:12.904Z"
    }
  ],
  "max_members": 50
}

Объект участника команды

Человек, которому владелец открыл доступ к аккаунту X, или ещё не принятое приглашение.

Атрибуты

idstring
Уникальный идентификатор участника.
objectstring
Всегда team_member.
emailstring
Email, на который ушло приглашение.
namestring или null
Имя участника в Gemlead. Null, пока он не присоединился.
profile_image_urlstring или null
URL его фото профиля.
rolestring
viewer видит всё и ничего не меняет. setter ведёт чат и лидов. editor меняет всё, кроме настроек. admin меняет всё и управляет командой. custom меняет выбранные вами разделы.
viewersettereditoradmincustom
zonesobject
Что участник может менять, по разделам, каждый view или edit. Их задаёт роль, а custom сохраняет выбранные вами.
statusstring
active, как только у человека есть аккаунт Gemlead с этим email, до этого invited.
invitedactive
created_atstring
Время отправки приглашения, ISO 8601.

Объект участника команды

{
  "id": "Tm4kQ9wZrB",
  "object": "team_member",
  "email": "sara@acme.com",
  "name": "Sara Kim",
  "profile_image_url": "https://pbs.twimg.com/profile_images/1733920571/sara_400x400.jpg",
  "role": "setter",
  "zones": {
    "personas": "view",
    "campaigns": "view",
    "chat": "edit",
    "leads": "edit",
    "settings": "view"
  },
  "status": "active",
  "created_at": "2026-09-14T09:21:05.300Z"
}

Приглашение участника

POST/v1/team/membersПраво writeMCPedit_team

Приглашает человека в команду аккаунта X по email, с ролью, и отправляет ему письмо. Если у человека уже есть аккаунт Gemlead с этим email, он сразу попадает в команду, иначе после регистрации с этим email.

Параметры тела

emailstringОбязательно
Email человека, до 200 символов.
rolestringОбязательно
Что может делать участник. См. role в объекте участника команды.
viewersettereditoradmincustom
zonesobject
Только с ролью custom. Что участник может менять, по разделам, для каждого view или edit. Раздел, не указанный в запросе, получает view.

Возвращает

Новый объект участника команды со status, равным active, если у человека есть аккаунт Gemlead, иначе invited.

Ошибки

400parameter_missing
Отсутствует обязательный параметр. Название параметра указано в param.
400parameter_invalid
API не принимает значение параметра, например zones с ролью, отличной от custom, или email самого владельца. Название параметра указано в param.
400parameter_unknown
В теле есть поле, которое этот эндпоинт не принимает.
403forbidden
Пользователь ключа не может менять команду. Это могут владелец и админы, а назначает или меняет админа только владелец.
400resource_already_exists
Этот email уже есть в команде, у участника или в приглашении.
400limit_reached
У аккаунта X уже 50 участников, вместе с приглашениями.

POST/v1/team/members

curl -X POST https://gemlead.ai/api/v1/team/members \
  -H "Authorization: Bearer $GEMLEAD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "dev@acme.com",
    "role": "custom",
    "zones": {
      "personas": "edit",
      "leads": "edit"
    }
  }'

Ответ200

{
  "id": "Tm8vX2pLnC",
  "object": "team_member",
  "email": "dev@acme.com",
  "name": null,
  "profile_image_url": null,
  "role": "custom",
  "zones": {
    "personas": "edit",
    "campaigns": "view",
    "chat": "view",
    "leads": "edit",
    "settings": "view"
  },
  "status": "invited",
  "created_at": "2026-11-06T07:45:12.904Z"
}

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

PATCH/v1/team/members/:member_idПраво writeMCPedit_team

Меняет роль участника или то, что он может менять, по разделам. С zones роль становится custom, и меняются только переданные разделы.

Параметры пути

member_idstringОбязательно
ID участника команды.

Параметры тела

rolestring
Что может делать участник. См. role в объекте участника команды.
viewersettereditoradmincustom
zonesobject
Разделы для изменения, каждый view или edit. Остальные остаются как есть.

Возвращает

Обновлённый объект участника команды.

Ошибки

404resource_missing
В аккаунте ключа нет участника команды с этим ID.
400parameter_invalid
API не принимает значение параметра. Название параметра указано в param.
400parameter_unknown
В теле есть поле, которое этот эндпоинт не принимает.
403forbidden
Пользователь ключа не может менять команду. Это могут владелец и админы, а назначает или меняет админа только владелец.

PATCH/v1/team/members/:member_id

curl -X PATCH \
  https://gemlead.ai/api/v1/team/members/Tm4kQ9wZrB \
  -H "Authorization: Bearer $GEMLEAD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "role": "editor"
  }'

Ответ200

{
  "id": "Tm4kQ9wZrB",
  "object": "team_member",
  "email": "sara@acme.com",
  "name": "Sara Kim",
  "profile_image_url": "https://pbs.twimg.com/profile_images/1733920571/sara_400x400.jpg",
  "role": "editor",
  "zones": {
    "personas": "edit",
    "campaigns": "edit",
    "chat": "edit",
    "leads": "edit",
    "settings": "view"
  },
  "status": "active",
  "created_at": "2026-09-14T09:21:05.300Z"
}

Удаление участника

DELETE/v1/team/members/:member_idПраво writeMCPedit_team

Удаляет участника из команды или отменяет приглашение. Человек сразу теряет доступ к аккаунту X.

Параметры пути

member_idstringОбязательно
ID участника команды.

Возвращает

Объект с id участника и deleted, равным true.

Ошибки

404resource_missing
В аккаунте ключа нет участника команды с этим ID.
403forbidden
Пользователь ключа не может менять команду. Это могут владелец и админы, а назначает или меняет админа только владелец.

DELETE/v1/team/members/:member_id

curl -X DELETE \
  https://gemlead.ai/api/v1/team/members/Tm8vX2pLnC \
  -H "Authorization: Bearer $GEMLEAD_API_KEY"

Ответ200

{
  "id": "Tm8vX2pLnC",
  "object": "team_member",
  "deleted": true
}

Выход из команды

POST/v1/team/leaveПраво writeMCPedit_team

Выводит пользователя ключа из команды аккаунта X. Работает только с ключом участника, не с ключом владельца.

Возвращает

Объект с id участника и deleted, равным true.

Ошибки

400owner_cannot_leave
Это ключ владельца. Владелец вместо этого удаляет участников.

POST/v1/team/leave

curl -X POST https://gemlead.ai/api/v1/team/leave \
  -H "Authorization: Bearer $GEMLEAD_API_KEY"

Ответ200

{
  "id": "Tm4kQ9wZrB",
  "object": "team_member",
  "deleted": true
}