Lend an account to another workspace

curl --request POST \
  --url https://app.gtm-api.com/id/v4/api/account-shares \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Team-SID: <api-key>' \
  --data '
{
  "account_sid": "<string>",
  "to_email": "jsmith@example.com",
  "to_team_sid": "<string>",
  "planned_return_at": "<string>"
}
'

import requests

url = "https://app.gtm-api.com/id/v4/api/account-shares"

payload = {
    "account_sid": "<string>",
    "to_email": "jsmith@example.com",
    "to_team_sid": "<string>",
    "planned_return_at": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Team-SID": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Team-SID': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    account_sid: '<string>',
    to_email: 'jsmith@example.com',
    to_team_sid: '<string>',
    planned_return_at: '<string>'
  })
};

fetch('https://app.gtm-api.com/id/v4/api/account-shares', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.gtm-api.com/id/v4/api/account-shares",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account_sid' => '<string>',
    'to_email' => 'jsmith@example.com',
    'to_team_sid' => '<string>',
    'planned_return_at' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Team-SID: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.gtm-api.com/id/v4/api/account-shares"

	payload := strings.NewReader("{\n  \"account_sid\": \"<string>\",\n  \"to_email\": \"jsmith@example.com\",\n  \"to_team_sid\": \"<string>\",\n  \"planned_return_at\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Team-SID", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.gtm-api.com/id/v4/api/account-shares")
  .header("Authorization", "Bearer <token>")
  .header("Team-SID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_sid\": \"<string>\",\n  \"to_email\": \"jsmith@example.com\",\n  \"to_team_sid\": \"<string>\",\n  \"planned_return_at\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.gtm-api.com/id/v4/api/account-shares")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_sid\": \"<string>\",\n  \"to_email\": \"jsmith@example.com\",\n  \"to_team_sid\": \"<string>\",\n  \"planned_return_at\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "operation": "create",
  "item": {
    "sid": "<string>",
    "team_sid": "<string>",
    "to_team_sid": "<string>",
    "to_user_sid": "<string>",
    "to_email": "<string>",
    "owner_cluster_id": 123,
    "holder_cluster_id": 123,
    "owner_account_sid": "<string>",
    "owner_channel_ref": "<string>",
    "holder_account_sid": "<string>",
    "holder_channel_ref": "<string>",
    "holder_over_slot": true,
    "planned_return_at": "<string>",
    "expiry_notified_at": "<string>",
    "phase_claimed_at": "<string>",
    "phase_attempts": 123,
    "ended_at": "<string>",
    "ended_by": {
      "actor_sid": "<string>",
      "team_sid": "<string>",
      "permissions": {},
      "request_sid": "<string>",
      "reason": "<string>"
    },
    "created_by": {
      "actor_sid": "<string>",
      "team_sid": "<string>",
      "permissions": {},
      "request_sid": "<string>",
      "reason": "<string>"
    },
    "created_at": "<string>",
    "updated_at": "<string>"
  },
  "already_exists": true,
  "meta": {
    "trace_id": "<string>",
    "span_id": "<string>",
    "timestamp": "<string>",
    "duration_ms": 1,
    "debug_url": "<string>"
  }
}

{
  "success": false,
  "error": {
    "message": "<string>",
    "recoverable": true,
    "suggestion": "<string>",
    "field_errors": {},
    "blockers": [
      {
        "type": "<string>",
        "description": "<string>",
        "entity_sid": "<string>",
        "resolution": "<string>",
        "resolution_hint": "<string>",
        "count": 123
      }
    ],
    "context": {}
  },
  "meta": {
    "trace_id": "<string>",
    "span_id": "<string>",
    "timestamp": "<string>",
    "duration_ms": 1,
    "debug_url": "<string>"
  }
}

{
  "success": false,
  "error": {
    "message": "<string>",
    "recoverable": true,
    "suggestion": "<string>",
    "field_errors": {},
    "blockers": [
      {
        "type": "<string>",
        "description": "<string>",
        "entity_sid": "<string>",
        "resolution": "<string>",
        "resolution_hint": "<string>",
        "count": 123
      }
    ],
    "context": {}
  },
  "meta": {
    "trace_id": "<string>",
    "span_id": "<string>",
    "timestamp": "<string>",
    "duration_ms": 1,
    "debug_url": "<string>"
  }
}

account_shares

Lend an account to another workspace

Lend ONE of your connected accounts to another workspace, temporarily and revocably. This is a loan, not a handover: permanent ownership transfer has no MCP tool at all. Target exactly one of to_email (resolved to that user's working team) or to_team_sid; neither, both, a bad email or a self-target is 422. account_sid is prefix agnostic (ln_ac_, em_ac_); `channel` says which service owns it. ALWAYS ASYNC: returns 201 with status pending, and the loan has NOT started. Poll search_account_shares with filter { sid: { eq } } until status is active (the holder can work) or failed (read failure_reason); rolling_back means it is being undone, so do not re-issue. holder_over_slot true means the copy landed in the holder's subscription hold and they cannot work until they upgrade; a share never fails on slots. One row is one account with no bulk arm, so N accounts is N calls. planned_return_at only emails the owner a recall link; there is no auto return. Needs can_manage_account_shares. Contract: - MCP tool `create_account_share`, registry package `mcp.id/account_shares`, mount `id.access`. - Operation `create`, response envelope `create`. - Flags: none.

POST

api

account-shares

curl --request POST \
  --url https://app.gtm-api.com/id/v4/api/account-shares \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Team-SID: <api-key>' \
  --data '
{
  "account_sid": "<string>",
  "to_email": "jsmith@example.com",
  "to_team_sid": "<string>",
  "planned_return_at": "<string>"
}
'

import requests

url = "https://app.gtm-api.com/id/v4/api/account-shares"

payload = {
    "account_sid": "<string>",
    "to_email": "jsmith@example.com",
    "to_team_sid": "<string>",
    "planned_return_at": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Team-SID": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Team-SID': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    account_sid: '<string>',
    to_email: 'jsmith@example.com',
    to_team_sid: '<string>',
    planned_return_at: '<string>'
  })
};

fetch('https://app.gtm-api.com/id/v4/api/account-shares', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.gtm-api.com/id/v4/api/account-shares",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account_sid' => '<string>',
    'to_email' => 'jsmith@example.com',
    'to_team_sid' => '<string>',
    'planned_return_at' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Team-SID: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.gtm-api.com/id/v4/api/account-shares"

	payload := strings.NewReader("{\n  \"account_sid\": \"<string>\",\n  \"to_email\": \"jsmith@example.com\",\n  \"to_team_sid\": \"<string>\",\n  \"planned_return_at\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Team-SID", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.gtm-api.com/id/v4/api/account-shares")
  .header("Authorization", "Bearer <token>")
  .header("Team-SID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_sid\": \"<string>\",\n  \"to_email\": \"jsmith@example.com\",\n  \"to_team_sid\": \"<string>\",\n  \"planned_return_at\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.gtm-api.com/id/v4/api/account-shares")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_sid\": \"<string>\",\n  \"to_email\": \"jsmith@example.com\",\n  \"to_team_sid\": \"<string>\",\n  \"planned_return_at\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "operation": "create",
  "item": {
    "sid": "<string>",
    "team_sid": "<string>",
    "to_team_sid": "<string>",
    "to_user_sid": "<string>",
    "to_email": "<string>",
    "owner_cluster_id": 123,
    "holder_cluster_id": 123,
    "owner_account_sid": "<string>",
    "owner_channel_ref": "<string>",
    "holder_account_sid": "<string>",
    "holder_channel_ref": "<string>",
    "holder_over_slot": true,
    "planned_return_at": "<string>",
    "expiry_notified_at": "<string>",
    "phase_claimed_at": "<string>",
    "phase_attempts": 123,
    "ended_at": "<string>",
    "ended_by": {
      "actor_sid": "<string>",
      "team_sid": "<string>",
      "permissions": {},
      "request_sid": "<string>",
      "reason": "<string>"
    },
    "created_by": {
      "actor_sid": "<string>",
      "team_sid": "<string>",
      "permissions": {},
      "request_sid": "<string>",
      "reason": "<string>"
    },
    "created_at": "<string>",
    "updated_at": "<string>"
  },
  "already_exists": true,
  "meta": {
    "trace_id": "<string>",
    "span_id": "<string>",
    "timestamp": "<string>",
    "duration_ms": 1,
    "debug_url": "<string>"
  }
}

{
  "success": false,
  "error": {
    "message": "<string>",
    "recoverable": true,
    "suggestion": "<string>",
    "field_errors": {},
    "blockers": [
      {
        "type": "<string>",
        "description": "<string>",
        "entity_sid": "<string>",
        "resolution": "<string>",
        "resolution_hint": "<string>",
        "count": 123
      }
    ],
    "context": {}
  },
  "meta": {
    "trace_id": "<string>",
    "span_id": "<string>",
    "timestamp": "<string>",
    "duration_ms": 1,
    "debug_url": "<string>"
  }
}

{
  "success": false,
  "error": {
    "message": "<string>",
    "recoverable": true,
    "suggestion": "<string>",
    "field_errors": {},
    "blockers": [
      {
        "type": "<string>",
        "description": "<string>",
        "entity_sid": "<string>",
        "resolution": "<string>",
        "resolution_hint": "<string>",
        "count": 123
      }
    ],
    "context": {}
  },
  "meta": {
    "trace_id": "<string>",
    "span_id": "<string>",
    "timestamp": "<string>",
    "duration_ms": 1,
    "debug_url": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID

string

header

required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of create_account_share.

channel

enum<string>

required

Which channel service owns the account you are lending.

Available options:

linkedin,

email

account_sid

string

required

The owned account to lend. Length checked only, never prefix checked: the same field names a LinkedIn account (ln_ac_), an email account (em_ac_) or a future channel's sender, and channel is what says which.

Required string length: 18

to_email

string<email>

Default targeting: the holder team is that user's working team. Exactly one of to_email or to_team_sid.

Maximum string length: 255

to_team_sid

string

Direct targeting. Exactly one of to_email or to_team_sid; it must not be your own team.

Required string length: 18

Pattern: ^ts_tm_

planned_return_at

string | null

ISO 8601 UTC. Informational only: it drives one owner reminder email with a recall link. There is NO auto return.

Response

create success envelope.

success

enum<boolean>

required

Available options:

true

operation

enum<string>

required

Available options:

create

item

object

required

Show child attributes

already_exists

boolean

required

Overview

LinkedIn API

ID and Teams API

Orchestration API

Lend an account to another workspace

Authorizations

Body

Response