v51

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-0118684573.2 KB
App Users

Creating a new App User

The only information required to create a new App User is its displayName (this is called "Nickname" in the administrative panel).

When an App User is created, they are assigned no rights. They will be able to authenticate and list forms on a mobile client, but the form list will be empty, as the list only includes Forms that the App User has read access to. Once an App User is created, you'll likely wish to use the Form Assignments resource to actually assign the app-user role to them for the Forms you wish.

You may also optionally provide a properties object to set pre-registered Actor Property values on the App User at creation time.

post/v1/projects/{projectId}/app-users

Path parameters

projectIdnumber required

The numeric ID of the Project

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 this Actor; typically this will be user.

updatedAtstring

ISO date format

deletedAtstring

ISO date format

tokenstring

If present, this is the Token that can be used to authenticate a request as this App User. If not present, this App User's access has been revoked.

projectIdnumber required

The ID of the Project that this App User is bound to.