API reference

Account

The objects, fields and constraints behind the API.

Field	Type & constraints
`id`required	string
`username`required	string
`displayName`required	string
`avatarUrl`required	string \| null
`status`required	string
`errorCode`required	string \| null
`connectedAt`required	integer

View JSON schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "username": {
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "avatarUrl": {
      "type": [
        "string",
        "null"
      ]
    },
    "status": {
      "type": "string"
    },
    "errorCode": {
      "type": [
        "string",
        "null"
      ]
    },
    "connectedAt": {
      "type": "integer"
    }
  },
  "required": [
    "id",
    "username",
    "displayName",
    "avatarUrl",
    "status",
    "errorCode",
    "connectedAt"
  ],
  "additionalProperties": true
}

← All data models