---
title: "Retrieve Tip Pool Settings"
method: GET
path: "/v2/company/{company_id}/tip_pool_settings"
tags: ["Tip Pool"]
---

# Retrieve Tip Pool Settings

`GET /v2/company/{company_id}/tip_pool_settings`

## Request

- Base URL: `https://api.7shifts.com`
- URL: `https://api.7shifts.com/v2/company/{company_id}/tip_pool_settings`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://app.7shifts.com/oauth2/authorize`
    - Client credentials
    - Password
    - Token URL: `https://app.7shifts.com/oauth2/token`
  - API key in cookie `7session`
- TypeScript: <https://skmtc.dev/7shifts/apis/7shifts-api/docs/v2/company/:company_id/tip_pool_settings/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `company_id` integer, required

## Headers

- `x-api-version` string: An API version
- `x-company-guid` string, uuid

## Response `200`

Tip pool settings for a company

- object
  - `data` object[], required
    - `uuid` string, uuid, nullable: Tip pool settings UUID
    - `company_id` integer, required: Company ID
    - `location_id` integer, required: Location ID
    - `day_part_uuids` string[], nullable: Day parts associated with this tip pool
    - `contribution_type` 'POS_PERCENT_TIPS_AND_SALES' | 'MANUAL_ENTRY', required: Tip pool contribution type
    - `distribution_type` 'HOURS_WORKED' | 'ROLE_PERCENT_HOURS_WORKED' | 'POINTS', required: Tip pool distribution type
    - `sales_tip_percentage` number, float, nullable, required: The proportion of sales tips or tips for unassigned roles (in percentage) you wish to contribute to the tip pool
    - `unmapped_contribution_method` string, nullable: A field representing whether we source our unmapped contribution amounts from tips, sales receipts or remaining tips
    - `unmapped_contribution_filters` object[]
      - `uuid` string, uuid, nullable: Tip pool unmapped contribution filter UUID
      - `tip_pool_settings_uuid` string, uuid, nullable: Tip pool settings UUID
      - `filter_type` 'DINING_OPTION' | 'REVENUE_CENTER' | 'SALES_CATEGORY', required: The type of stakeholder filter - whether it is from a revenue center, dining option, or sales category
      - `filter_value` string, nullable, required: The ID that we will represent the filter with
      - `filter_name` string, required: The display name that the end user will see
    - `name` string, required: Tip pool name
    - `enabled` boolean, required: Whether the tip pool is enabled
    - `tip_pool_stakeholders` object[], required
      - `uuid` string, uuid, nullable: Tip pool stakeholder UUID
      - `tip_pool_settings_uuid` string, uuid, nullable: Tip pool settings UUID
      - `stakeholder_type` 'CONTRIBUTION' | 'DISTRIBUTION', required: Whether this is a contributor or a receiver
      - `stakeholder_subtype` 'ROLE' | 'DEPARTMENT', required: Whether this stakeholder represents a role or a department
      - `role_id` integer, nullable, required: Role ID (null if stakeholder subtype is not 'ROLE')
      - `department_id` integer, nullable, required: Department ID (null if stakeholder subtype is not 'DEPARTMENT')
      - `stake_amount` number, float, nullable, required: Amount of tips they contribute or receive (may be a percentage, number of points, or null, depending on stakeholder type and tip pool distribution type)
      - `contribution_method` string, nullable, required: If the stakeholder is a contribution stakeholder, this field represents whether they contribute based on percent tips, percent sales or percent remaining tips
      - `filters` object[]
        - `uuid` string, uuid, nullable: Tip pool stakeholder filter UUID
        - `tip_pool_stakeholder_uuid` string, uuid, nullable: Tip pool stakeholder UUID
        - `tip_pool_settings_uuid` string, uuid, nullable: Tip pool settings UUID
        - `filter_type` 'DINING_OPTION' | 'REVENUE_CENTER' | 'SALES_CATEGORY', required: The type of stakeholder filter - whether it is from a revenue center, dining option, or sales category
        - `filter_value` string, nullable, required: The ID that we will represent the filter with
        - `filter_name` string, required: The display name that the end user will see
    - `tip_pool_contributions` object[], required
      - `uuid` string, uuid, nullable: Tip pool contribution UUID
      - `tip_pool_settings_uuid` string, uuid, nullable: Tip pool settings UUID
      - `source` 'CASH' | 'CREDIT_CARD' | 'DECLARED' | 'AUTO_GRATUITY' | 'TOTAL_PAYMENT', required: Source of tip
    - `tip_pool_cadence_settings` object, nullable: Tip pool cadence settings - denotes the frequency of tip pool period calculations
      - `uuid` string, uuid, nullable: Tip pool cadence settings UUID
      - `tip_pool_settings_uuid` string, uuid, nullable: Tip pool settings UUID
      - `cadence_type` 'DAILY' | 'WEEKLY' | 'BIWEEKLY' | 'SEMI_MONTHLY' | 'MONTHLY', required: The frequency/cadence of each tip pool settings period
      - `period_start_date` string, nullable, required: What effective date does the cadence period start (only for WEEKLY, BIWEEKLY)
    - `created` string, date-time: When this tip pool was created in UTC timezone and Zulu format
    - `modified` string, date-time: When this tip pool was last modified in UTC timezone and Zulu format

## Other responses

- `403`: No permission to access tip pool settings
- `404`: Unable to find any tip pool settings for the provided company id

---

[API](https://skmtc.dev/7shifts/apis/7shifts-api.md) - [All operations](https://skmtc.dev/7shifts/apis/7shifts-api/llms.txt) - [OpenAPI document](https://skmtc.dev/7shifts/apis/7shifts-api/revisions/40e0ef40dfcd?raw)