# List break policies

> A list of break policies.

GET

/break-policies/

Returns a paginated list of break policies used to configure rest and meal breaks in Time & Attendance.

#### Helpful resources

-   [Manage Time Entries](https://developer.rippling.com/documentation/rest-api/guides/create-time-entry)

### Required Scopes

-   break-policies.read
    

### Request

Query Parameters

**order\_by** string

**limit** integer required

**Possible values:** `>= 1` and `<= 100`

**Default value:** `50`

The maximum number of results to return. Defaults to 50. Maximum is 100.

**cursor** string

#### Sorting results

Include one or more of these fields in the [sort parameter](https://developer.rippling.com/documentation/rest-api/essentials/query-parameters#sort-order_by) to control result order.

Fields:id, created\_at, updated\_at

## Responses

-   200

Successful response

-   application/json

-   Schema
-   Example (from schema)

**Schema**

**\_\_meta** object

A list of redacted fields.

**redacted\_fields** object\[\]

Array \[

**name** string

The name for the redacted field

**reason** string

The reason for the redaction

\]

**results** object\[\]

Array \[

**id** string required

Identifier field

**created\_at** string required

Record creation date

**updated\_at** string required

Record update date

**name** string required

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).

\]

**next\_link** string

A link to the next page of responses.

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

Source: https://developer.rippling.com/documentation/rest-api/reference/list-break-policies

> For the complete documentation index, see [llms.txt](https://developer.rippling.com/llms.txt). Public pages have a Markdown version at the same URL with .md added.