Sign in
Access Keys

List Access Keys

get/v1/aggregators/{raast-aggregator-id}/keys

Request

  • Base URL: https://api.getsafepay.com/raastwire
  • URL: https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/keys
  • Auth: API key in header X-SFPY-AGGREGATOR-SECRET-KEY

Path parameters

raast-aggregator-idstring required
Example:agg_2288490a-2176-4de5-b373-0ffb6f8e2e6e

The unique identifier for the aggregator

Query parameters

limitinteger
Example:10

Maximum number of records to return in the current page

offsetinteger

Number of records to skip before collecting the result set

namesstring
Example:Primary Key,Backup Key

Filter keys by a comma-separated list of name fragments

is_activestring

Filter keys by active status using true or false

Response

This response contains a paginated list of access keys linked to an aggregator

api_versionstring

The current version of the API spec

Example response

{
  "api_version": "v1",
  "data": {
    "count": 1,
    "keys": [
      {
        "id": "ak_da8f1c10-346a-4be8-895a-b6187a9a9662",
        "token": "ak_tok_fede37a6",
        "key_id": "key_live_e111f1c10",
        "aggregator_id": "agg_2288490a-2176-4de5-b373-0ffb6f8e2e6e",
        "is_active": true,
        "name": "Primary Production Key",
        "secret": "sk_live_uMPN7cX2b1",
        "created_at": "2025-03-13T09:12:34Z",
        "updated_at": "2025-03-13T09:12:34Z"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.