API Reference
API Keys
Create and manage API keys for authentication.
Create an API Key
POST
/keysCreate an API key
Request Body
| Field | Type | Description |
|---|---|---|
name* | string | |
scopes* | "links:read" | "links:write" | "apps:read" | "apps:write" | "analytics:read" | "attribution:write"[] | |
expires_at | string | Must be in the future. |
Responses
201API key created. The `raw_key` field is only returned once.
400Validation error
| Field | Type | Description |
|---|---|---|
error* | object |
List API Keys
GET
/keysList API keys
Responses
200List of API keys
| Field | Type | Description |
|---|---|---|
data | object[] |
Get an API Key
GET
/keys/{id}Get an API key
Parameters
| Name | Type | In | Description |
|---|---|---|---|
id* | string | path |
Responses
200API key details
| Field | Type | Description |
|---|---|---|
id | string | |
key_prefix | string | e.g. wl_live_ |
name | string | |
scopes | string[] | |
last_used_at | string | null | |
expires_at | string | null | |
created_at | string | |
updated_at | string |
404Not found
| Field | Type | Description |
|---|---|---|
error* | object |
Delete an API Key
DELETE
/keys/{id}Delete an API key
Parameters
| Name | Type | In | Description |
|---|---|---|---|
id* | string | path |
Responses
204Deleted
404Not found
| Field | Type | Description |
|---|---|---|
error* | object |