---
title: "List Employments Data"
method: GET
path: "/company_connections/{company_connection_id}/employments"
tags: ["Company Connect"]
---

# List Employments Data

`GET /company_connections/{company_connection_id}/employments`

## Request

- Base URL: `https://api.getpinwheel.com/v1`
- URL: `https://api.getpinwheel.com/v1/company_connections/{company_connection_id}/employments`
- Auth: API key in header `X-API-SECRET`

List all employments data reported by the payroll platform. This is a paginated endpoint; see how Pinwheel implements pagination <a href='https://docs.pinwheelapi.com/docs/pagination-1' target='_blank'>here</a>.

## Path parameters

- `company_connection_id` string, uuid, required: UUID of the Company Connection.

## Query parameters

- `cursor` string: Cursor for the page you want to retrieve.
- `limit` integer: The maximum number of results to return.

## Headers

- `Pinwheel-Version` '2025-07-08' | '2023-11-22' | '2023-07-18' | '2023-04-18' | '2022-09-09' | '2022-06-22' | '2022-03-02', required

## Response `200`

OK

- object
  - `meta` PaginationMeta, required
    - `count` integer: Number of objects returned.
    - `next_cursor` string: Pointer to the next page of results.
  - `data` CompanyEmploymentObjResponse[], required
    - `created_at` string, date-time, required: ISO 8601 timestamp of created time.
    - `employee_external_id` string, required: Employee ID as reported by their employer.
    - `status` 'employed' | 'terminated' | 'furloughed': The employment status of the employee.
    - `employment_type` 'full_time' | 'part_time' | 'seasonal' | 'temporary' | 'contractor' | 'self_employed' | 'per_diem' | 'commission': The employment type e.g. full time, part time, seasonal, contractor.
    - `start_date` string, date: The date the employee began their job.
    - `termination_date` string, date: The date the employee was terminated.
    - `employer_name` string, required: Name of employer, e.g., Apple, Disney, Walmart.
    - `title` string: The job title of the employee.
    - `department` string: The department the employee works in.
    - `manager_external_id` string: The employee's manager's employee ID.
    - `class_code` string: A three- to four-digit code that identifies types of work, typically used by insurance companies to evaluate risk.
    - `employer_address` AddressGetResponseItem
      - `raw` string, required: The raw address.
      - `line1` string: The first line of the address.
      - `line2` string: The second line of the address.
      - `city` string: The city of the address.
      - `state` string: The state of the address.
      - `postal_code` string: The postal code of the address.
      - `country` 'US': The country of the address.

---

[API](https://skmtc.dev/getpinwheel/apis/pinwheel.md) - [All operations](https://skmtc.dev/getpinwheel/apis/pinwheel/llms.txt) - [OpenAPI document](https://skmtc.dev/getpinwheel/apis/pinwheel/revisions/d1c86ae1189c?raw)