GET
/
v1
/
pay
/
cycles
curl --request GET \
  --url https://api.onsi.com/v1/pay/cycles \
  --header 'x-api-key: <api-key>'
{
  "payCycles": [
    {
      "id": "pc_<id>",
      "startDate": "2024-01-01",
      "endDate": "2024-01-15",
      "status": "Open"
    }
  ],
  "total": 1,
  "skip": 0,
  "take": 50
}

This endpoint returns a list of all pay cycles, past and present.

  • 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.

Ordering and Contiguity

Pay cycles are designed to be perfectly contiguous, meaning they always touch each other with zero gaps between them. For example:

  • 2025-06-302025-07-06 (Open)
  • 2025-06-232025-06-29 (Closed)
  • 2025-06-162025-06-22 (Closed)

The cycles returned are ordered with the most recent cycle first, so the top result will always be the latest cycle and should always be Open.

Authorizations

x-api-key
string
header
required

Query Parameters

statuses
enum<string>[]

Filter by status

skip
number
default:0
required
take
number
default:50
required

Response

200 - application/json

200

The response is of type object.