logo

Filtering

Efficiently retrieve DailyPay REST API resources with filtering queries by specifying query parameters in the request URL. This guide outlines how to build your queries.

The request URL for a filtered query is structured as follows:

https://api.dailypay.com/{endpoint}?filter[{field}]={value}

Terminology

Each filter is a standard URL query parameter key-value pair. Filter parameters follow the jsonapi specification of a query parameter family, where the parameter key is the base name filter followed by a square-bracketed ([]) field name.

  • The {endpoint} is the resource you want to filter, such as organizations, transfers, or paychecks.
  • A {field} is the attribute of a resource you want to filter by, such as a person's employee ID or a transfer's status.
  • A {value} is any value that could be a valid payload for the attribute, such as "DailyPay" for an organization name, or "PROCESSING" for a transfer status.

URL Encoding

The symbols used in DailyPay's filter strings MUST be urlencoded.

:::info

When using one of our published SDKs, you do not have to transform or urlencode the keys or values for operations with filters.

:::

For example, a curl would look like:

curl  \
  --get 'https://api.dailypayuat.com/rest/jobs' \
  --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --data-urlencode "filter[external_identifiers.primary_identifier]=040919553433" \
  --include

Practical Examples

Exact Match

Filter for a paycheck with the status "IN_TRANSIT".

GET https://api.dailypay.com/paychecks?filter[status]=IN_TRANSIT

Multiple Filters: ALL

Use multiple query parameters across different fields filter[{field}]={value} at the same time to fine tune the response. Each result will match all filters.

GET https://api.dailypay.com/paychecks?filter[job.id]=12345&filter[status]=PROCESSING

Supported Endpoint Filters

accounts

The filter is required when requests are made using oauth_client_credentials_token but optional when using oauth_user_token.

See List Accounts for a list of available filters

GET https://api.dailypay.com/accounts?filter[person_id]=aa860051-c411-4709-9685-c1b716df611b

jobs

See List Jobs for a list of available filters

GET https://api.dailypay.com/jobs?filter[external_identifiers.employee_id]=aa860051-c411-4709-9685-c1b716df611b&filter[external_identifiers.group]=Weekly

paychecks

See List Paychecks for a list of available filters

GET https://api.dailypay.com/paychecks?filter[job_id]=aa860051-c411-4709-9685-c1b716df611b&filter[status]=DEPOSITED

transfers

See List Transfers for a list of available filters

GET https://api.dailypay.com/transfers?filter[person_id]=aa860051-c411-4709-9685-c1b716df611b
➔ Next to Errors