Sign in
Roles

Update Multiple Roles

Update multiple roles at the same time.

patch/roles

Query parameters

fieldsstring[]

Control what fields are being returned in the object.

limitinteger

A limit on the number of objects that are returned.

metastring

What metadata to return in the response.

offsetinteger

How many items to skip when fetching data.

sortstring[]

How to sort the returned items. sort is a CSV of fields used to sort the fetched items. Sorting defaults to ascending (ASC) order but a minus sign (-) can be used to reverse this to descending (DESC) order. Fields are prioritized by their order in the CSV. You can also use a ? to sort randomly.

Select items in collection by given conditions.

searchstring

Filter by items that contain the given search query in one of their fields.

Request body

keysstring[]

Example request

{
  "data": {
    "name": "Interns"
  }
}

Response

Successful request

Example response

{
  "data": [
    {
      "id": "2f24211d-d928-469a-aea3-3c8f53d4e426",
      "name": "Administrator",
      "icon": "verified_user",
      "description": "Admins have access to all managed data within the system by default",
      "users": [
        {
          "id": "63716273-0f29-4648-8a2a-2af2948f6f78",
          "first_name": "Admin",
          "last_name": "User",
          "email": "admin@example.com",
          "avatar": {
            "id": "8cbb43fe-4cdf-4991-8352-c461779cec02",
            "storage": "local",
            "filename_disk": "a88c3b72-ac58-5436-a4ec-b2858531333a.jpg",
            "filename_download": "avatar.jpg",
            "title": "User Avatar",
            "type": "image/jpeg",
            "folder": {
              "id": "0cf0e03d-4364-45df-b77b-ca61f61869d2",
              "name": "New York"
            },
            "created_on": "2019-12-03T00:10:15+00:00",
            "charset": "binary",
            "filesize": 137862,
            "width": 800,
            "height": 838,
            "uploaded_on": "2019-12-03T00:10:15+00:00"
          },
          "language": "en-US",
          "status": "active",
          "last_access": "2020-05-31T14:32:37Z",
          "last_page": "/my-project/settings/collections/a"
        }
      ]
    }
  ]
}

Changes