List api keys

GET

https://api.schematichq.com/api-keys

GET

/api-keys

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 async function main() {
4     const client = new SchematicClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.accounts.listApiKeys({
8         requireEnvironment: true,
9     });
10 }
11 main();

1 {
2   "data": [
3     {
4       "created_at": "2024-01-15T09:30:00Z",
5       "id": "api_key_7890abcd",
6       "name": "Dev API Key",
7       "readonly": true,
8       "scopes": [
9         "admin",
10         "read",
11         "write"
12       ],
13       "updated_at": "2024-04-01T10:00:00Z",
14       "description": "Key for accessing development environment APIs",
15       "environment": {
16         "created_at": "2023-12-01T08:00:00Z",
17         "environment_type": "development",
18         "id": "env_dev_123456",
19         "name": "Development Environment",
20         "updated_at": "2024-01-10T12:00:00Z"
21       },
22       "environment_id": "env_dev_123456",
23       "integration": {
24         "id": "intg_4567efgh",
25         "state": "active",
26         "type": "clerk"
27       },
28       "last_used_at": "2024-04-20T15:45:00Z"
29     }
30   ],
31   "params": {
32     "environment_id": "env_dev_123456",
33     "limit": 100,
34     "offset": 0,
35     "require_environment": true
36   }
37 }

List api keys

List api keys

Authentication

Query parameters

Response

Errors

Authentication

Query parameters

Response

Errors

1	import { SchematicClient } from "@schematichq/schematic-typescript-node";
2
3	async function main() {
4	const client = new SchematicClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.accounts.listApiKeys({
8	requireEnvironment: true,
9	});
10	}
11	main();

1	{
2	"data": [
3	{
4	"created_at": "2024-01-15T09:30:00Z",
5	"id": "api_key_7890abcd",
6	"name": "Dev API Key",
7	"readonly": true,
8	"scopes": [
9	"admin",
10	"read",
11	"write"
12	],
13	"updated_at": "2024-04-01T10:00:00Z",
14	"description": "Key for accessing development environment APIs",
15	"environment": {
16	"created_at": "2023-12-01T08:00:00Z",
17	"environment_type": "development",
18	"id": "env_dev_123456",
19	"name": "Development Environment",
20	"updated_at": "2024-01-10T12:00:00Z"
21	},
22	"environment_id": "env_dev_123456",
23	"integration": {
24	"id": "intg_4567efgh",
25	"state": "active",
26	"type": "clerk"
27	},
28	"last_used_at": "2024-04-20T15:45:00Z"
29	}
30	],
31	"params": {
32	"environment_id": "env_dev_123456",
33	"limit": 100,
34	"offset": 0,
35	"require_environment": true
36	}
37	}