Assignments

Listing all Actors assigned some Role

Changed on

Given a roleId, which may be a numeric ID or a string role system name, this endpoint lists all Actors that have been assigned that Role on a server-wide basis.

get/v1/assignments/{roleId}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/assignments/{roleId}
  • Auth
    none declared

Path parameters

roleIdstring required

Typically the integer ID of the Role. You may also supply the Role system name if it has one.

Response

OK

createdAtstring required

ISO date format

displayNamestring required

All Actors, regardless of type, have a display name

idnumber required
type'user' | 'field_key' | 'public_link' | 'singleUse' required

The type of actor

updatedAtstring

ISO date format

deletedAtstring

ISO date format

Example response

[
  {
    "createdAt": "2018-04-18T23:19:14.802Z",
    "displayName": "My Display Name",
    "id": 115,
    "updatedAt": "2018-04-18T23:42:11.406Z",
    "deletedAt": "2018-04-18T23:42:11.406Z"
  }
]

Changes