App Users

Listing all App Users

Changed on

Currently, there are no paging or filtering options, so listing App Users will get you every App User in the system, every time.

This endpoint supports retrieving extended metadata; provide a header X-Extended-Metadata: true to additionally retrieve the lastUsed timestamp of each App User, the details of the Actor the App User was createdBy, and a properties object containing any actor property values set on the App User.

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

Request

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

Path parameters

projectIdnumber required

The numeric ID of the Project

Response

This is the Extended Metadata response, if requested via the appropriate header:

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

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

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

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",
    "token": "d1!E2GVHgpr4h9bpxxtqUJ7EVJ1Q$Dusm2RBXg8XyVJMCBCbvyE8cGacxUx3bcUT",
    "projectId": 1
  }
]

Changes

  • dcd5409827e1Revision changes
    • info

      added the optional property // to the response with the status (media type: application/json; extended)

  • 022694254f0dRevision changes
    • info

      api operation id Listing all App Users removed and replaced with listAllAppUsers