TOtoriihq
User Fields

List user fields metadata

List user fields (predefined and custom).<br/><br/>The list of options for dropdown and multi dropdown fields is not provided by this API.<br/><br/>You can search by field name or key.<br/><br/>

<p><ul><li>Rate limit: 200 requests per minute</li></ul></p>
get/users/metadata

Request

  • Base URL
    https://api.toriihq.com/v1.0
  • Auth
    API key in header Authorization

Query parameters

qstring

The field name or key to search for

Response

User Metadata

Example response

{
  "predefinedFields": [
    {
      "name": "Department",
      "systemKey": "department",
      "type": "singleLine",
      "description": "Average days each user used the app in the past 30 days, rounded up (0 = nobody used it then)",
      "filterType": "dropdown",
      "filterSystemKey": "application"
    }
  ],
  "customFields": [
    {
      "idField": 1000,
      "systemKey": "department",
      "isShown": true,
      "idOrg": 1000,
      "sourceIdApp": 1000,
      "name": "Department",
      "type": "singleLine"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.