---
title: "FieldPermissions.list"
method: GET
path: "/entities/FieldPermissions"
tags: ["Field"]
---

# FieldPermissions.list

`GET /entities/FieldPermissions`

## Request

- Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id`
- URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/FieldPermissions`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/coevera/apis/coevera-crm-api/docs/entities/FieldPermissions/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a page of FieldPermission records, optionally filtered, sorted and limited to selected fields.

## Query parameters

- `include-deleted` boolean
- `first` integer
- `last` integer
- `before` string
- `after` string
- `expand` string
- `order-by` string
- `filter` object
- `filter-op` object
- `load-only` string

## Response `200`

Page of FieldPermission records.

- object
  - `success` boolean: True when the request succeeded; false on error.
  - `data` FieldPermission[]
    - `is_delete_protected` boolean, required: True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
    - `has_draft` boolean, required: True when the record has unpublished draft changes, including pending translation changes, that can be published.
    - `id` string, uuid, required: Unique identifier of entity.
    - `is_deleted` boolean: Specifies if the entity is considered deleted.
    - `modified` string, date-time: Last modification time.
    - `created` string, date-time: Creation time.
    - `field` string, uri, required: Custom field this permission applies to. Related Field record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Field' for its fields.
    - `master_right` string, uri, required: User role granted (or restricted) on the field. Related MasterRight record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'MasterRight' for its fields.
    - `field_id` string, uuid, required: Id of the custom field.
    - `master_right_id` string, uuid, required: Id of the user role.
    - `permission_level` 1 | 2 | 3: Access the user role gets to the custom field: full access (view and edit), read-only, or hidden. Integer enum value: 1 - FullAccess, 2 - Readonly, 3 - NoAccess
    - `is_published` boolean: True when the permission override is published; false while it exists only as an unpublished draft.
    - `revision` integer: Revision when entity was lastly changed.
  - `page_info` object: Pagination of the result; not returned when the legacy limit and offset parameters are used.
    - `start_cursor` string: Cursor of the first record of the page.
    - `end_cursor` string: Cursor of the last record of the page.
    - `has_previous_page` boolean: Whether records exist before this page; pass start_cursor as before to load them.
    - `has_next_page` boolean: Whether records exist after this page; pass end_cursor as after to load them.
  - `total` integer: Number of records that match the request, across all pages.

## Other responses

- `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`.
- `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED).
- `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry.
- `500`: Unexpected server error (code 1000, ERROR_UNKNOWN).

---

[API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)