---
title: "List requirements"
method: GET
path: "/api/servicecompliancev2/requirements"
tags: ["requirements"]
---

# List requirements

`GET /api/servicecompliancev2/requirements`

## Request

- Base URL: `https://services.fountain.com`
- URL: `https://services.fountain.com/api/servicecompliancev2/requirements`
- Auth: HTTP bearer

## Query parameters

- `filter` ParametersFilter
  - `where` ParametersFilterWhere
  - `fields` ParametersFilterFields
  - `limit` number
  - `skip` number
  - `order` string[]
  - `collate` ParametersFilterCollation
    - `locale` string
    - `strength` number
    - `caseLevel` boolean
    - `numericOrdering` boolean
- `fromLang` string
- `toLang` string

## Response `200`

Fetch a list of `requirements`

- object
  - `data` RequirementDto[], required
    - `name` string, required
    - `segmentUuids` string[], required
    - `fulfillmentDocumentTypeUuids` string[], required
    - `status` 'INACTIVE' | 'ACTIVE' | 'ARCHIVED', required
    - `isPapiHireStageOptionType` boolean
    - `multiDocument` boolean
    - `hideFromWorkers` boolean
    - `notifications` object, required
      - `email` boolean, required
      - `sms` boolean, required
      - `admin` object
        - `supervisor` boolean
        - `openingOwner` boolean
        - `adminUserUuids` string[]
    - `type` 'DOCUMENT' | 'BACKGROUND_CHECK'
    - `backgroundCheck` object
      - `provider` 'CHECKR', required
      - `apiKey` string
      - `checkrPackageSlug` string
      - `recollectionEnabled` boolean
      - `recollectionDays` integer
    - `uuid` string, required
    - `companyUuid` string, required
    - `hideFromWorkersButSendNotifications` boolean
    - `customAttributes` object, required
      - `expirationDate` object, required
        - `workerCustomAttributeKey` string, required
        - `workerCustomAttributeUuid` string, required
      - `status` object, required
        - `workerCustomAttributeKey` string, required
        - `workerCustomAttributeUuid` string, required
    - `createdAt` string, date-time, required
    - `createdBy` string, required
    - `updatedAt` string, date-time, required
    - `updatedBy` string, required
  - `meta` ResponsesPartMeta, required
    - `timestamp` string, date-time, required
    - `verb` 'OPTION' | 'GET' | 'PUT' | 'POST' | 'PATCH' | 'DELETE'
    - `path` string
    - `jti` string
    - `rid` string
    - `count` number
    - `capped` boolean: The server lowered filter[limit] to its ceiling. Page with filter[skip] to read past it.
    - `status` string
    - `duration` number
    - `size` number

---

[API](https://skmtc.dev/fountain/apis/worker-experience-public-api.md) - [All operations](https://skmtc.dev/fountain/apis/worker-experience-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fountain/apis/worker-experience-public-api/revisions/6b9a31f79e22?raw)