Get pay rates

get

https://api.connecteam.com/pay-rates/v1/pay-rates

Retrieves pay rate information for one or more users within your organization. This endpoint supports flexible filtering by effective dates, rate types, and resource assignments. It's designed for payroll integration scenarios where you need to fetch pay rates for multiple employees at once. The response includes historical modification data when requested, allowing you to track changes over time for audit and compliance purposes. Pagination is supported for large result sets.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

startDate

string

required

Return pay rates that are in effect during the date range starting from this date, in ISO 8601 format (YYYY-MM-DD). This includes rates with an effective date before startDate if they are still the most recent rate at the start of the range. Must be used together with endDate. Date range cannot exceed 365 days.

endDate

string

required

Return pay rates that are in effect during the date range ending at this date, in ISO 8601 format (YYYY-MM-DD). Must be used together with startDate. Date range cannot exceed 365 days.

userIds

array of integers

List of user IDs to retrieve pay rates for. If omitted, pay rates for all users will be returned (subject to pagination).

Userids

rateType

string

enum

Filter by rate type. Valid values: hourly, monthly, yearly.

Allowed:

resourceIds

array of strings

Filter resource rate details to include only specific resources. This filter only affects resourcesRates; other pay rate fields are always returned.

Resourceids

isIncludeHistory

boolean

Defaults to false

When set to true, includes the complete modification history for each pay rate. Note: Setting this to true may increase response time and payload size.

limit

integer

1 to 500

Defaults to 100

The maximum number of results to display per page

offset

integer

≥ 0

Defaults to 0

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

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

400Invalid request parameters

422Validation Error