Список API-ключей

GET

/v0/inboxes/:inbox_id/api-keys

GET

/v0/inboxes/:inbox_id/api-keys

1 from agent_inbox import Agentinbox
2 
3 client = Agentinbox(
4     api_key="YOUR_API_KEY_HERE",
5 )
6 
7 client.inboxes.api_keys.list(
8     inbox_id="inbox_id",
9 )

1 {
2   "count": 1,
3   "api_keys": [
4     {
5       "api_key_id": "api_key_id",
6       "prefix": "prefix",
7       "name": "name",
8       "created_at": "2024-01-15T09:30:00Z",
9       "pod_id": "pod_id",
10       "inbox_id": "inbox_id",
11       "used_at": "2024-01-15T09:30:00Z",
12       "permissions": {
13         "inbox_read": true,
14         "inbox_create": true,
15         "inbox_update": true,
16         "inbox_delete": true,
17         "thread_read": true,
18         "thread_delete": true,
19         "message_read": true,
20         "message_send": true,
21         "message_update": true,
22         "label_spam_read": true,
23         "label_blocked_read": true,
24         "label_trash_read": true,
25         "draft_read": true,
26         "draft_create": true,
27         "draft_update": true,
28         "draft_delete": true,
29         "draft_send": true,
30         "webhook_read": true,
31         "webhook_create": true,
32         "webhook_update": true,
33         "webhook_delete": true,
34         "domain_read": true,
35         "domain_create": true,
36         "domain_update": true,
37         "domain_delete": true,
38         "list_entry_read": true,
39         "list_entry_create": true,
40         "list_entry_delete": true,
41         "metrics_read": true,
42         "api_key_read": true,
43         "api_key_create": true,
44         "api_key_delete": true,
45         "pod_read": true,
46         "pod_create": true,
47         "pod_delete": true
48       }
49     },
50     {
51       "api_key_id": "api_key_id",
52       "prefix": "prefix",
53       "name": "name",
54       "created_at": "2024-01-15T09:30:00Z",
55       "pod_id": "pod_id",
56       "inbox_id": "inbox_id",
57       "used_at": "2024-01-15T09:30:00Z",
58       "permissions": {
59         "inbox_read": true,
60         "inbox_create": true,
61         "inbox_update": true,
62         "inbox_delete": true,
63         "thread_read": true,
64         "thread_delete": true,
65         "message_read": true,
66         "message_send": true,
67         "message_update": true,
68         "label_spam_read": true,
69         "label_blocked_read": true,
70         "label_trash_read": true,
71         "draft_read": true,
72         "draft_create": true,
73         "draft_update": true,
74         "draft_delete": true,
75         "draft_send": true,
76         "webhook_read": true,
77         "webhook_create": true,
78         "webhook_update": true,
79         "webhook_delete": true,
80         "domain_read": true,
81         "domain_create": true,
82         "domain_update": true,
83         "domain_delete": true,
84         "list_entry_read": true,
85         "list_entry_create": true,
86         "list_entry_delete": true,
87         "metrics_read": true,
88         "api_key_read": true,
89         "api_key_create": true,
90         "api_key_delete": true,
91         "pod_read": true,
92         "pod_create": true,
93         "pod_delete": true
94       }
95     }
96   ],
97   "next_page_token": "next_page_token"
98 }

CLI:

$ agentinbox inboxes:api-keys list --inbox-id <inbox_id>

**CLI:** ```bash agentinbox inboxes:api-keys list --inbox-id <inbox_id> ```

Authentication

AuthorizationBearer

Header authentication of the form Bearer <token>

Path parameters

inbox_idstringRequired

Идентификатор ящика.

Query parameters

limitintegerOptional

Максимальное число возвращаемых элементов.

page_tokenstringOptional

Токен страницы для постраничной выборки.

Response

This endpoint returns an object.

countinteger

Число возвращённых элементов.

api_keyslist of objects

Упорядочено по created_at по убыванию.

next_page_tokenstring

Токен страницы для постраничной выборки.

Errors

404

Not Found Error