Skip to main content
GET
/
v1
/
pay
/
cycles
/
{id}
Show pay cycle
curl --request GET \
  --url https://api.onsi.com/v1/pay/cycles/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "pc_<id>",
  "startDate": "2024-01-01",
  "endDate": "2024-01-15",
  "status": "Open"
}

Documentation Index

Fetch the complete documentation index at: https://docs.onsi.com/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint returns a single pay cycle, by its ID.
  • Closed - The cycle is closed, no moe withdrawals can be made, and you can now perform your final deductions/accounting.
  • Open - The cycle is open, members can still make withdrawals.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

The unique identifier for a PayCycle, prefixed with pc_

Example:

"pc_<id>"

Response

200 - application/json

A pay cycle is a period of time pay is made available for members to withdraw

A pay cycle is a period of time pay is made available for members to withdraw

​
id
string
required

The unique identifier for a PayCycle, prefixed with pc_

Example:

"pc_<id>"

​
startDate
string
required

Date in ISO8601 YYYY-MM-DD format

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2024-01-01"

​
endDate
string
required

Date in ISO8601 YYYY-MM-DD format

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2024-01-15"

​
status
enum<string>
required
Available options:
Open,
Closed