---
title: "Retrieve a list of profiles."
method: GET
path: "/v1/profiles"
tags: ["Profiles"]
---

# Retrieve a list of profiles.

`GET /v1/profiles`

## Request

- Base URL: `https://help.puppet.com/api/public`
- URL: `https://help.puppet.com/api/public/v1/profiles`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/puppet/apis/puppet-comply-api/docs/v1/profiles/get.ts> (a function with typed inputs; its response is checked against the schema)

To use this endpoint, you must have one of the following roles:
`comply-admin`
`comply-operator`
`comply-viewer`

## Query parameters

- `offset` integer
- `limit` integer

## Response `200`

ProfilesListResponse is the response for a profiles list.

- object
  - `data` Profile[], required: Data contains list of profiles records.
    - `benchmark` AssociatedBenchmark
      - `id` integer, required: The ID of the benchmark.
      - `name` string, required: The Name of the benchmark.
    - `id` integer, required: The ID of the profile.
    - `name` string, required: The name of the profile.
  - `limit` integer: If specified limit, you retrieve a subset of records limited to the given value..
  - `next` string, nullable: Next page value .
  - `offset` integer: Offset is the position in the dataset of a particular record. By specifying offset, you retrieve a subset of records starting with the offset value.
  - `total` integer, required: Total number of records.

## Other responses

- `default`: ErrorResponse is the default error response.

---

[API](https://skmtc.dev/puppet/apis/puppet-comply-api.md) - [All operations](https://skmtc.dev/puppet/apis/puppet-comply-api/llms.txt) - [OpenAPI document](https://skmtc.dev/puppet/apis/puppet-comply-api/revisions/0a7ac90117d7?raw)