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

GET

/v0/api-keys

GET

/v0/api-keys

from agent_inbox import Agentinbox
client = Agentinbox(
    api_key="YOUR_API_KEY_HERE",
)
client.api_keys.list()

200Retrieved

{
  "count": 1,
  "api_keys": [
    {
      "api_key_id": "api_key_id",
      "prefix": "prefix",
      "name": "name",
      "created_at": "2024-01-15T09:30:00Z",
      "pod_id": "pod_id",
      "inbox_id": "inbox_id",
      "used_at": "2024-01-15T09:30:00Z",
      "permissions": {
        "inbox_read": true,
        "inbox_create": true,
        "inbox_update": true,
        "inbox_delete": true,
        "thread_read": true,
        "thread_delete": true,
        "message_read": true,
        "message_send": true,
        "message_update": true,
        "label_spam_read": true,
        "label_blocked_read": true,
        "label_trash_read": true,
        "draft_read": true,
        "draft_create": true,
        "draft_update": true,
        "draft_delete": true,
        "draft_send": true,
        "webhook_read": true,
        "webhook_create": true,
        "webhook_update": true,
        "webhook_delete": true,
        "domain_read": true,
        "domain_create": true,
        "domain_update": true,
        "domain_delete": true,
        "list_entry_read": true,
        "list_entry_create": true,
        "list_entry_delete": true,
        "metrics_read": true,
        "api_key_read": true,
        "api_key_create": true,
        "api_key_delete": true,
        "pod_read": true,
        "pod_create": true,
        "pod_delete": true
      }
    },
    {
      "api_key_id": "api_key_id",
      "prefix": "prefix",
      "name": "name",
      "created_at": "2024-01-15T09:30:00Z",
      "pod_id": "pod_id",
      "inbox_id": "inbox_id",
      "used_at": "2024-01-15T09:30:00Z",
      "permissions": {
        "inbox_read": true,
        "inbox_create": true,
        "inbox_update": true,
        "inbox_delete": true,
        "thread_read": true,
        "thread_delete": true,
        "message_read": true,
        "message_send": true,
        "message_update": true,
        "label_spam_read": true,
        "label_blocked_read": true,
        "label_trash_read": true,
        "draft_read": true,
        "draft_create": true,
        "draft_update": true,
        "draft_delete": true,
        "draft_send": true,
        "webhook_read": true,
        "webhook_create": true,
        "webhook_update": true,
        "webhook_delete": true,
        "domain_read": true,
        "domain_create": true,
        "domain_update": true,
        "domain_delete": true,
        "list_entry_read": true,
        "list_entry_create": true,
        "list_entry_delete": true,
        "metrics_read": true,
        "api_key_read": true,
        "api_key_create": true,
        "api_key_delete": true,
        "pod_read": true,
        "pod_create": true,
        "pod_delete": true
      }
    }
  ],
  "next_page_token": "next_page_token"
}

CLI:

agentinbox api-keys list

Authentication

AuthorizationBearer

Header authentication of the form Bearer <token>

Query parameters

limitintegerOptional

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

page_tokenstringOptional

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

ascendingbooleanOptional

Сортировать по времени по возрастанию.

Response

This endpoint returns an object.

countinteger

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

api_keyslist of objects

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

next_page_tokenstringOptional

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