List Public-Key Credentials

GET

/v0/api-keys/public-keys

GET

/v0/api-keys/public-keys

1 from agentmail import AgentMail
2 
3 client = AgentMail(
4     api_key="YOUR_TOKEN_HERE",
5 )
6 
7 client.api_keys.list_public_keys()

200Retrieved

1 {
2   "count": 1,
3   "public_keys": [
4     {
5       "api_key_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
6       "type": "public_key",
7       "name": "name",
8       "public_key": {
9         "jwk": {
10           "kty": "EC",
11           "crv": "P-256",
12           "x": "blackcurrant...............................",
13           "y": "blackcurrant..............................."
14         },
15         "fingerprint": "blackcurrant..............................."
16       },
17       "scope": {
18         "type": "organization"
19       },
20       "created_at": "2024-01-15T09:30:00Z",
21       "updated_at": "2024-01-15T09:30:00Z",
22       "expires_at": "2024-01-15T09:30:00Z",
23       "revoked_at": "2024-01-15T09:30:00Z"
24     },
25     {
26       "api_key_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
27       "type": "public_key",
28       "name": "name",
29       "public_key": {
30         "jwk": {
31           "kty": "EC",
32           "crv": "P-256",
33           "x": "blackcurrant...............................",
34           "y": "blackcurrant..............................."
35         },
36         "fingerprint": "blackcurrant..............................."
37       },
38       "scope": {
39         "type": "organization"
40       },
41       "created_at": "2024-01-15T09:30:00Z",
42       "updated_at": "2024-01-15T09:30:00Z",
43       "expires_at": "2024-01-15T09:30:00Z",
44       "revoked_at": "2024-01-15T09:30:00Z"
45     }
46   ],
47   "next_page_token": "next_page_token"
48 }

List only public-key credentials visible to the bearer caller’s scope. Bearer credentials are never returned, even though both credential types share storage and pagination indexes. Requires api_key_read.

Authentication

AuthorizationBearer

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

Query parameters

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.

public_keyslist of objects

Public-key credentials only, ordered by creation time descending by default.

next_page_tokenstringOptional

Page token for pagination.