v1

latestOpenAPI 3.0.32026-07-24198357534.7 KB

User & Permission

This endpoint provides a list of Field Permissions, it can be paginated with the pagination=true parameter

Retrieves the collection of PermissionField resources.

get/permissions/fields

Query parameters

pageinteger

The collection page number

limitinteger

The number of items per page

paginationboolean

Enable or disable pagination

order[id]'asc' | 'desc'

order[name]'asc' | 'desc'

Response

PermissionField collection

fieldsVisiblestring[]

This array should contains Field Identifiers.

fieldsEditablestring[]

This array should contains Field Identifiers.

dateCreatedstring date-time nullable

This is an ISO datetime

dateModifiedstring date-time nullable

This is an ISO datetime

idstring

This is the unique identifier of the resource

Example response

[
  {
    "fieldsVisible": [
      "field_id_1",
      "field_id_2"
    ],
    "fieldsEditable": [
      "field_id_1",
      "field_id_2"
    ],
    "name": {
      "fr-FR": "fr-FR translation",
      "en-US": "en-US translation",
      "<*>": "..."
    },
    "description": {
      "fr-FR": "fr-FR translation",
      "en-US": "en-US translation",
      "<*>": "..."
    },
    "id": "identifier_example",
    "users": [
      {
        "id": "identifier_example"
      }
    ]
  }
]