GET/v1/workspace/api-keys/{keyId}/partner

Read a key's partner-API state

Whether this workspace API key holds the partner scope, how many records it has brought, when they last changed, and the changes-feed cursor a poller that had read everything would hold. What Settings → Developer draws beside the key.

Access class: workspace:admin.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

keyIdpath · stringrequired

bodyquery · nulloptional

paramsquery · objectoptional

:keyIdstringoptional

queryquery · objectoptional

Responses

200application/json

the action's answer

{
  "data": {
    "cursor": "string",
    "enabled": true,
    "keyId": "",
    "lastChangeAt": "string",
    "records": 1.5
  }
}

datarequired

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired