APIリファレンス

チーム

Xアカウントのオーナーは、ほかのGemleadユーザーとアカウントを共有できます。メンバーはオーナーのプランとクレジットでアカウントを使い、何を変更できるかは役割によって項目ごとに決まります。支払いとXアカウントの接続はオーナーが管理します。

メンバーを招待・変更できるのはオーナーと管理者です。管理者を任命したり、管理者を変更したりできるのはオーナーだけです。Xアカウントのメンバーは招待中を含めて最大50人です。

設定を編集できる役割のメンバーは、自分のAPIキーを作成したり、AIアプリを接続したりできます。そのキーはメンバーの役割の範囲でのみ動作し、チームを抜けた時点で使えなくなります。

エンドポイント

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

チームオブジェクト

GemleadでXアカウントを使っている人。オーナーが先頭で、キーのユーザーがそこで何をできるかも含みます。

属性

objectstring
常にteamです。
account_idstring
XアカウントのID。アカウントオブジェクトと同じです。
your_rolestring
キーのユーザーの役割。オーナーのキーならownerです。
ownerviewersettereditoradmincustom
your_member_idstringまたはnull
メンバーとしてのキーのユーザー。オーナーならnullです。
ownerobject
Xアカウントを接続し、料金を支払っているGemleadユーザー。
membersobjectsの配列
メンバーと招待。チームメンバーオブジェクトで表します。
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/teamreadスコープMCPget_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
招待を送ったメールアドレス。
namestringまたはnull
Gemleadでの名前。チームに参加するまではnullです。
profile_image_urlstringまたはnull
プロフィール画像のURL。
rolestring
viewerはすべてを見られますが、何も変更できません。setterはチャットとリードを担当します。editorは設定以外のすべてを変更できます。adminはすべてを変更でき、チームを管理します。customは選んだ項目を変更できます。
viewersettereditoradmincustom
zonesobject
メンバーが変更できる範囲。項目ごとにviewかeditです。役割で決まり、customでは選んだ項目がそのまま使われます。
statusstring
このメールアドレスのGemleadアカウントがあればactive、それまでは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/memberswriteスコープMCPedit_team

Xアカウントのチームに、役割を指定してメールで招待し、招待メールを送ります。このメールアドレスのGemleadアカウントがあればすぐに参加し、なければそのアドレスで登録した時点で参加します。

ボディパラメーター

emailstring必須
招待する人のメールアドレス。最大200文字です。
rolestring必須
メンバーができること。チームメンバーオブジェクトのroleを参照してください。
viewersettereditoradmincustom
zonesobject
customの役割でのみ指定します。メンバーが変更できる範囲を項目ごとにviewかeditで指定します。指定しない項目はviewです。

戻り値

新しいチームメンバーオブジェクト。Gemleadアカウントがあればstatusはactive、なければinvitedです。

エラー

400parameter_missing
必須パラメーターがありません。paramにその名前が入ります。
400parameter_invalid
APIが受け付けない値のパラメーターがあります。たとえば、custom以外の役割でのzonesや、オーナー自身のメールアドレスです。paramにその名前が入ります。
400parameter_unknown
ボディに、このエンドポイントが受け付けないフィールドがあります。
403forbidden
キーのユーザーはチームを変更できません。変更できるのはオーナーと管理者で、管理者の任命や変更はオーナーだけができます。
400resource_already_exists
このメールアドレスは、メンバーか招待としてすでにチームにいます。
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_idwriteスコープMCPedit_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_idwriteスコープMCPedit_team

チームからメンバーを外すか、招待を取り消します。その人はすぐにXアカウントにアクセスできなくなります。

パスパラメーター

member_idstring必須
チームメンバーのID。

戻り値

メンバーのidと、trueに設定されたdeletedを含むオブジェクト。

エラー

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/leavewriteスコープMCPedit_team

キーのユーザーをXアカウントのチームから外します。メンバーのキーで使え、オーナーのキーでは使えません。

戻り値

メンバーのidと、trueに設定されたdeletedを含むオブジェクト。

エラー

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
}