partner/account/keys/retrieve

This endpoint allows a partner to fetch a single API key and its secret for one of its accounts from the Partner Portal. A portal user who was removed from the partner or deactivated is refused with INVALID_ACCESS even with a still-valid token. Partner Portal session only: the request must carry the Partner Portal bearer token of a user with the Admin role, and the partner must have AccountCredentialsAccess. The account must be an Active account or sub-account of the partner (or, when PartnerCreationEnabled is on, of one of its child partners). Returns RESOURCE_NOT_FOUND when it is not. Retrieve, add, edit and delete are recorded in an audit log with the Partner Portal user, and the request fails if the entry cannot be written. A key that belongs to another target is refused with INVALID_ACCESS, and a deleted key with RESOURCE_NOT_FOUND.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

The APIAccountID of the account or sub-account

integer
required

The ID of the key, from the list endpoint

Headers
string
required

Bearer token of the Partner Portal session

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json