Skip to main content
GET
/
payroll_payments
/
{public_id}
cURL
curl --request GET \
  --url https://sandbox.withclasp.com/payroll_payments/{public_id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://sandbox.withclasp.com/payroll_payments/{public_id}"

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

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandbox.withclasp.com/payroll_payments/{public_id}', 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://sandbox.withclasp.com/payroll_payments/{public_id}",
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://sandbox.withclasp.com/payroll_payments/{public_id}"

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://sandbox.withclasp.com/payroll_payments/{public_id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.withclasp.com/payroll_payments/{public_id}")

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
{
  "id": "<string>",
  "member": "<string>",
  "payday": "2023-12-25",
  "period_start": "2023-12-25",
  "period_end": "2023-12-25",
  "hours_worked": "<string>",
  "gross_pay": "<string>",
  "payroll_provider_external_id": "<string>"
}

Authorizations

Authorization
string
header
required

API Key authentication with required prefix "Bearer"

Path Parameters

public_id
string
required

Response

200 - application/json
id
string
required
read-only
Pattern: ^[-a-zA-Z0-9_]+$
member
string
required
payday
string<date>
required
period_start
string<date>
required
period_end
string<date>
required
hours_worked
string<decimal>
required
Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
gross_pay
string<decimal>
required
Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
payroll_provider_external_id
string | null
required

Unique identifier for the payroll payment in the payroll system.

Maximum string length: 255