Actor Properties

Listing Actor Property Names

Changed on

Returns the list of actor property names registered for this project. These names define which properties can be set on App Users and Public Links within the project.

This endpoint supports retrieving extended metadata; provide a header X-Extended-Metadata: true to additionally retrieve the distinct values currently in use for each property across all App Users and Public Links in the project.

get/v1/projects/{projectId}/actor-properties

Request

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

Path parameters

projectIdnumber required

The numeric ID of the Project

Response

OK

namestring required

The name of the actor property.

Example response

[
  {
    "name": "region"
  }
]

Changes