List API Credentials

List all API credentials that have been created.

GET /api-creds/credentials

List API Credentials

cURL

curl --request GET \
  --url https://api.paxos.com/v2/api-creds/credentials \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.paxos.com/v2/api-creds/credentials"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paxos.com/v2/api-creds/credentials', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.paxos.com/v2/api-creds/credentials",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.paxos.com/v2/api-creds/credentials"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.paxos.com/v2/api-creds/credentials")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paxos.com/v2/api-creds/credentials")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "items": [
    {
      "id": "<string>",
      "customer_id": "<string>",
      "client_id": "<string>",
      "client_public_keys": [
        {
          "algorithm": "<string>",
          "public_key": "<string>",
          "nickname": "<string>",
          "id": "<string>",
          "client_id": "<string>",
          "active": true
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "nickname": "<string>",
      "ip_allowlist": [
        "<string>"
      ],
      "enforce_request_signing": true,
      "client_scopes": [
        "<string>"
      ],
      "created_by": "<string>"
    }
  ],
  "next_page_cursor": "<string>"
}

OAuth Scope

api_creds:read_credentials

Authorizations

Authorization · string · header · required

Paxos APIs use OAuth 2 with the client credentials grant flow.

Token URLs:

• Production: https://oauth.paxos.com/oauth2/token
• Sandbox: https://oauth.sandbox.paxos.com/oauth2/token

Learn more in the API credentials guide →

Query Parameters

order · enum<string>

Determines whether the items are returned in ascending (ASC), or descending (DESC) order. Defaults to DESC.

Available options: DESC, ASC

order_by · enum<string>

The specific field by which the returned results will be ordered. Defaults to CREATED_AT.

Available options: CREATED_AT

limit · integer<int32>

The maximum number of items to return. Defaults to 0 (return all records). Max value is 1000.

page_cursor · string

The page cursor for pagination. Use the next_page_cursor from the response to get the next page.

statuses · enum<string>[]

Filter for credentials with a set of statuses. Defaults to [APPROVED].

Available options: APPROVED, DISABLED

ids · string[]

Optionally filter by the UUIDs of the credentials. Limit 100.

client_ids · string[]

Optionally filter by the client IDs of the credentials. Limit 100.

Response

200 - application/json

A successful response.

items · object[]

Show child attributes

next_page_cursor · string

The page cursor for the next page of results. Empty if this is the last page.