List received account shares
curl --request POST \
--url https://app.gtm-api.com/id/v4/api/account-shares/list-received \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"filter": {
"sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"channel": {
"in": []
},
"status": {
"in": [],
"nin": []
},
"to_team_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"to_user_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"owner_account_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"holder_account_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"holder_over_slot": {
"eq": true
},
"end_reason": {
"in": [],
"is_null": true
},
"failure_reason": {
"in": [],
"is_null": true
},
"owner_cluster_id": {
"eq": 123,
"in": [
123
]
},
"holder_cluster_id": {
"eq": 123,
"in": [
123
]
},
"phase_claimed_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": true
},
"planned_return_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": true
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
}
},
"page_size": 100,
"cursor": "<string>"
}
'import requests
url = "https://app.gtm-api.com/id/v4/api/account-shares/list-received"
payload = {
"filter": {
"sid": {
"eq": "<string>",
"in": ["<string>"]
},
"channel": { "in": [] },
"status": {
"in": [],
"nin": []
},
"to_team_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"to_user_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"owner_account_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"holder_account_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"holder_over_slot": { "eq": True },
"end_reason": {
"in": [],
"is_null": True
},
"failure_reason": {
"in": [],
"is_null": True
},
"owner_cluster_id": {
"eq": 123,
"in": [123]
},
"holder_cluster_id": {
"eq": 123,
"in": [123]
},
"phase_claimed_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": True
},
"planned_return_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": True
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
}
},
"page_size": 100,
"cursor": "<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({
filter: {
sid: {eq: '<string>', in: ['<string>']},
channel: {in: []},
status: {in: [], nin: []},
to_team_sid: {eq: '<string>', in: ['<string>']},
to_user_sid: {eq: '<string>', in: ['<string>']},
owner_account_sid: {eq: '<string>', in: ['<string>']},
holder_account_sid: {eq: '<string>', in: ['<string>']},
holder_over_slot: {eq: true},
end_reason: {in: [], is_null: true},
failure_reason: {in: [], is_null: true},
owner_cluster_id: {eq: 123, in: [123]},
holder_cluster_id: {eq: 123, in: [123]},
phase_claimed_at: {gte: '<string>', lte: '<string>', is_null: true},
planned_return_at: {
gte: '<string>',
lte: '<string>',
gt: '<string>',
lt: '<string>',
is_null: true
},
created_at: {gte: '<string>', lte: '<string>', gt: '<string>', lt: '<string>'}
},
page_size: 100,
cursor: '<string>'
})
};
fetch('https://app.gtm-api.com/id/v4/api/account-shares/list-received', 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/list-received",
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([
'filter' => [
'sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'channel' => [
'in' => [
]
],
'status' => [
'in' => [
],
'nin' => [
]
],
'to_team_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'to_user_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'owner_account_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'holder_account_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'holder_over_slot' => [
'eq' => true
],
'end_reason' => [
'in' => [
],
'is_null' => true
],
'failure_reason' => [
'in' => [
],
'is_null' => true
],
'owner_cluster_id' => [
'eq' => 123,
'in' => [
123
]
],
'holder_cluster_id' => [
'eq' => 123,
'in' => [
123
]
],
'phase_claimed_at' => [
'gte' => '<string>',
'lte' => '<string>',
'is_null' => true
],
'planned_return_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>',
'is_null' => true
],
'created_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>'
]
],
'page_size' => 100,
'cursor' => '<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/list-received"
payload := strings.NewReader("{\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"channel\": {\n \"in\": []\n },\n \"status\": {\n \"in\": [],\n \"nin\": []\n },\n \"to_team_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"to_user_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"owner_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"holder_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"holder_over_slot\": {\n \"eq\": true\n },\n \"end_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"failure_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"owner_cluster_id\": {\n \"eq\": 123,\n \"in\": [\n 123\n ]\n },\n \"holder_cluster_id\": {\n \"eq\": 123,\n \"in\": [\n 123\n ]\n },\n \"phase_claimed_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"planned_return_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n }\n },\n \"page_size\": 100,\n \"cursor\": \"<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/list-received")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"channel\": {\n \"in\": []\n },\n \"status\": {\n \"in\": [],\n \"nin\": []\n },\n \"to_team_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"to_user_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"owner_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"holder_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"holder_over_slot\": {\n \"eq\": true\n },\n \"end_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"failure_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"owner_cluster_id\": {\n \"eq\": 123,\n \"in\": [\n 123\n ]\n },\n \"holder_cluster_id\": {\n \"eq\": 123,\n \"in\": [\n 123\n ]\n },\n \"phase_claimed_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"planned_return_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n }\n },\n \"page_size\": 100,\n \"cursor\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gtm-api.com/id/v4/api/account-shares/list-received")
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 \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"channel\": {\n \"in\": []\n },\n \"status\": {\n \"in\": [],\n \"nin\": []\n },\n \"to_team_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"to_user_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"owner_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"holder_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"holder_over_slot\": {\n \"eq\": true\n },\n \"end_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"failure_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"owner_cluster_id\": {\n \"eq\": 123,\n \"in\": [\n 123\n ]\n },\n \"holder_cluster_id\": {\n \"eq\": 123,\n \"in\": [\n 123\n ]\n },\n \"phase_claimed_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"planned_return_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n }\n },\n \"page_size\": 100,\n \"cursor\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "search",
"items": [
{
"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>"
},
"included": {}
}
],
"pagination": {
"next_cursor": "<string>",
"has_more": true,
"total_count": 123
},
"applied_filters": {},
"includes": [
"<string>"
],
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"debug_url": "<string>"
},
"counts": {}
}{
"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
List received account shares
List the account shares your team RECEIVED: accounts on loan TO you. Reach for this whenever the question is about a BORROWED account (what did we borrow, from whom, until when, is it still active), and for search_account_shares when it is about an account your own team owns and lent out. Registered as an action route but it is a plain read, with the same envelope, filters and sorts as search. It is also the holder's only programmatic arrival signal, because the domain events fan out to the owner team alone: poll filter { status: { eq: "active" } } sorted by created_at asc. Rows belong to the owner tenant, so created_by and ended_by arrive with permissions emptied and the trace id nulled. No include[], no counts block; page_size 0 returns pagination.total_count alone. Needs can_view_account_shares.
Contract:
- MCP tool `list_received_account_shares`, registry package `mcp.id/account_shares`, mount `id.access`.
- Operation `action`, response envelope `search`.
- Flags: read only.
POST
/
api
/
account-shares
/
list-received
List received account shares
curl --request POST \
--url https://app.gtm-api.com/id/v4/api/account-shares/list-received \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"filter": {
"sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"channel": {
"in": []
},
"status": {
"in": [],
"nin": []
},
"to_team_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"to_user_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"owner_account_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"holder_account_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"holder_over_slot": {
"eq": true
},
"end_reason": {
"in": [],
"is_null": true
},
"failure_reason": {
"in": [],
"is_null": true
},
"owner_cluster_id": {
"eq": 123,
"in": [
123
]
},
"holder_cluster_id": {
"eq": 123,
"in": [
123
]
},
"phase_claimed_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": true
},
"planned_return_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": true
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
}
},
"page_size": 100,
"cursor": "<string>"
}
'import requests
url = "https://app.gtm-api.com/id/v4/api/account-shares/list-received"
payload = {
"filter": {
"sid": {
"eq": "<string>",
"in": ["<string>"]
},
"channel": { "in": [] },
"status": {
"in": [],
"nin": []
},
"to_team_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"to_user_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"owner_account_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"holder_account_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"holder_over_slot": { "eq": True },
"end_reason": {
"in": [],
"is_null": True
},
"failure_reason": {
"in": [],
"is_null": True
},
"owner_cluster_id": {
"eq": 123,
"in": [123]
},
"holder_cluster_id": {
"eq": 123,
"in": [123]
},
"phase_claimed_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": True
},
"planned_return_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": True
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
}
},
"page_size": 100,
"cursor": "<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({
filter: {
sid: {eq: '<string>', in: ['<string>']},
channel: {in: []},
status: {in: [], nin: []},
to_team_sid: {eq: '<string>', in: ['<string>']},
to_user_sid: {eq: '<string>', in: ['<string>']},
owner_account_sid: {eq: '<string>', in: ['<string>']},
holder_account_sid: {eq: '<string>', in: ['<string>']},
holder_over_slot: {eq: true},
end_reason: {in: [], is_null: true},
failure_reason: {in: [], is_null: true},
owner_cluster_id: {eq: 123, in: [123]},
holder_cluster_id: {eq: 123, in: [123]},
phase_claimed_at: {gte: '<string>', lte: '<string>', is_null: true},
planned_return_at: {
gte: '<string>',
lte: '<string>',
gt: '<string>',
lt: '<string>',
is_null: true
},
created_at: {gte: '<string>', lte: '<string>', gt: '<string>', lt: '<string>'}
},
page_size: 100,
cursor: '<string>'
})
};
fetch('https://app.gtm-api.com/id/v4/api/account-shares/list-received', 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/list-received",
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([
'filter' => [
'sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'channel' => [
'in' => [
]
],
'status' => [
'in' => [
],
'nin' => [
]
],
'to_team_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'to_user_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'owner_account_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'holder_account_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'holder_over_slot' => [
'eq' => true
],
'end_reason' => [
'in' => [
],
'is_null' => true
],
'failure_reason' => [
'in' => [
],
'is_null' => true
],
'owner_cluster_id' => [
'eq' => 123,
'in' => [
123
]
],
'holder_cluster_id' => [
'eq' => 123,
'in' => [
123
]
],
'phase_claimed_at' => [
'gte' => '<string>',
'lte' => '<string>',
'is_null' => true
],
'planned_return_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>',
'is_null' => true
],
'created_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>'
]
],
'page_size' => 100,
'cursor' => '<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/list-received"
payload := strings.NewReader("{\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"channel\": {\n \"in\": []\n },\n \"status\": {\n \"in\": [],\n \"nin\": []\n },\n \"to_team_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"to_user_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"owner_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"holder_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"holder_over_slot\": {\n \"eq\": true\n },\n \"end_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"failure_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"owner_cluster_id\": {\n \"eq\": 123,\n \"in\": [\n 123\n ]\n },\n \"holder_cluster_id\": {\n \"eq\": 123,\n \"in\": [\n 123\n ]\n },\n \"phase_claimed_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"planned_return_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n }\n },\n \"page_size\": 100,\n \"cursor\": \"<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/list-received")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"channel\": {\n \"in\": []\n },\n \"status\": {\n \"in\": [],\n \"nin\": []\n },\n \"to_team_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"to_user_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"owner_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"holder_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"holder_over_slot\": {\n \"eq\": true\n },\n \"end_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"failure_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"owner_cluster_id\": {\n \"eq\": 123,\n \"in\": [\n 123\n ]\n },\n \"holder_cluster_id\": {\n \"eq\": 123,\n \"in\": [\n 123\n ]\n },\n \"phase_claimed_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"planned_return_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n }\n },\n \"page_size\": 100,\n \"cursor\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gtm-api.com/id/v4/api/account-shares/list-received")
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 \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"channel\": {\n \"in\": []\n },\n \"status\": {\n \"in\": [],\n \"nin\": []\n },\n \"to_team_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"to_user_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"owner_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"holder_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"holder_over_slot\": {\n \"eq\": true\n },\n \"end_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"failure_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"owner_cluster_id\": {\n \"eq\": 123,\n \"in\": [\n 123\n ]\n },\n \"holder_cluster_id\": {\n \"eq\": 123,\n \"in\": [\n 123\n ]\n },\n \"phase_claimed_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"planned_return_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n }\n },\n \"page_size\": 100,\n \"cursor\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "search",
"items": [
{
"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>"
},
"included": {}
}
],
"pagination": {
"next_cursor": "<string>",
"has_more": true,
"total_count": 123
},
"applied_filters": {},
"includes": [
"<string>"
],
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"debug_url": "<string>"
},
"counts": {}
}{
"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
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 scope for tokens that do not carry one. Ignored when the token already names a team.
Body
application/json
Request body of list_received_account_shares.
Response
search success envelope.
Available options:
true Available options:
search Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I