> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # square-team > Square Team & Labor **Server path:** `/square-team` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ----------------------------------------------------------------------------------------- | -------------------------- | | [`square_team_bulk_create_team_members`](#square_team_bulk_create_team_members) | BulkCreateTeamMembers | | [`square_team_bulk_publish_scheduled_shifts`](#square_team_bulk_publish_scheduled_shifts) | BulkPublishScheduledShifts | | [`square_team_bulk_update_team_members`](#square_team_bulk_update_team_members) | BulkUpdateTeamMembers | | [`square_team_create_break_type`](#square_team_create_break_type) | CreateBreakType | | [`square_team_create_job`](#square_team_create_job) | CreateJob | | [`square_team_create_scheduled_shift`](#square_team_create_scheduled_shift) | CreateScheduledShift | | [`square_team_create_team_member`](#square_team_create_team_member) | CreateTeamMember | | [`square_team_create_timecard`](#square_team_create_timecard) | CreateTimecard | | [`square_team_delete_break_type`](#square_team_delete_break_type) | DeleteBreakType | | [`square_team_delete_timecard`](#square_team_delete_timecard) | DeleteTimecard | | [`square_team_get_break_type`](#square_team_get_break_type) | GetBreakType | | [`square_team_get_member_wage`](#square_team_get_member_wage) | GetTeamMemberWage | | [`square_team_list_break_types`](#square_team_list_break_types) | ListBreakTypes | | [`square_team_list_jobs`](#square_team_list_jobs) | ListJobs | | [`square_team_list_team_member_wages`](#square_team_list_team_member_wages) | ListTeamMemberWages | | [`square_team_list_workweek_configs`](#square_team_list_workweek_configs) | ListWorkweekConfigs | | [`square_team_publish_scheduled_shift`](#square_team_publish_scheduled_shift) | PublishScheduledShift | | [`square_team_retrieve_job`](#square_team_retrieve_job) | RetrieveJob | | [`square_team_retrieve_scheduled_shift`](#square_team_retrieve_scheduled_shift) | RetrieveScheduledShift | | [`square_team_retrieve_team_member`](#square_team_retrieve_team_member) | RetrieveTeamMember | | [`square_team_retrieve_timecard`](#square_team_retrieve_timecard) | RetrieveTimecard | | [`square_team_retrieve_wage_setting`](#square_team_retrieve_wage_setting) | RetrieveWageSetting | | [`square_team_search_scheduled_shifts`](#square_team_search_scheduled_shifts) | SearchScheduledShifts | | [`square_team_search_team_members`](#square_team_search_team_members) | SearchTeamMembers | | [`square_team_search_timecards`](#square_team_search_timecards) | SearchTimecards | | [`square_team_update_break_type`](#square_team_update_break_type) | UpdateBreakType | | [`square_team_update_job`](#square_team_update_job) | UpdateJob | | [`square_team_update_scheduled_shift`](#square_team_update_scheduled_shift) | UpdateScheduledShift | | [`square_team_update_team_member`](#square_team_update_team_member) | UpdateTeamMember | | [`square_team_update_timecard`](#square_team_update_timecard) | UpdateTimecard | | [`square_team_update_wage_setting`](#square_team_update_wage_setting) | UpdateWageSetting | | [`square_team_update_workweek_config`](#square_team_update_workweek_config) | UpdateWorkweekConfig | *** ## square\_team\_bulk\_create\_team\_members BulkCreateTeamMembers **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `team_members` | object | Yes | — | The data used to create the `TeamMember` objects. Each key is the `idempotency_key` that maps to the `CreateTeamMemberRequest`. The maximum number of create objects is 25. If you include a team member's `wage_setting`, you must provide `job_id` for each job assignment. To get job IDs, call ListJobs. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "team_members": { "type": "object", "description": "The data used to create the `TeamMember` objects. Each key is the `idempotency_key` that maps to the `CreateTeamMemberRequest`. The maximum number of create objects is 25. If you include a team member's `wage_setting`, you must provide `job_id` for each job assignment. To get job IDs, call [ListJobs](api-endpoint:Team-ListJobs)." } }, "required": [ "PCID", "team_members" ] } ``` *** ## square\_team\_bulk\_publish\_scheduled\_shifts BulkPublishScheduledShifts **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------------------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `scheduled_shift_notification_audience` | string | No | — | Indicates whether Square sends an email notification to team members when a scheduled shift is published and which team members receive the notification. | | `scheduled_shifts` | object | Yes | — | A map of 1 to 100 key-value pairs that represent individual publish requests. - Each key is the ID of a scheduled shift you want to publish. - Each value is a `BulkPublishScheduledShiftsData` object that contains the `version` field or is an empty object. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "scheduled_shift_notification_audience": { "type": "string", "description": "Indicates whether Square sends an email notification to team members when a scheduled shift is published and which team members receive the notification.", "enum": [ "ALL", "AFFECTED", "NONE" ] }, "scheduled_shifts": { "type": "object", "description": "A map of 1 to 100 key-value pairs that represent individual publish requests. - Each key is the ID of a scheduled shift you want to publish. - Each value is a `BulkPublishScheduledShiftsData` object that contains the `version` field or is an empty object." } }, "required": [ "PCID", "scheduled_shifts" ] } ``` *** ## square\_team\_bulk\_update\_team\_members BulkUpdateTeamMembers **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `team_members` | object | Yes | — | The data used to update the `TeamMember` objects. Each key is the `team_member_id` that maps to the `UpdateTeamMemberRequest`. The maximum number of update objects is 25. For each team member, include the fields to add, change, or clear. Fields can be cleared using a null value. To update `wage_setting.job_assignments`, you must provide the complete list of job assignments. If needed, call ListJobs to get the required `job_id` values. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "team_members": { "type": "object", "description": "The data used to update the `TeamMember` objects. Each key is the `team_member_id` that maps to the `UpdateTeamMemberRequest`. The maximum number of update objects is 25. For each team member, include the fields to add, change, or clear. Fields can be cleared using a null value. To update `wage_setting.job_assignments`, you must provide the complete list of job assignments. If needed, call [ListJobs](api-endpoint:Team-ListJobs) to get the required `job_id` values." } }, "required": [ "PCID", "team_members" ] } ``` *** ## square\_team\_create\_break\_type CreateBreakType **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------- | | `break_type` | object | Yes | — | A template for a type of break that can be added to a timecard, including the expected duration and paid status. | | `idempotency_key` | string | No | — | A unique string value to ensure the idempotency of the operation. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "break_type": { "type": "object", "description": "A template for a type of [break](entity:Break) that can be added to a [timecard](entity:Timecard), including the expected duration and paid status.", "properties": { "id": { "type": "string", "description": "The UUID for this object." }, "location_id": { "type": "string", "description": "The ID of the business location this type of break applies to." }, "break_name": { "type": "string", "description": "A human-readable name for this type of break. The name is displayed to team members in Square products." }, "expected_duration": { "type": "string", "description": "Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of this break. Precision less than minutes is truncated. Example for break expected duration of 15 minutes: PT15M" }, "is_paid": { "type": "boolean", "description": "Whether this break counts towards time worked for compensation purposes." }, "version": { "type": "integer", "description": "Used for resolving concurrency issues. The request fails if the version provided does not match the server version at the time of the request. If a value is not provided, Square's servers execute a \"blind\" write; potentially overwriting another writer's data." }, "created_at": { "type": "string", "description": "A read-only timestamp in RFC 3339 format." }, "updated_at": { "type": "string", "description": "A read-only timestamp in RFC 3339 format." } }, "required": [ "location_id", "break_name", "expected_duration", "is_paid" ] }, "idempotency_key": { "type": "string", "description": "A unique string value to ensure the idempotency of the operation." } }, "required": [ "PCID", "break_type" ] } ``` *** ## square\_team\_create\_job CreateJob **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `idempotency_key` | string | Yes | — | A unique identifier for the `CreateJob` request. Keys can be any valid string, but must be unique for each request. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). | | `job` | object | Yes | — | Represents a job that can be assigned to team members. This object defines the job's title and tip eligibility. Compensation is defined in a job assignment in a team member's wage setting. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "idempotency_key": { "type": "string", "description": "A unique identifier for the `CreateJob` request. Keys can be any valid string, but must be unique for each request. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)." }, "job": { "type": "object", "description": "Represents a job that can be assigned to [team members](entity:TeamMember). This object defines the job's title and tip eligibility. Compensation is defined in a [job assignment](entity:JobAssignment) in a team member's wage setting.", "properties": { "id": { "type": "string", "description": "**Read only** The unique Square-assigned ID of the job. If you need a job ID for an API request, call [ListJobs](api-endpoint:Team-ListJobs) or use the ID returned when you created the job. You can also get job IDs from a team member's wage setting." }, "title": { "type": "string", "description": "The title of the job." }, "is_tip_eligible": { "type": "boolean", "description": "Indicates whether team members can earn tips for the job." }, "created_at": { "type": "string", "description": "The timestamp when the job was created, in RFC 3339 format." }, "updated_at": { "type": "string", "description": "The timestamp when the job was last updated, in RFC 3339 format." }, "version": { "type": "integer", "description": "**Read only** The current version of the job. Include this field in `UpdateJob` requests to enable [optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency) control and avoid overwrites from concurrent requests. Requests fail if the provided version doesn't match the server version at the time of the request." } } } }, "required": [ "PCID", "idempotency_key", "job" ] } ``` *** ## square\_team\_create\_scheduled\_shift CreateScheduledShift **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `idempotency_key` | string | No | — | A unique identifier for the `CreateScheduledShift` request, used to ensure the [idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) of the operation. | | `scheduled_shift` | object | Yes | — | Represents a specific time slot in a work schedule. This object is used to manage the lifecycle of a scheduled shift from the draft to published state. A scheduled shift contains the latest draft shift details and current published shift details. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "idempotency_key": { "type": "string", "description": "A unique identifier for the `CreateScheduledShift` request, used to ensure the [idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) of the operation." }, "scheduled_shift": { "type": "object", "description": "Represents a specific time slot in a work schedule. This object is used to manage the lifecycle of a scheduled shift from the draft to published state. A scheduled shift contains the latest draft shift details and current published shift details.", "properties": { "id": { "type": "string", "description": "**Read only** The Square-issued ID of the scheduled shift." }, "draft_shift_details": { "type": "object", "description": "Represents shift details for draft and published versions of a [scheduled shift](entity:ScheduledShift), such as job ID, team member assignment, and start and end times." }, "published_shift_details": { "type": "object", "description": "Represents shift details for draft and published versions of a [scheduled shift](entity:ScheduledShift), such as job ID, team member assignment, and start and end times." }, "version": { "type": "integer", "description": "**Read only** The current version of the scheduled shift, which is incremented with each update. This field is used for [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control to ensure that requests don't overwrite data from another request." }, "created_at": { "type": "string", "description": "The timestamp of when the scheduled shift was created, in RFC 3339 format presented as UTC." }, "updated_at": { "type": "string", "description": "The timestamp of when the scheduled shift was last updated, in RFC 3339 format presented as UTC." } } } }, "required": [ "PCID", "scheduled_shift" ] } ``` *** ## square\_team\_create\_team\_member CreateTeamMember **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `idempotency_key` | string | No | — | A unique string that identifies this `CreateTeamMember` request. Keys can be any valid string, but must be unique for every request. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). The minimum length is 1 and the maximum length is 45. | | `team_member` | object | No | — | A record representing an individual team member for a business. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "idempotency_key": { "type": "string", "description": "A unique string that identifies this `CreateTeamMember` request. Keys can be any valid string, but must be unique for every request. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). The minimum length is 1 and the maximum length is 45." }, "team_member": { "type": "object", "description": "A record representing an individual team member for a business.", "properties": { "id": { "type": "string", "description": "The unique ID for the team member." }, "reference_id": { "type": "string", "description": "A second ID used to associate the team member with an entity in another system." }, "is_owner": { "type": "boolean", "description": "Whether the team member is the owner of the Square account." }, "status": { "type": "string", "description": "Enumerates the possible statuses the team member can have within a business.", "enum": [ "ACTIVE", "INACTIVE" ] }, "given_name": { "type": "string", "description": "The given name (that is, the first name) associated with the team member." }, "family_name": { "type": "string", "description": "The family name (that is, the last name) associated with the team member." }, "email_address": { "type": "string", "description": "The email address associated with the team member. After accepting the invitation from Square, only the team member can change this value." }, "phone_number": { "type": "string", "description": "The team member's phone number, in E.164 format. For example: +14155552671 - the country code is 1 for US +551155256325 - the country code is 55 for BR" }, "created_at": { "type": "string", "description": "The timestamp when the team member was created, in RFC 3339 format." }, "updated_at": { "type": "string", "description": "The timestamp when the team member was last updated, in RFC 3339 format." }, "assigned_locations": { "type": "object", "description": "An object that represents a team member's assignment to locations." }, "wage_setting": { "type": "object", "description": "Represents information about the overtime exemption status, job assignments, and compensation for a [team member](entity:TeamMember)." } } } }, "required": [ "PCID" ] } ``` *** ## square\_team\_create\_timecard CreateTimecard **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `idempotency_key` | string | No | — | A unique string value to ensure the idempotency of the operation. | | `timecard` | object | Yes | — | A record of the hourly rate, start time, and end time of a single timecard (shift) for a team member. This might include a record of the start and end times of breaks taken during the shift. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "idempotency_key": { "type": "string", "description": "A unique string value to ensure the idempotency of the operation." }, "timecard": { "type": "object", "description": "A record of the hourly rate, start time, and end time of a single timecard (shift) for a team member. This might include a record of the start and end times of breaks taken during the shift.", "properties": { "id": { "type": "string", "description": "**Read only** The Square-issued UUID for this object." }, "location_id": { "type": "string", "description": "The ID of the [location](entity:Location) for this timecard. The location should be based on where the team member clocked in." }, "timezone": { "type": "string", "description": "**Read only** The time zone calculated from the location based on the `location_id`, provided as a convenience value. Format: the IANA time zone database identifier for the location time zone." }, "start_at": { "type": "string", "description": "The start time of the timecard, in RFC 3339 format and shifted to the location timezone + offset. Precision up to the minute is respected; seconds are truncated." }, "end_at": { "type": "string", "description": "The end time of the timecard, in RFC 3339 format and shifted to the location timezone + offset. Precision up to the minute is respected; seconds are truncated." }, "wage": { "type": "object", "description": "The hourly wage rate used to compensate a team member for a [timecard](entity:Timecard)." }, "breaks": { "type": "array", "items": { "type": "object" }, "description": "A list of all the paid or unpaid breaks that were taken during this timecard." }, "status": { "type": "string", "description": "**Read only** Enumerates the possible status of a [timecard](entity:Timecard).", "enum": [ "OPEN", "CLOSED" ] }, "version": { "type": "integer", "description": "**Read only** The current version of the timecard, which is incremented with each update. This field is used for [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control to ensure that requests don't overwrite data from another request." }, "created_at": { "type": "string", "description": "The timestamp of when the timecard was created, in RFC 3339 format presented as UTC." }, "updated_at": { "type": "string", "description": "The timestamp of when the timecard was last updated, in RFC 3339 format presented as UTC." }, "team_member_id": { "type": "string", "description": "The ID of the [team member](entity:TeamMember) this timecard belongs to." }, "declared_cash_tip_money": { "type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information." } }, "required": [ "location_id", "start_at", "team_member_id" ] } }, "required": [ "PCID", "timecard" ] } ``` *** ## square\_team\_delete\_break\_type DeleteBreakType **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------- | | `id` | string | Yes | — | The UUID for the `BreakType` being deleted. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The UUID for the `BreakType` being deleted." } }, "required": [ "PCID", "id" ] } ``` *** ## square\_team\_delete\_timecard DeleteTimecard **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------ | | `id` | string | Yes | — | The UUID for the `Timecard` being deleted. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The UUID for the `Timecard` being deleted." } }, "required": [ "PCID", "id" ] } ``` *** ## square\_team\_get\_break\_type GetBreakType **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | --------------------------------------------- | | `id` | string | Yes | — | The UUID for the `BreakType` being retrieved. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The UUID for the `BreakType` being retrieved." } }, "required": [ "PCID", "id" ] } ``` *** ## square\_team\_get\_member\_wage GetTeamMemberWage **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | -------------------------------------------------- | | `id` | string | Yes | — | The UUID for the `TeamMemberWage` being retrieved. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The UUID for the `TeamMemberWage` being retrieved." } }, "required": [ "PCID", "id" ] } ``` *** ## square\_team\_list\_break\_types ListBreakTypes **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------- | | `location_id` | string | No | — | Filter the returned `BreakType` results to only those that are associated with the specified location. | | `limit` | integer | No | — | The maximum number of `BreakType` results to return per page. The number can range between 1 and 200. The default is 200. | | `cursor` | string | No | — | A pointer to the next page of `BreakType` results to fetch. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "location_id": { "type": "string", "description": "Filter the returned `BreakType` results to only those that are associated with the specified location." }, "limit": { "type": "integer", "description": "The maximum number of `BreakType` results to return per page. The number can range between 1 and 200. The default is 200." }, "cursor": { "type": "string", "description": "A pointer to the next page of `BreakType` results to fetch." } }, "required": [ "PCID" ] } ``` *** ## square\_team\_list\_jobs ListJobs **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `cursor` | string | No | — | The pagination cursor returned by the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "The pagination cursor returned by the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." } }, "required": [ "PCID" ] } ``` *** ## square\_team\_list\_team\_member\_wages ListTeamMemberWages **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `team_member_id` | string | No | — | Filter the returned wages to only those that are associated with the specified team member. | | `limit` | integer | No | — | The maximum number of `TeamMemberWage` results to return per page. The number can range between 1 and 200. The default is 200. | | `cursor` | string | No | — | A pointer to the next page of `EmployeeWage` results to fetch. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "team_member_id": { "type": "string", "description": "Filter the returned wages to only those that are associated with the specified team member." }, "limit": { "type": "integer", "description": "The maximum number of `TeamMemberWage` results to return per page. The number can range between 1 and 200. The default is 200." }, "cursor": { "type": "string", "description": "A pointer to the next page of `EmployeeWage` results to fetch." } }, "required": [ "PCID" ] } ``` *** ## square\_team\_list\_workweek\_configs ListWorkweekConfigs **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------------------------------------------------------- | | `limit` | integer | No | — | The maximum number of `WorkweekConfigs` results to return per page. | | `cursor` | string | No | — | A pointer to the next page of `WorkweekConfig` results to fetch. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "The maximum number of `WorkweekConfigs` results to return per page." }, "cursor": { "type": "string", "description": "A pointer to the next page of `WorkweekConfig` results to fetch." } }, "required": [ "PCID" ] } ``` *** ## square\_team\_publish\_scheduled\_shift PublishScheduledShift **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | string | Yes | — | The ID of the scheduled shift to publish. | | `idempotency_key` | string | Yes | — | A unique identifier for the `PublishScheduledShift` request, used to ensure the [idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) of the operation. | | `scheduled_shift_notification_audience` | string | No | — | Indicates whether Square sends an email notification to team members when a scheduled shift is published and which team members receive the notification. | | `version` | integer | No | — | The current version of the scheduled shift, used to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. If the provided version doesn't match the server version, the request fails. If omitted, Square executes a blind write, potentially overwriting data from another publish request. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the scheduled shift to publish." }, "idempotency_key": { "type": "string", "description": "A unique identifier for the `PublishScheduledShift` request, used to ensure the [idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) of the operation." }, "scheduled_shift_notification_audience": { "type": "string", "description": "Indicates whether Square sends an email notification to team members when a scheduled shift is published and which team members receive the notification.", "enum": [ "ALL", "AFFECTED", "NONE" ] }, "version": { "type": "integer", "description": "The current version of the scheduled shift, used to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. If the provided version doesn't match the server version, the request fails. If omitted, Square executes a blind write, potentially overwriting data from another publish request." } }, "required": [ "PCID", "id", "idempotency_key" ] } ``` *** ## square\_team\_retrieve\_job RetrieveJob **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------ | | `job_id` | string | Yes | — | The ID of the job to retrieve. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "job_id": { "type": "string", "description": "The ID of the job to retrieve." } }, "required": [ "PCID", "job_id" ] } ``` *** ## square\_team\_retrieve\_scheduled\_shift RetrieveScheduledShift **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------ | | `id` | string | Yes | — | The ID of the scheduled shift to retrieve. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the scheduled shift to retrieve." } }, "required": [ "PCID", "id" ] } ``` *** ## square\_team\_retrieve\_team\_member RetrieveTeamMember **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | -------------------------------------- | | `team_member_id` | string | Yes | — | The ID of the team member to retrieve. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "team_member_id": { "type": "string", "description": "The ID of the team member to retrieve." } }, "required": [ "PCID", "team_member_id" ] } ``` *** ## square\_team\_retrieve\_timecard RetrieveTimecard **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | -------------------------------------------- | | `id` | string | Yes | — | The UUID for the `Timecard` being retrieved. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The UUID for the `Timecard` being retrieved." } }, "required": [ "PCID", "id" ] } ``` *** ## square\_team\_retrieve\_wage\_setting RetrieveWageSetting **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | ----------------------------------------------------------------- | | `team_member_id` | string | Yes | — | The ID of the team member for which to retrieve the wage setting. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "team_member_id": { "type": "string", "description": "The ID of the team member for which to retrieve the wage setting." } }, "required": [ "PCID", "team_member_id" ] } ``` *** ## square\_team\_search\_scheduled\_shifts SearchScheduledShifts **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `cursor` | string | No | — | The pagination cursor returned by the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | | `limit` | integer | No | — | The maximum number of results to return in a single response page. The default value is 50. | | `query` | object | No | — | Represents filter and sort criteria for the `query` field in a SearchScheduledShifts request. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "The pagination cursor returned by the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)." }, "limit": { "type": "integer", "description": "The maximum number of results to return in a single response page. The default value is 50." }, "query": { "type": "object", "description": "Represents filter and sort criteria for the `query` field in a [SearchScheduledShifts](api-endpoint:Labor-SearchScheduledShifts) request.", "properties": { "filter": { "type": "object", "description": "Defines filter criteria for a [SearchScheduledShifts](api-endpoint:Labor-SearchScheduledShifts) request. Multiple filters in a query are combined as an `AND` operation." }, "sort": { "type": "object", "description": "Defines sort criteria for a [SearchScheduledShifts](api-endpoint:Labor-SearchScheduledShifts) request." } } } }, "required": [ "PCID" ] } ``` *** ## square\_team\_search\_team\_members SearchTeamMembers **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `cursor` | string | No | — | The opaque cursor for fetching the next page. For more information, see [pagination](https://developer.squareup.com/docs/working-with-apis/pagination). | | `limit` | integer | No | — | The maximum number of `TeamMember` objects in a page (100 by default). | | `query` | object | No | — | Represents the parameters in a search for `TeamMember` objects. | ````json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "The opaque cursor for fetching the next page. For more information, see [pagination](https://developer.squareup.com/docs/working-with-apis/pagination)." }, "limit": { "type": "integer", "description": "The maximum number of `TeamMember` objects in a page (100 by default)." }, "query": { "type": "object", "description": "Represents the parameters in a search for `TeamMember` objects.", "properties": { "filter": { "type": "object", "description": "Represents a filter used in a search for `TeamMember` objects. `AND` logic is applied between the individual fields, and `OR` logic is applied within list-based fields. For example, setting this filter value: ``` filter = (locations_ids = [\"A\", \"B\"], status = ACTIVE) ``` returns only active team members assigned to either location \"A\" or \"B\"." } } } }, "required": [ "PCID" ] } ```` *** ## square\_team\_search\_timecards SearchTimecards **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------ | | `cursor` | string | No | — | An opaque cursor for fetching the next page. | | `limit` | integer | No | — | The number of resources in a page (200 by default). | | `query` | object | No | — | The parameters of a `Timecard` search query, which includes filter and sort options. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "An opaque cursor for fetching the next page." }, "limit": { "type": "integer", "description": "The number of resources in a page (200 by default)." }, "query": { "type": "object", "description": "The parameters of a `Timecard` search query, which includes filter and sort options.", "properties": { "filter": { "type": "object", "description": "Defines a filter used in a search for `Timecard` records. `AND` logic is used by Square's servers to apply each filter property specified." }, "sort": { "type": "object", "description": "Sets the sort order of search results." } } } }, "required": [ "PCID" ] } ``` *** ## square\_team\_update\_break\_type UpdateBreakType **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------- | | `id` | string | Yes | — | The UUID for the `BreakType` being updated. | | `break_type` | object | Yes | — | A template for a type of break that can be added to a timecard, including the expected duration and paid status. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The UUID for the `BreakType` being updated." }, "break_type": { "type": "object", "description": "A template for a type of [break](entity:Break) that can be added to a [timecard](entity:Timecard), including the expected duration and paid status.", "properties": { "id": { "type": "string", "description": "The UUID for this object." }, "location_id": { "type": "string", "description": "The ID of the business location this type of break applies to." }, "break_name": { "type": "string", "description": "A human-readable name for this type of break. The name is displayed to team members in Square products." }, "expected_duration": { "type": "string", "description": "Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of this break. Precision less than minutes is truncated. Example for break expected duration of 15 minutes: PT15M" }, "is_paid": { "type": "boolean", "description": "Whether this break counts towards time worked for compensation purposes." }, "version": { "type": "integer", "description": "Used for resolving concurrency issues. The request fails if the version provided does not match the server version at the time of the request. If a value is not provided, Square's servers execute a \"blind\" write; potentially overwriting another writer's data." }, "created_at": { "type": "string", "description": "A read-only timestamp in RFC 3339 format." }, "updated_at": { "type": "string", "description": "A read-only timestamp in RFC 3339 format." } }, "required": [ "location_id", "break_name", "expected_duration", "is_paid" ] } }, "required": [ "PCID", "id", "break_type" ] } ``` *** ## square\_team\_update\_job UpdateJob **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `job_id` | string | Yes | — | The ID of the job to update. | | `job` | object | Yes | — | Represents a job that can be assigned to team members. This object defines the job's title and tip eligibility. Compensation is defined in a job assignment in a team member's wage setting. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "job_id": { "type": "string", "description": "The ID of the job to update." }, "job": { "type": "object", "description": "Represents a job that can be assigned to [team members](entity:TeamMember). This object defines the job's title and tip eligibility. Compensation is defined in a [job assignment](entity:JobAssignment) in a team member's wage setting.", "properties": { "id": { "type": "string", "description": "**Read only** The unique Square-assigned ID of the job. If you need a job ID for an API request, call [ListJobs](api-endpoint:Team-ListJobs) or use the ID returned when you created the job. You can also get job IDs from a team member's wage setting." }, "title": { "type": "string", "description": "The title of the job." }, "is_tip_eligible": { "type": "boolean", "description": "Indicates whether team members can earn tips for the job." }, "created_at": { "type": "string", "description": "The timestamp when the job was created, in RFC 3339 format." }, "updated_at": { "type": "string", "description": "The timestamp when the job was last updated, in RFC 3339 format." }, "version": { "type": "integer", "description": "**Read only** The current version of the job. Include this field in `UpdateJob` requests to enable [optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency) control and avoid overwrites from concurrent requests. Requests fail if the provided version doesn't match the server version at the time of the request." } } } }, "required": [ "PCID", "job_id", "job" ] } ``` *** ## square\_team\_update\_scheduled\_shift UpdateScheduledShift **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | string | Yes | — | The ID of the scheduled shift to update. | | `scheduled_shift` | object | Yes | — | Represents a specific time slot in a work schedule. This object is used to manage the lifecycle of a scheduled shift from the draft to published state. A scheduled shift contains the latest draft shift details and current published shift details. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the scheduled shift to update." }, "scheduled_shift": { "type": "object", "description": "Represents a specific time slot in a work schedule. This object is used to manage the lifecycle of a scheduled shift from the draft to published state. A scheduled shift contains the latest draft shift details and current published shift details.", "properties": { "id": { "type": "string", "description": "**Read only** The Square-issued ID of the scheduled shift." }, "draft_shift_details": { "type": "object", "description": "Represents shift details for draft and published versions of a [scheduled shift](entity:ScheduledShift), such as job ID, team member assignment, and start and end times." }, "published_shift_details": { "type": "object", "description": "Represents shift details for draft and published versions of a [scheduled shift](entity:ScheduledShift), such as job ID, team member assignment, and start and end times." }, "version": { "type": "integer", "description": "**Read only** The current version of the scheduled shift, which is incremented with each update. This field is used for [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control to ensure that requests don't overwrite data from another request." }, "created_at": { "type": "string", "description": "The timestamp of when the scheduled shift was created, in RFC 3339 format presented as UTC." }, "updated_at": { "type": "string", "description": "The timestamp of when the scheduled shift was last updated, in RFC 3339 format presented as UTC." } } } }, "required": [ "PCID", "id", "scheduled_shift" ] } ``` *** ## square\_team\_update\_team\_member UpdateTeamMember **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | --------------------------------------------------------------- | | `team_member_id` | string | Yes | — | The ID of the team member to update. | | `team_member` | object | No | — | A record representing an individual team member for a business. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "team_member_id": { "type": "string", "description": "The ID of the team member to update." }, "team_member": { "type": "object", "description": "A record representing an individual team member for a business.", "properties": { "id": { "type": "string", "description": "The unique ID for the team member." }, "reference_id": { "type": "string", "description": "A second ID used to associate the team member with an entity in another system." }, "is_owner": { "type": "boolean", "description": "Whether the team member is the owner of the Square account." }, "status": { "type": "string", "description": "Enumerates the possible statuses the team member can have within a business.", "enum": [ "ACTIVE", "INACTIVE" ] }, "given_name": { "type": "string", "description": "The given name (that is, the first name) associated with the team member." }, "family_name": { "type": "string", "description": "The family name (that is, the last name) associated with the team member." }, "email_address": { "type": "string", "description": "The email address associated with the team member. After accepting the invitation from Square, only the team member can change this value." }, "phone_number": { "type": "string", "description": "The team member's phone number, in E.164 format. For example: +14155552671 - the country code is 1 for US +551155256325 - the country code is 55 for BR" }, "created_at": { "type": "string", "description": "The timestamp when the team member was created, in RFC 3339 format." }, "updated_at": { "type": "string", "description": "The timestamp when the team member was last updated, in RFC 3339 format." }, "assigned_locations": { "type": "object", "description": "An object that represents a team member's assignment to locations." }, "wage_setting": { "type": "object", "description": "Represents information about the overtime exemption status, job assignments, and compensation for a [team member](entity:TeamMember)." } } } }, "required": [ "PCID", "team_member_id" ] } ``` *** ## square\_team\_update\_timecard UpdateTimecard **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | string | Yes | — | The ID of the object being updated. | | `timecard` | object | Yes | — | A record of the hourly rate, start time, and end time of a single timecard (shift) for a team member. This might include a record of the start and end times of breaks taken during the shift. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the object being updated." }, "timecard": { "type": "object", "description": "A record of the hourly rate, start time, and end time of a single timecard (shift) for a team member. This might include a record of the start and end times of breaks taken during the shift.", "properties": { "id": { "type": "string", "description": "**Read only** The Square-issued UUID for this object." }, "location_id": { "type": "string", "description": "The ID of the [location](entity:Location) for this timecard. The location should be based on where the team member clocked in." }, "timezone": { "type": "string", "description": "**Read only** The time zone calculated from the location based on the `location_id`, provided as a convenience value. Format: the IANA time zone database identifier for the location time zone." }, "start_at": { "type": "string", "description": "The start time of the timecard, in RFC 3339 format and shifted to the location timezone + offset. Precision up to the minute is respected; seconds are truncated." }, "end_at": { "type": "string", "description": "The end time of the timecard, in RFC 3339 format and shifted to the location timezone + offset. Precision up to the minute is respected; seconds are truncated." }, "wage": { "type": "object", "description": "The hourly wage rate used to compensate a team member for a [timecard](entity:Timecard)." }, "breaks": { "type": "array", "items": { "type": "object" }, "description": "A list of all the paid or unpaid breaks that were taken during this timecard." }, "status": { "type": "string", "description": "**Read only** Enumerates the possible status of a [timecard](entity:Timecard).", "enum": [ "OPEN", "CLOSED" ] }, "version": { "type": "integer", "description": "**Read only** The current version of the timecard, which is incremented with each update. This field is used for [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control to ensure that requests don't overwrite data from another request." }, "created_at": { "type": "string", "description": "The timestamp of when the timecard was created, in RFC 3339 format presented as UTC." }, "updated_at": { "type": "string", "description": "The timestamp of when the timecard was last updated, in RFC 3339 format presented as UTC." }, "team_member_id": { "type": "string", "description": "The ID of the [team member](entity:TeamMember) this timecard belongs to." }, "declared_cash_tip_money": { "type": "object", "description": "Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information." } }, "required": [ "location_id", "start_at", "team_member_id" ] } }, "required": [ "PCID", "id", "timecard" ] } ``` *** ## square\_team\_update\_wage\_setting UpdateWageSetting **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------- | | `team_member_id` | string | Yes | — | The ID of the team member for which to update the `WageSetting` object. | | `wage_setting` | object | Yes | — | Represents information about the overtime exemption status, job assignments, and compensation for a team member. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "team_member_id": { "type": "string", "description": "The ID of the team member for which to update the `WageSetting` object." }, "wage_setting": { "type": "object", "description": "Represents information about the overtime exemption status, job assignments, and compensation for a [team member](entity:TeamMember).", "properties": { "team_member_id": { "type": "string", "description": "The ID of the team member associated with the wage setting." }, "job_assignments": { "type": "array", "items": { "type": "object" }, "description": "**Required** The ordered list of jobs that the team member is assigned to. The first job assignment is considered the team member's primary job." }, "is_overtime_exempt": { "type": "boolean", "description": "Whether the team member is exempt from the overtime rules of the seller's country." }, "version": { "type": "integer", "description": "**Read only** Used for resolving concurrency issues. The request fails if the version provided does not match the server version at the time of the request. If not provided, Square executes a blind write, potentially overwriting data from another write. For more information, see [optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency)." }, "created_at": { "type": "string", "description": "The timestamp when the wage setting was created, in RFC 3339 format." }, "updated_at": { "type": "string", "description": "The timestamp when the wage setting was last updated, in RFC 3339 format." } } } }, "required": [ "PCID", "team_member_id", "wage_setting" ] } ``` *** ## square\_team\_update\_workweek\_config UpdateWorkweekConfig **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------- | | `id` | string | Yes | — | The UUID for the `WorkweekConfig` object being updated. | | `workweek_config` | object | Yes | — | Sets the day of the week and hour of the day that a business starts a workweek. This is used to calculate overtime pay. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The UUID for the `WorkweekConfig` object being updated." }, "workweek_config": { "type": "object", "description": "Sets the day of the week and hour of the day that a business starts a workweek. This is used to calculate overtime pay.", "properties": { "id": { "type": "string", "description": "The UUID for this object." }, "start_of_week": { "type": "string", "description": "The days of the week.", "enum": [ "MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN" ] }, "start_of_day_local_time": { "type": "string", "description": "The local time at which a business week starts. Represented as a string in `HH:MM` format (`HH:MM:SS` is also accepted, but seconds are truncated)." }, "version": { "type": "integer", "description": "Used for resolving concurrency issues. The request fails if the version provided does not match the server version at the time of the request. If not provided, Square executes a blind write; potentially overwriting data from another write." }, "created_at": { "type": "string", "description": "A read-only timestamp in RFC 3339 format; presented in UTC." }, "updated_at": { "type": "string", "description": "A read-only timestamp in RFC 3339 format; presented in UTC." } }, "required": [ "start_of_week", "start_of_day_local_time" ] } }, "required": [ "PCID", "id", "workweek_config" ] } ```