Get

GET /:account/user_schema

Note: This endpoint is still under active development, and may change without warning.

The user schema is where a primary account holds information about the custom fields accessible to its users

Examples

Admin views user schema fields

Request

GET /textus/user_schema

Example

$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X GET /textus/user_schema
    

Response

Status

200

Response Type

UserSchema

Example Body

{
  "@type": "UserSchema",
  "@context": "/contexts/UserSchema.jsonld",
  "id": "/textus/user_schema",
  "account": {
    "@type": "Account",
    "@context": "/contexts/Account.jsonld",
    "id": "/accounts/my_account",
    "name": "My Account"
  },
  "fields": {
    "@type": "hydra:Collection",
    "@context": "/contexts/hydra:Collection.jsonld",
    "id": "/textus/user_schema/fields",
    "members": [
      {
        "@type": "CustomField",
        "@context": "/contexts/CustomField.jsonld",
        "id": "/textus/user_schema/qlrDLk",
        "slug": "calendar-link",
        "title": "Calendar Link",
        "type": "url",
        "description": "Your personal calend.ly url.",
        "createdAt": "2020-10-15T20:07:20.862Z",
        "inUse": false
      }
    ],
    "totalItems": 0
  }
}