List claim schedules

Returns a paginated list of claim schedules

GET /rewards/claim-schedules

List claim schedules

cURL

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

import requests

url = "https://api.paxos.com/v2/rewards/claim-schedules"

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/rewards/claim-schedules', 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/rewards/claim-schedules",
  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/rewards/claim-schedules"

	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/rewards/claim-schedules")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paxos.com/v2/rewards/claim-schedules")

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>",
      "payout_group_id": "<string>",
      "next_run_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "days_of_week": [
        123
      ],
      "days_of_month": [
        123
      ],
      "hour": 123,
      "minute": 123
    }
  ],
  "next_page_cursor": "<string>"
}

OAuth Scope

rewards:read_claims_schedule

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

payout_group_id · string

Optionally filter by payout_group

limit · integer<int32>

Number of results to return. Defaults to 100. Maximum 1000.

page_cursor · string

Optional: Cursor for getting the next page of results.

Response

200 - application/json

A successful response.

items · object[]

Claim schedules in this page of results.

Show child attributes

next_page_cursor · string

Token to retrieve the next page of results, or empty if there are no more results.