Skip to content

One API key with the calls rejected since it expired

GET
/api/v1/workspaces/{workspace}/api-keys/{keyId}
curl --request GET \
--url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/api-keys/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>'

Permission: apikeys:manage (sensitive)

workspace
required

Workspace slug

string
/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

keyId
required
string format: uuid

OK

Media typeapplication/json
object
createdAt
required
string format: date-time
createdBy
required
object
avatarColor
required
string
id
string
name
required
string
description
required

Client label for agents (Claude Desktop)

string
expiresAt
string format: date-time
id
required
string
kind
required
string
Allowed values: api_key mcp_agent
lastCall
string
lastUsedAt
string format: date-time
lastUsedClient
string
lastUsedIp
string
masked
required
string
name
required
string
permissions
required
Array<string>
rejections
object
calls
required

In the last 7 days

integer format: int64
client

Client label of that address

string
ip

Busiest client address

string
since

First rejected call

string format: date-time
scope
required
object
all
required
boolean
label
required
string
lists
required
Array<object>
object
id
required
string
name
required
string
senderDomains
required
Array<string>
sensitive
required

The ⚑ permissions among them

Array<string>
status
required
string
Allowed values: active expired
transactional
object
categories
required

Categories it may send (SMTP credentials); empty for all

Array<object>
object
id
required
string
name
required
string
mode
required
string
Allowed values: live test
preset
required
string
Allowed values: send_only smtp
ratePerSecond
required
integer format: int64
templates
required

Template IDs it may send; empty for all, including ones published later

Array<string>
testAddresses
required

Allowed test addresses besides the members (qa+*@acme.io)

Array<string>
username
string

Example

{
"kind": "api_key",
"masked": "rc_live_8f2c…a91d",
"status": "active",
"transactional": {
"mode": "live",
"preset": "send_only"
}
}

Error

Media typeapplication/problem+json
object
code

Stable error code, e.g. permission_denied

string
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object>
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

helpers

Members who hold the missing permission

Array<string>
instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
meta
object
key
additional properties
permission

The missing permission key

string
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank

Example

{
"detail": "Property foo is required but is missing.",
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "about:blank"
}