--- updatedAt: 2026-06-12T23:00:16.000Z agentTools: projectIndex: https://developers.7shifts.com/llms.txt --- # Retrieve Tip Pool Settings **[Minimum Plan Required](https://developers.7shifts.com/docs/plan-requirements):** Entrée # OpenAPI definition ```json { "openapi": "3.0.2", "info": { "title": "7shifts API", "contact": { "email": "api-support@7shifts.com" }, "version": "2026-06-01" }, "servers": [ { "url": "https://api.7shifts.com", "description": "Production server" } ], "paths": { "/v2/company/{company_id}/tip_pool_settings": { "get": { "tags": [ "Tip Pool" ], "summary": "Retrieve Tip Pool Settings", "operationId": "getTipPoolSettings", "x-public-api": true, "parameters": [ { "name": "x-api-version", "in": "header", "description": "7shifts API version", "required": false, "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "An API version", "example": "2022-05-01" } }, { "name": "x-company-guid", "in": "header", "description": "Company GUID", "required": false, "schema": { "type": "string", "format": "uuid" }, "example": "1310bfe1-cb3f-4f24-98a2-fde2bc504108" }, { "name": "company_id", "in": "path", "description": "Company ID", "required": true, "schema": { "type": "integer", "format": "int64" }, "example": 1234 } ], "responses": { "200": { "description": "Tip pool settings for a company", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "Tip pool settings UUID" }, "company_id": { "type": "integer", "format": "int64", "description": "Company ID", "example": 1234 }, "location_id": { "type": "integer", "format": "int64", "description": "Location ID", "example": 1234 }, "day_part_uuids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true, "description": "Day parts associated with this tip pool" }, "contribution_type": { "type": "string", "enum": [ "POS_PERCENT_TIPS_AND_SALES", "MANUAL_ENTRY" ], "description": "Tip pool contribution type", "example": "POS_PERCENT_TIPS_AND_SALES" }, "distribution_type": { "type": "string", "enum": [ "HOURS_WORKED", "ROLE_PERCENT_HOURS_WORKED", "POINTS" ], "description": "Tip pool distribution type", "example": "HOURS_WORKED" }, "sales_tip_percentage": { "type": "number", "format": "float", "example": 75.5, "description": "The proportion of sales tips or tips for unassigned roles (in percentage) you wish to contribute to the tip pool", "nullable": true }, "unmapped_contribution_method": { "type": "string", "nullable": true, "description": "A field representing whether we source our unmapped contribution amounts from tips, sales receipts or remaining tips" }, "unmapped_contribution_filters": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "Tip pool unmapped contribution filter UUID" }, "tip_pool_settings_uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "Tip pool settings UUID" }, "filter_type": { "type": "string", "enum": [ "DINING_OPTION", "REVENUE_CENTER", "SALES_CATEGORY" ], "description": "The type of stakeholder filter - whether it is from a revenue center, dining option, or sales category", "example": "DINING_OPTION" }, "filter_value": { "type": "string", "description": "The ID that we will represent the filter with", "nullable": true, "example": "some-id" }, "filter_name": { "type": "string", "description": "The display name that the end user will see", "example": "Dine In" } }, "required": [ "filter_type", "filter_value", "filter_name" ] } }, "name": { "type": "string", "description": "Tip pool name", "example": "My tip pool" }, "enabled": { "type": "boolean", "description": "Whether the tip pool is enabled", "example": true }, "tip_pool_stakeholders": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "Tip pool stakeholder UUID" }, "tip_pool_settings_uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "Tip pool settings UUID" }, "stakeholder_type": { "type": "string", "enum": [ "CONTRIBUTION", "DISTRIBUTION" ], "description": "Whether this is a contributor or a receiver", "example": "CONTRIBUTION" }, "stakeholder_subtype": { "type": "string", "enum": [ "ROLE", "DEPARTMENT" ], "description": "Whether this stakeholder represents a role or a department", "example": "ROLE" }, "role_id": { "type": "integer", "format": "int64", "nullable": true, "description": "Role ID (null if stakeholder subtype is not 'ROLE')", "example": 1234 }, "department_id": { "type": "integer", "format": "int64", "nullable": true, "description": "Department ID (null if stakeholder subtype is not 'DEPARTMENT')", "example": 1234 }, "stake_amount": { "type": "number", "format": "float", "nullable": true, "description": "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)", "example": 5.5 }, "contribution_method": { "type": "string", "nullable": true, "description": "If the stakeholder is a contribution stakeholder, this field represents whether they contribute based on percent tips, percent sales or percent remaining tips", "example": "PERCENT_TIPS" }, "filters": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "Tip pool stakeholder filter UUID" }, "tip_pool_stakeholder_uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "Tip pool stakeholder UUID" }, "tip_pool_settings_uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "Tip pool settings UUID" }, "filter_type": { "type": "string", "enum": [ "DINING_OPTION", "REVENUE_CENTER", "SALES_CATEGORY" ], "description": "The type of stakeholder filter - whether it is from a revenue center, dining option, or sales category", "example": "DINING_OPTION" }, "filter_value": { "type": "string", "description": "The ID that we will represent the filter with", "nullable": true, "example": "some-id" }, "filter_name": { "type": "string", "description": "The display name that the end user will see", "example": "Dine In" } }, "required": [ "filter_type", "filter_value", "filter_name" ] } } }, "required": [ "stakeholder_type", "stakeholder_subtype", "role_id", "department_id", "stake_amount", "contribution_method" ], "description": "Tip pool stakeholders (contributors and receivers)" } }, "tip_pool_contributions": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "Tip pool contribution UUID" }, "tip_pool_settings_uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "Tip pool settings UUID" }, "source": { "type": "string", "enum": [ "CASH", "CREDIT_CARD", "DECLARED", "AUTO_GRATUITY", "TOTAL_PAYMENT" ], "description": "Source of tip", "example": "CASH" } }, "required": [ "source" ], "description": "Tip types that are contributed to the tip pool" } }, "tip_pool_cadence_settings": { "type": "object", "nullable": true, "properties": { "uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "Tip pool cadence settings UUID" }, "tip_pool_settings_uuid": { "type": "string", "format": "uuid", "nullable": true, "description": "Tip pool settings UUID" }, "cadence_type": { "type": "string", "enum": [ "DAILY", "WEEKLY", "BIWEEKLY", "SEMI_MONTHLY", "MONTHLY" ], "description": "The frequency/cadence of each tip pool settings period", "example": "DAILY" }, "period_start_date": { "type": "string", "description": "What effective date does the cadence period start (only for WEEKLY, BIWEEKLY)", "nullable": true, "example": "2021-02-12" } }, "required": [ "cadence_type", "period_start_date" ], "description": "Tip pool cadence settings - denotes the frequency of tip pool period calculations" }, "created": { "type": "string", "format": "date-time", "description": "When this tip pool was created in UTC timezone and Zulu format", "example": "2021-02-12T12:00:00Z" }, "modified": { "type": "string", "format": "date-time", "description": "When this tip pool was last modified in UTC timezone and Zulu format", "example": "2021-02-12T13:00:00Z" } }, "required": [ "company_id", "location_id", "name", "contribution_type", "distribution_type", "sales_tip_percentage", "tip_pool_stakeholders", "tip_pool_contributions", "enabled" ] } } }, "required": [ "data" ] } } } }, "403": { "description": "No permission to access tip pool settings", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "The primary identifier for the problem type (URI reference)." }, "title": { "type": "string", "description": "A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization." }, "status": { "type": "integer", "description": "The HTTP status code." }, "detail": { "type": "string", "description": "A human-readable explanation specific to this occurrence of the problem." }, "code": { "type": "integer", "description": "The error code can be used to look up the reason why the request failed." }, "param": { "type": "string", "description": "The request parameter that this error is related to." } }, "required": [ "type", "title", "status", "detail" ] } } } }, "404": { "description": "Unable to find any tip pool settings for the provided company id", "content": { "application/problem+json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "The primary identifier for the problem type (URI reference)." }, "title": { "type": "string", "description": "A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization." }, "status": { "type": "integer", "description": "The HTTP status code." }, "detail": { "type": "string", "description": "A human-readable explanation specific to this occurrence of the problem." }, "code": { "type": "integer", "description": "The error code can be used to look up the reason why the request failed." }, "param": { "type": "string", "description": "The request parameter that this error is related to." } }, "required": [ "type", "title", "status", "detail" ] } } } } } } } }, "components": { "securitySchemes": { "OAuth2": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://app.7shifts.com/oauth2/token", "refreshUrl": "https://app.7shifts.com/oauth2/token", "scopes": { "v1_access": "Required to access APIv1 endpoints." } }, "password": { "tokenUrl": "https://app.7shifts.com/oauth2/token", "refreshUrl": "https://app.7shifts.com/oauth2/token", "scopes": { "v1_access": "Required to access APIv1 endpoints." } }, "authorizationCode": { "authorizationUrl": "https://app.7shifts.com/oauth2/authorize", "tokenUrl": "https://app.7shifts.com/oauth2/token", "refreshUrl": "https://app.7shifts.com/oauth2/token", "scopes": { "v1_access": "Required to access APIv1 endpoints." } } } }, "cookieAuth": { "type": "apiKey", "in": "cookie", "name": "7session" } } }, "security": [ { "OAuth2": [] }, { "cookieAuth": [] } ], "tags": [ { "name": "Tip Pool" } ] } ```