---
title: "Retrieves a list of beneficiaries"
method: GET
path: "/api/company_analytic/v1/beneficiaries"
tags: ["Analytics"]
---

# Retrieves a list of beneficiaries

`GET /api/company_analytic/v1/beneficiaries`

This endpoint retrieves a comprehensive list of beneficiaries associated with the company group, supporting pagination for efficient data retrieval. It provides detailed information including name, user type (holder or dependent), associated plan, age group, and frequency of usage within the platform.

## Query parameters

- `page` integer

## Response `200`

returns the beneficiaries list with pagination

- object
  - `data` object[]
    - `name` string
    - `type` string
    - `company_name` string
    - `document_number` string
    - `document_type` string
    - `plan` string
    - `age_group` string
    - `frequency` integer
  - `meta` object
    - `count` integer
    - `last` integer
    - `next` integer, nullable
    - `page` integer
    - `pages` integer
    - `prev` integer, nullable

## Other responses

- `401` — returns unauthorized when api key is invalid
- `404` — returns not found when there is no data
- `422` — returns unprocessable entity on unexpected errors

---

[API](https://skmtc.net/totalpass/apis/token-use.md) · [All operations](https://skmtc.net/totalpass/apis/token-use/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/totalpass/token-use/versions/bc65b4950c7e/schema)