---
title: "List pay rule policy assignments"
method: GET
path: "/company-policies/v1/pay-rule-policies/{payRulePolicyId}/assignments"
tags: ["Company Policies:v1:PayRuleAssignment"]
---

# List pay rule policy assignments

`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: one of:
  - API key in header `X-API-KEY`
  - OAuth 2
    - Client credentials
    - Token URL: `/oauth/v1/token` scopes: `company_policies.read`

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

## Path parameters

- `payRulePolicyId` integer, required: The unique identifier of the pay rule policy

## Query parameters

- `effectiveDate` string, date, nullable: The date to list assignments for, specified in ISO 8601 format (e.g., 2025-01-25). Defaults to today when omitted
- `userIds` integer[], nullable: When set, return only these users' assignments on the policy. Repeat the parameter per user
- `limit` integer: The maximum number of results to display per page
- `offset` integer: 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 `200`

Successful Response

- PaginatedBaseResponseV2PayRuleAssignmentListData
  - `requestId` string
  - `data` PayRuleAssignmentListData, required
    - `assignments` PayRuleAssignmentListItem[], required: List of assignments for the policy
      - `assignmentId` integer, required: The unique identifier of the assignment record
      - `userId` integer, required: The unique identifier of the assigned user
      - `effectiveDate` string, date, required: The date the assignment takes effect (ISO 8601)
  - `paging` PagingResponseModelV2, required
    - `offset` integer, required: 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
    - `total` integer, nullable: Total number of resources matching the request, ignoring pagination. Use this to retrieve the full count without paginating through every page. Only populated by endpoints that compute it.

## Other responses

- `422`: Validation Error

## Changes

- **2026-11-03** `a01dde7c27fb`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/connecteam/apis/connecteam-api-documentation/changes/company-policies/v1/pay-rule-policies/:payRulePolicyId/assignments/get.md)

---

[API](https://skmtc.dev/connecteam/apis/connecteam-api-documentation.md) - [All operations](https://skmtc.dev/connecteam/apis/connecteam-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/connecteam/apis/connecteam-api-documentation/revisions/a01dde7c27fb?raw)
