List API Keys | AgentMail

{
  "count": 1,
  "api_keys": [
    {
      "type": "bearer",
      "api_key_id": "api_key_id",
      "prefix": "prefix",
      "name": "name",
      "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,
        "message_read": true,
        "message_send": true,
        "message_update": true,
        "message_delete": true,
        "label_spam_read": true,
        "label_blocked_read": true,
        "label_unauthenticated_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_update": true,
        "api_key_delete": true,
        "provider_connect": true,
        "provider_share_owner": true,
        "account_update": true,
        "pod_read": true,
        "pod_create": true,
        "pod_delete": true
      },
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "expires_at": "2024-01-15T09:30:00Z"
    },
    {
      "type": "bearer",
      "api_key_id": "api_key_id",
      "prefix": "prefix",
      "name": "name",
      "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,
        "message_read": true,
        "message_send": true,
        "message_update": true,
        "message_delete": true,
        "label_spam_read": true,
        "label_blocked_read": true,
        "label_unauthenticated_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_update": true,
        "api_key_delete": true,
        "provider_connect": true,
        "provider_share_owner": true,
        "account_update": true,
        "pod_read": true,
        "pod_create": true,
        "pod_delete": true
      },
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "expires_at": "2024-01-15T09:30:00Z"
    }
  ],
  "next_page_token": "next_page_token"
}

Lists every credential, newest first. Filter one family with type. Page to token exhaustion: a page can be empty and still carry a next_page_token.

CLI:

agentmail api-keys list

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

typeenumOptional

Restrict the list to one credential family. Omit for every family.

Allowed values:

limitintegerOptional

Limit of number of items returned.

page_tokenstringOptional

Page token for pagination.

ascendingbooleanOptional

Sort in ascending temporal order.

Response

This endpoint returns an object.

countinteger

Number of items returned.

api_keyslist of objects

Every credential family, ordered by created_at. type restricts to one family.

next_page_tokenstringOptional

Page token for pagination.