COconnecteam
Company Policies:v1:PayRuleAssignment

List pay rule policy assignments

Changed on

Retrieve all assignments for a specific pay rule policy that are in effect on the given date

get/company-policies/v1/pay-rule-policies/{payRulePolicyId}/assignments

Request

  • Base URL
    https://api.connecteam.com
  • URL
    https://api.connecteam.com/company-policies/v1/pay-rule-policies/{payRulePolicyId}/assignments
  • Auth
    • API key in header X-API-KEY
    • or OAuth 2
      Client credentials
      Token URL: /oauth/v1/token scopes: company_policies.read

Path parameters

payRulePolicyIdinteger required

The unique identifier of the pay rule policy

Query parameters

effectiveDatestring date nullable

The date to list assignments for, specified in ISO 8601 format (e.g., 2025-01-25). Defaults to today when omitted

userIdsinteger[] nullable

When set, return only these users' assignments on the policy. Repeat the parameter per user

limitinteger

The maximum number of results to display per page

offsetinteger

The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results

Response

Successful Response

requestIdstring

Changes