Sign in

v51

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-0118684573.2 KB
Form Assignments

Listing all Actors assigned some Form Role

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 upon this particular Form.

get/v1/projects/{projectId}/forms/{xmlFormId}/assignments/{roleId}

Path parameters

projectIdnumber required

The numeric ID of the Project

xmlFormIdstring required

The xmlFormId of the Form being referenced.

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"
  }
]