TOtotalpass
Analytics

Retrieves a list of 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.

get/api/companies/v1/analytic/beneficiaries

Request

  • Base URL
    https://hr.totalpass.com
  • URL
    https://hr.totalpass.com/api/companies/v1/analytic/beneficiaries
  • Auth
    API key in header x-api-key

Query parameters

pageinteger

Page number for pagination

Response

returns the beneficiaries list with pagination

Example response

{
  "data": [
    {
      "name": "John Doe",
      "type": "Holder",
      "company_name": "Acme Corp",
      "document_number": "123456789",
      "document_type": "ID",
      "plan": "TP1",
      "age_group": "25-34",
      "frequency": 5
    }
  ],
  "meta": {
    "count": 2,
    "last": 1,
    "page": 1,
    "pages": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.