job.md

Job

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.

Structure

Job

Fields

Name	Type	Tags	Description
id	str	Optional	Read only The unique Square-assigned ID of the job. If you need a job ID for an API request, call 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	str	Optional	The title of the job. Constraints: Maximum Length: 150
is_tip_eligible	bool	Optional	Indicates whether team members can earn tips for the job.
created_at	str	Optional	The timestamp when the job was created, in RFC 3339 format.
updated_at	str	Optional	The timestamp when the job was last updated, in RFC 3339 format.
version	int	Optional	Read only The current version of the job. Include this field in UpdateJob requests to enable 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.

Example (as JSON)

{
  "id": "id6",
  "title": "title2",
  "is_tip_eligible": false,
  "created_at": "created_at4",
  "updated_at": "updated_at2"
}