Sign in
App Users

Listing all App Users

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

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

Changed in 4 of the 54 revisions of this API.15

  • dcd5409827e11See the full diff
    • ○

      added the optional property items/allOf[subschema #2]/properties to the response with the 200 status (media type: application/json; extended)

      response-optional-property-added

  • 022694254f0d1See the full diff
    • ○

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

      api-operation-id-removed

  • b11b54eea4871See the full diff
    • ○

      removed the non-success response with the status 403

      response-non-success-status-removed

  • e8c2858fd4eb12See the full diff
    • ●

      removed the optional property items/allOf[subschema #2]/properties from the response with the 200 status (media type: application/json; extended)

      response-optional-property-removed

    • ○

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

      api-operation-id-removed

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog