---
title: "Company Job Segments"
method: GET
path: "/companies/{companyId}/jobsegments"
tags: ["Company"]
---

# Company Job Segments

`GET /companies/{companyId}/jobsegments`

## Request

- Base URL: `https://api.paychex.com`
- URL: `https://api.paychex.com/companies/{companyId}/jobsegments`
- Auth: none declared
- TypeScript: <https://skmtc.dev/paychex/apis/external-api/docs/companies/:companyId/jobsegments/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve job segment structure setup for this client. This endpoint is only available if the client has their job numbering set up in '2-3 separate 'segments'.  The response will give you back the exact character lengths and the segment names so you are able to POST.

## Path parameters

- `companyId` string, required

## Response `200`

successful operation

- object
  - `metadata` MetadataResource
    - `contentItemCount` integer
    - `pagination` PaginationMetadataResource
      - `offset` integer
      - `limit` integer
      - `itemCount` integer
      - `total` integer
  - `content` JobSegmentsConfigResource
    - `segmentNumber` integer: Segment Number
    - `name` string: Segment Name
    - `segmentLength` integer: Segment Length
    - `links` Link[]
      - `rel` string
      - `href` string
      - `hreflang` string
      - `media` string
      - `title` string
      - `type` string
      - `deprecation` string
      - `profile` string
      - `name` string
  - `links` Link[]
    - `rel` string
    - `href` string
    - `hreflang` string
    - `media` string
    - `title` string
    - `type` string
    - `deprecation` string
    - `profile` string
    - `name` string

## Other responses

- `401`: Unauthorized
- `403`: User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)
- `404`: Invalid resource ID (API-7)
- `405`: Unsupported method type (API-59)
- `406`: Unsupported Accept header
- `500`: Internal Server Error.

---

[API](https://skmtc.dev/paychex/apis/external-api.md) - [All operations](https://skmtc.dev/paychex/apis/external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paychex/apis/external-api/revisions/07161d3e073f?raw)