Thinkific · Schema

UserResponse

Online CoursesE-LearningLMSCourse CreationEnrollmentsUsersEducationDigital ProductsWebhooks

Properties

Name Type Description
id number User's ID
created_at string User's created date
first_name string The first name of the User.
last_name string The last name of the User.
full_name string The email of the User.
company string The company of the User.
email string User's email
roles array Any specific roles that the User should be placed in. Possible roles are: affiliate, course_admin, group_analyst, site_admin.
avatar_url string The fully-qualified avatar url of the User.
bio string The bio of the User.
headline string The headline/title of the User.
affiliate_code string The affiliate code of the User. ** Required only if the User is an affiliate. **
external_source string User's external source
affiliate_commission number The affiliate commission % of the User. ** Required only if the User is an affiliate. This should be greater than 0 and less than or equal to 100. **
affiliate_commission_type string The affiliate payout type, it can be either % (percentage, default) or $ (fixed amount). ** Required only if the User is an affiliate. **
affiliate_payout_email string The email of the User. ** Required only if the user is an affiliate. Used to pay the User out. **
administered_course_ids array User's administered course ids
custom_profile_fields array Custom profile fields for the User.
View JSON Schema on GitHub

JSON Schema

thinkific-user.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/thinkific/refs/heads/main/json-schema/thinkific-user.json",
  "title": "UserResponse",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "User's ID",
      "example": 1.0
    },
    "created_at": {
      "type": "string",
      "description": "User's created date",
      "format": "date-time",
      "example": "2018-07-12T23:19:00.154Z"
    },
    "first_name": {
      "type": "string",
      "description": "The first name of the User.",
      "example": "Bob"
    },
    "last_name": {
      "type": "string",
      "description": "The last name of the User.",
      "example": "Smith"
    },
    "full_name": {
      "type": "string",
      "description": "The email of the User.",
      "example": "Bob Smith"
    },
    "company": {
      "type": "string",
      "description": "The company of the User.",
      "example": "The user's company"
    },
    "email": {
      "type": "string",
      "description": "User's email",
      "format": "email",
      "example": "[email protected]"
    },
    "roles": {
      "type": "array",
      "description": "Any specific roles that the User should be placed in. Possible roles are: affiliate, course_admin, group_analyst, site_admin.",
      "example": [
        "affiliate"
      ],
      "items": {
        "type": "string",
        "enum": [
          "affiliate",
          "course_admin",
          "group_analyst",
          "site_admin"
        ]
      }
    },
    "avatar_url": {
      "type": "string",
      "description": "The fully-qualified avatar url of the User.",
      "example": "https://example.com/avatar/123"
    },
    "bio": {
      "type": "string",
      "description": "The bio of the User.",
      "example": "User's bio"
    },
    "headline": {
      "type": "string",
      "description": "The headline/title of the User.",
      "example": "User's headline"
    },
    "affiliate_code": {
      "type": "string",
      "description": "The affiliate code of the User. ** Required only if the User is an affiliate. **",
      "example": "abc123"
    },
    "external_source": {
      "type": "string",
      "description": "User's external source"
    },
    "affiliate_commission": {
      "type": "number",
      "description": "The affiliate commission % of the User. ** Required only if the User is an affiliate. This should be greater than 0 and less than or equal to 100. **",
      "example": 20.0
    },
    "affiliate_commission_type": {
      "type": "string",
      "description": "The affiliate payout type, it can be either % (percentage, default) or $ (fixed amount). ** Required only if the User is an affiliate. **",
      "example": "%"
    },
    "affiliate_payout_email": {
      "type": "string",
      "description": "The email of the User. ** Required only if the user is an affiliate. Used to pay the User out. **",
      "example": "[email protected]"
    },
    "administered_course_ids": {
      "type": "array",
      "description": "User's administered course ids",
      "items": {
        "type": "number",
        "example": [
          10,
          20,
          30
        ]
      }
    },
    "custom_profile_fields": {
      "type": "array",
      "description": "Custom profile fields for the User.",
      "items": {
        "$ref": "#/components/schemas/CustomProfileField"
      }
    }
  }
}