# Find payroll runs

`GET /api/payroll-run`

Authentication: no security requirement declared for this operation.

Parameters:

- `organizationId` (query, string, required)
  Type: string

- `status` (query, string, optional)
  Type: string
  
  enum: ["DRAFT","PENDING_APPROVAL","APPROVED","PROCESSING","PAID","CANCELLED"]

- `frequency` (query, string, optional)
  Type: string
  
  enum: ["WEEKLY","BI_WEEKLY","SEMI_MONTHLY","MONTHLY","QUARTERLY","ANNUALLY"]

- `periodStart` (query, string, date-time, optional) - Lower bound of the periodStart range
  Type: string, date-time

- `periodEnd` (query, string, date-time, optional) - Upper bound of the periodStart range
  Type: string, date-time

- `page` (query, number, optional) - 1-based page number
  Type: number

- `limit` (query, number, optional) - Rows per page, 1-100
  Type: number

Responses:

- 200: Found payroll runs

## Examples

### cURL

```bash
curl -X GET 'http://localhost:3000/api/payroll-run?organizationId=string'
```

### JavaScript

```javascript
const response = await fetch('http://localhost:3000/api/payroll-run?organizationId=string', {
  method: 'GET',
});

const data = await response.text();
```

### Python

```python
import requests

response = requests.get('http://localhost:3000/api/payroll-run?organizationId=string')
print(response.text)
```