List contact permission profile grants in a chat scope
curl --request POST \
--url http://localhost:3000/api/v1/permissions/list \
--header 'Content-Type: application/json' \
--data '
{
"chat": "<string>",
"chatTag": "<string>",
"force": true,
"limit": "<string>",
"offset": "<string>",
"profile": "<string>",
"to": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/permissions/list"
payload = {
"chat": "<string>",
"chatTag": "<string>",
"force": True,
"limit": "<string>",
"offset": "<string>",
"profile": "<string>",
"to": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
chat: '<string>',
chatTag: '<string>',
force: true,
limit: '<string>',
offset: '<string>',
profile: '<string>',
to: '<string>'
})
};
fetch('http://localhost:3000/api/v1/permissions/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/permissions/list",
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([
'chat' => '<string>',
'chatTag' => '<string>',
'force' => true,
'limit' => '<string>',
'offset' => '<string>',
'profile' => '<string>',
'to' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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 := "http://localhost:3000/api/v1/permissions/list"
payload := strings.NewReader("{\n \"chat\": \"<string>\",\n \"chatTag\": \"<string>\",\n \"force\": true,\n \"limit\": \"<string>\",\n \"offset\": \"<string>\",\n \"profile\": \"<string>\",\n \"to\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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("http://localhost:3000/api/v1/permissions/list")
.header("Content-Type", "application/json")
.body("{\n \"chat\": \"<string>\",\n \"chatTag\": \"<string>\",\n \"force\": true,\n \"limit\": \"<string>\",\n \"offset\": \"<string>\",\n \"profile\": \"<string>\",\n \"to\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/permissions/list")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"chat\": \"<string>\",\n \"chatTag\": \"<string>\",\n \"force\": true,\n \"limit\": \"<string>\",\n \"offset\": \"<string>\",\n \"profile\": \"<string>\",\n \"to\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"confirmation": {
"action": "allow",
"agents": [
"<string>"
],
"capabilities": [
"<string>"
],
"contacts": [
"<string>"
],
"dryRun": true,
"force": true,
"global": true,
"message": "<string>",
"scopes": [
"<string>"
],
"profile": "<string>"
},
"force": true,
"grants": [
{
"capabilities": [
"<string>"
],
"contact": "<string>",
"profile": "<string>",
"scope": "<string>",
"scopeType": "chat",
"source": "contact-chat-grant"
}
],
"hints": [
"<string>"
],
"overlays": [
{
"capabilities": [
"<string>"
],
"chat": "<string>",
"contact": "<string>",
"eligible": true,
"governed": true
}
],
"pagination": {
"limit": 123,
"offset": 123,
"returned": 123,
"total": 123,
"hasMore": true,
"nextCommand": "<string>",
"nextOffset": 123
},
"scopes": [
{
"label": "<string>",
"type": "chat",
"channel": "<string>",
"chatId": "<string>",
"chatTag": "<string>",
"known": true,
"requestedChatId": "<string>",
"taggedChatCount": 123,
"threadChatId": "<string>",
"title": "<string>"
}
],
"targets": [
{
"id": "<string>",
"type": "<string>"
}
],
"total": 123
}permissions
List contact permission profile grants in a chat scope
POST
/
api
/
v1
/
permissions
/
list
List contact permission profile grants in a chat scope
curl --request POST \
--url http://localhost:3000/api/v1/permissions/list \
--header 'Content-Type: application/json' \
--data '
{
"chat": "<string>",
"chatTag": "<string>",
"force": true,
"limit": "<string>",
"offset": "<string>",
"profile": "<string>",
"to": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/permissions/list"
payload = {
"chat": "<string>",
"chatTag": "<string>",
"force": True,
"limit": "<string>",
"offset": "<string>",
"profile": "<string>",
"to": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
chat: '<string>',
chatTag: '<string>',
force: true,
limit: '<string>',
offset: '<string>',
profile: '<string>',
to: '<string>'
})
};
fetch('http://localhost:3000/api/v1/permissions/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/permissions/list",
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([
'chat' => '<string>',
'chatTag' => '<string>',
'force' => true,
'limit' => '<string>',
'offset' => '<string>',
'profile' => '<string>',
'to' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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 := "http://localhost:3000/api/v1/permissions/list"
payload := strings.NewReader("{\n \"chat\": \"<string>\",\n \"chatTag\": \"<string>\",\n \"force\": true,\n \"limit\": \"<string>\",\n \"offset\": \"<string>\",\n \"profile\": \"<string>\",\n \"to\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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("http://localhost:3000/api/v1/permissions/list")
.header("Content-Type", "application/json")
.body("{\n \"chat\": \"<string>\",\n \"chatTag\": \"<string>\",\n \"force\": true,\n \"limit\": \"<string>\",\n \"offset\": \"<string>\",\n \"profile\": \"<string>\",\n \"to\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/permissions/list")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"chat\": \"<string>\",\n \"chatTag\": \"<string>\",\n \"force\": true,\n \"limit\": \"<string>\",\n \"offset\": \"<string>\",\n \"profile\": \"<string>\",\n \"to\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"confirmation": {
"action": "allow",
"agents": [
"<string>"
],
"capabilities": [
"<string>"
],
"contacts": [
"<string>"
],
"dryRun": true,
"force": true,
"global": true,
"message": "<string>",
"scopes": [
"<string>"
],
"profile": "<string>"
},
"force": true,
"grants": [
{
"capabilities": [
"<string>"
],
"contact": "<string>",
"profile": "<string>",
"scope": "<string>",
"scopeType": "chat",
"source": "contact-chat-grant"
}
],
"hints": [
"<string>"
],
"overlays": [
{
"capabilities": [
"<string>"
],
"chat": "<string>",
"contact": "<string>",
"eligible": true,
"governed": true
}
],
"pagination": {
"limit": 123,
"offset": 123,
"returned": 123,
"total": 123,
"hasMore": true,
"nextCommand": "<string>",
"nextOffset": 123
},
"scopes": [
{
"label": "<string>",
"type": "chat",
"channel": "<string>",
"chatId": "<string>",
"chatTag": "<string>",
"known": true,
"requestedChatId": "<string>",
"taggedChatCount": 123,
"threadChatId": "<string>",
"title": "<string>"
}
],
"targets": [
{
"id": "<string>",
"type": "<string>"
}
],
"total": 123
}Body
application/json
Scope contact grants to one chat (canonical chat id, platform chat id, or 'current'). Threads inherit their chat.
Scope contact grants to every chat carrying this chat tag
List global (unscoped) contact grants instead of a chat scope
Page size for grants (default: 50, max: 500)
Number of matching grants to skip (default: 0)
Only show grants for this permission profile
Optional comma-separated contact: subjects to filter by
Response
Success — body conforms to the @Returns schema.
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
Show child attributes
Show child attributes