UserDetail

Defined in: v1/schemas.ts:112

A detailed user object as returned from the /users/:id endpoint. Includes role, sign-in metadata, IP address, tags, and an optional list of course enrolments.

Remarks

src — the signup source of the user, visible in the Information tab of the user profile in the Teachable dashboard. Can be used as a custom identifier to associate a Teachable user with records in external systems (e.g. a CRM ID, unique tag, or external user ID). Frequently null if not set at signup.

tags — an array of tag objects assigned to the user. Each tag has a single name field. May be an empty array if no tags are assigned. Tags can be managed through the Teachable dashboard or assigned at signup via the src field.

last_sign_in_ip — only populated for users who have signed in at least once.

Course array — uses course_name (not name) based on observed live API responses, which differs from the official documentation.

Extends

output<typeof UserDetailSchema>

Properties

courses?

optional courses?: { completed_at?: string | null; course_id?: number; course_name?: string; enrolled_at?: string | null; is_active_enrollment?: boolean; percent_complete?: number; }[]