---
title: "List profiles"
method: GET
path: "/profiles"
tags: ["Profiles"]
---

# List profiles

`GET /profiles`

## Request

- Base URL: `https://api-staging.fanheroapi.com`
- URL: `https://api-staging.fanheroapi.com/profiles`
- Auth: API key in header `apiKey`

## Query parameters

- `pageSize` number
- `page` number
- `sortBy` string

## Headers

- `organization` string, required

## Response `200`

Successful resopnse

- object: A paginated list of Profiles
  - `page` integer: The current page
  - `pageSize` integer: The number of objects per page
  - `total` integer: The total number of objects in the response
  - `pageCount` integer: The total number of pages
  - `pageNumberIsGood` boolean: Page number is valid.
  - `hasPreviousPage` boolean: There is a previous page.
  - `hasNextPage` boolean: There is a next page.
  - `isFirstPage` boolean: This is the first page.
  - `isLastPage` boolean: This is the last page.
  - `rows` ListProfilesResponseDto[]: **Profiles**
    - `_id` string: Profile ID
    - `deleted_at` string: Date and time the profile was deleted
    - `deleted` boolean: If **True**, the profile has been deleted.
    - `organization` string: Organization ID
    - `account` string: Account ID
    - `avatar` string: Avatar ID
    - `created_at` string: Date and time the profile was created
    - `updated_at` string: Date and time the profile was last updated
    - `custom_fields` Map
      - `key` string, required: Custom field name
      - `value` string, required: Value
    - `locale` string: The locale set for the profile
    - `birthday` string: Account owner's birthday
    - `id` string: Profile ID

---

[API](https://skmtc.dev/fanhero/apis/user-management-endpoints.md) - [All operations](https://skmtc.dev/fanhero/apis/user-management-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/fanhero/apis/user-management-endpoints/revisions/3f982670c057?raw)