Retrieve a specific break policy

GET

/break-policies/{id}/

Retrieves details for a specific break policy by ID.

Helpful resources

• Manage Time Entries

Required Scopes

• break-policies.read

Request

Path Parameters

id idrequired

ID of the resource to return

Responses

200

Successful response

application/json

Schema

Schema

__meta object
redacted_fields object[]
Array [
name string
The name for the redacted field
reason string
The reason for the redaction
]
id stringrequired
Identifier field
created_at stringrequired
Record creation date
updated_at stringrequired
Record update date
name stringrequired
The display name of the break policy. For default policies this is the system-generated label (e.g. 'Default Break policy: All Workers | California'); for custom policies this is the admin-provided description.
country_code string
ISO 3166-1 alpha-2 country code the policy applies to (e.g. 'US', 'CA', 'GB').
is_default boolean
Whether this is a system-seeded default policy (true) or a custom policy created by an admin (false).

Example (from schema)

{
  "__meta": {
    "redacted_fields": [
      {
        "name": "date_of_birth",
        "reason": "Insufficient entitlements"
      }
    ]
  },
  "id": "string",
  "created_at": "string",
  "updated_at": "string",
  "name": "string",
  "country_code": "string",
  "is_default": false
}

Loading...