# Get Compliance Programs

Retrieves a paginated list of compliance programs with optional filtering and includes.

Endpoint: GET /api/v1/programs
Version: 1.0.0
Security: x-api-key

## Query parameters:

  - `include` (array)
    Comma-separated list of additional fields to include.
    Enum: "companyId", "settings", "parentProgramId", "childProgramIds", "programPeriod"

  - `page[size]` (integer)
    Number of records to return per page.

  - `page[cursor]` (string)
    Cursor for pagination.
    Example: "61d325c84a9f97631731a690"

  - `filter[startPeriod]` (string)
    Filter programs by start period.
    Example: "january-2024"

  - `filter[endPeriod]` (string)
    Filter programs by end period.
    Example: "january-2024"

  - `filter[name]` (string)
    Filter programs by name.

## Response 200 fields (application/json):

  - `data` (array)
    Array of Programs.

  - `data.id` (string)
    Example: "61d325c84a9f97631731a690"

  - `data.name` (string)
    Name of the program.
    Example: "Project 1694126185868"

  - `data.startPeriod` (string)
    A period representation in the format "month-year"
    Example: "january-2024"

  - `data.endPeriod` (string)
    A period representation in the format "month-year"
    Example: "january-2024"

  - `data.settings` (object)

  - `data.settings.timezone` (string)
    Example: "US/Central"

  - `data.programPeriod` (string)
    Year of the program.
    Example: "2024"

  - `data.parentProgramId` (string)
    Example: "61d325c84a9f97631731a690"

  - `data.childProgramIds` (array)
    Array of child program IDs.
    Example: ["61d325c84a9f97631731a690"]

  - `links` (object)

  - `links.self` (string)
    Link to self.
    Example: "/api/v1/programs/?page[size]=50&page[cursor]=5e94d5b63f557b001420bbe3"

  - `links.next` (string)
    Link to the next page of programs.
    Example: "/api/v1/programs/?page[size]=50&page[cursor]=63b88f2cb1f05200179e7857"

## Response 400 fields (application/json):

  - `message` (string)
    Enum: "Please provide an API key in \"x-api-key\" header of the request.", "There were one or more input validation errors."

## Response 401 fields (application/json):

  - `message` (string)
    Enum: "API Key is expired", "API Key is invalid or inactive", "API Key cannot be decoded", "User not found", "User is not active", "Token does not contain user information"

## Response 403 fields (application/json):

  - `message` (string)
    Enum: "User does not have any compliance programs.", "User does not have access to this TLC.", "API Key missing required permission(s)."