TOtotalpass
Company Groups

Retrieve authenticated company group information

Changed on

Returns the full profile of the authenticated company group, including its configuration (eligible identifier type, max quantities) and the list of associated companies.

get/api/v1/company_groups/info

Request

  • Base URL
    https://company-eligibles-api.totalpass.com
  • URL
    https://company-eligibles-api.totalpass.com/api/v1/company_groups/info
  • Auth
    HTTP bearer

Response

Company group info returned

Example response

{
  "data": {
    "id": "1",
    "type": "company_group",
    "attributes": {
      "identifier": "my-company-group",
      "eligible_identifier_type": "cpf",
      "eligibles_quantity": 150,
      "reference_identifier_type": "cnpj",
      "eligibles_max_quantity": 200,
      "companies": [
        {
          "reference_identifier": "12345678000195",
          "reference_identifier_type": "cnpj"
        }
      ]
    }
  }
}

Changes

  • 309daa2abc23Revision changes
    • warning

      added the new email enum value to the // response property for the response status

    • warning

      added the new employee_number enum value to the // response property for the response status