Skip to main content
GET
/
api
/
v1
/
payroll
/
settings
/
cycles
cURL
curl -sS -X GET "$FLUIDE_BASE_URL/api/v1/payroll/settings/cycles?companyId=string" \
  -H "Authorization: Bearer $FLUIDE_ACCESS_TOKEN" \
  -H "X-Fluide-Api-Key: $FLUIDE_API_KEY" \
  -H "X-Fluide-Client-Id: fluide-developer"
[
  {
    "organizationId": "<string>",
    "companyId": "<string>",
    "name": "<string>",
    "isDefault": true,
    "frequency": {},
    "periodRules": {},
    "includedEmployeeIds": [
      "<string>"
    ],
    "employeeFilterRules": {},
    "approvalPolicySnapshot": {},
    "groupValidatorSnapshot": {},
    "metadata": {},
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

Access token JWT. Use as Authorization: Bearer . In the API playground, paste the JWT only.

​
X-Fluide-Api-Key
string
header
default:fl_dev_your_key
required

Developer API key (fl_dev_...). Required on every API call with a machine access token.

​
X-Fluide-Client-Id
string
header
default:fluide-developer
required

First-party client audience. Must match the fluide_client_id claim on the JWT. Use fluide-developer for Connect.

Query Parameters

​
companyId
string
required

Response

200 - application/json
​
organizationId
string
required
​
companyId
string
required
​
name
string
required
​
isDefault
boolean
required
​
frequency
object
required
​
periodRules
object
required
​
includedEmployeeIds
string[] | null
required
​
employeeFilterRules
object
required
​
approvalPolicySnapshot
object
required
​
groupValidatorSnapshot
object
required
​
metadata
object
required
​
id
string
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
deletedAt
string<date-time>