Explore
reteach Rest API Documentation
1.0
OAS 3.0
This document describes all endpoints of the reteach Rest API.
More resources:
How to authenticate with the API?
API Changelog
OpenAPI specification (JSON)
Servers
https://api.reteach.io
Authorize
Customer
GET
/customer
Retrieves a list of customers
POST
/customer
Finds or creates a single customer
GET
/customer
/{customerIdentifier}
Retrieves a single customer
PUT
/customer
/{customerIdentifier}
Updates a single customer
POST
/customer
/{customerIdentifier}
Creates or updates a single customer
DELETE
/customer
/{customerIdentifier}
Removes a single customer
POST
/customer
/{customerIdentifier}
/send-invitation
Triggers an email invitation for a customer
Tag
GET
/tags
Retrieves a list of tags
POST
/tags
Finds or creates a single tag
PUT
/tags
/{tagIdOrName}
Updates a single tag
DELETE
/tags
/{tagIdOrName}
Deletes a single tag
PUT
/customer
/{customerIdentifier}
/tags
Assigns a customer to a tag and creates the tag if it does not exist
PUT
/customer
/{customerIdentifier}
/multiple-tags
Assigns multiple tags to a customer. Tags will be created if they do not exist.
DELETE
/customer
/{customerIdentifier}
/tags
/{tagIdOrName}
Removes a tag from a customer by customerIdentifier (id, email, or username) and tag
Order
GET
/v1
/order
Retrieves a list of e-commerce orders
GET
/v1
/order
/{orderId}
Retrieves a single e-commerce order
Course
GET
/course
Retrieves a list of courses
POST
/course
Creates a single course
GET
/course
/{courseId}
Retrieves a single course
Participation
GET
/participation
Retrieves a list of participations
GET
/participation
/{participationId}
Retrieves a single participation
PUT
/participation
/{participationId}
Updates a single participation
POST
/participation
/{participationId}
/send-invitation
Triggers an email course invitation for a customer
Participation - deprecated
POST
/participation
Creates or unarchives a single participation
DELETE
/participation
/{participationId}
Archives a single participation
PUT
/course
/{courseId}
/participation
Enrolls a single customer to a course. If the customer not exists it will be created.
Academy
GET
/me
Retrieves the currently authenticated academy
CustomerImport
GET
/customer-import
Retrieves a list of customer imports
POST
/customer-import
Creates a single customer import
GET
/customer-import
/{customerImportId}
Retrieves a single customer import by id
CustomerExport
GET
/customer-export
Retrieves a list of customer exports
POST
/customer-export
Creates a single customer export
GET
/customer-export
/{customerExportId}
Retrieves a single customer export by id
Webhook
GET
/subscription
Retrieves a list of webhooks
POST
/subscription
Creates a webhook
GET
/subscription
/{subscriptionId}
Retrieves a single webhook by id
DELETE
/subscription
/{subscriptionId}
Deletes a single webhook by id
CourseInvitation
GET
/v1
/course-invitation
Retrieves a list of course invitations
POST
/v1
/course-invitation
Creates a single course invitation
GET
/v1
/course-invitation
/{courseInvitationId}
Retrieves a single course invitation
DELETE
/v1
/course-invitation
/{courseInvitationId}
Deletes a single course invitation
POST
/v1
/course-invitation
/{courseInvitationId}
/send-invitation
Triggers an email course invitation for an invitation
GET
/v1
/course-invitation
/{courseInvitationId}
/participation
Read all participations of a CourseInvitation
CustomerGroup
GET
/v1
/customer-group
Retrieves a list of customer groups
POST
/v1
/customer-group
Creates a single customer group
GET
/v1
/customer-group
/{customerGroupId}
Retrieves a single customer group
DELETE
/v1
/customer-group
/{customerGroupId}
Deletes a single customer group
CustomerCourseCertificate
GET
/certificates
Retrieves a list of customer course certificates
Schemas
UnauthorizedErrorResponse
ForbiddenErrorResponse
NotFoundErrorResponse
UnprocessableEntityErrorResponse
Tag
Customer
CustomerPaginated
CustomerUpdateInput
CustomerCreateInput
SuccessResponse
TagPaginated
TagCreateInput
TagUpdateInput
ImageThumbnailReadDto
ImageReadDto
CourseReadDto
ProductVariantOrderReadDto
ProductVariantOrderPaginated
CoursePaginated
CourseCreateInput
CustomerCourseCertificateReadDto
CustomerCourseParticipationReadDto
CustomerCourseParticipationPaginated
CustomerCourseParticipationUpdateInput
CustomerCourseParticipationCreateInput
CustomerCourseParticipationEnrollmentInput
Editor
TagRefInput
UpsertTagToCustomerInput
AssignMultipleTagsToCustomerInput
CustomerImportFailedRows
CustomerImport
CustomerImportPaginated
CustomerImportRestCreateInput
CustomerExport
CustomerExportPaginated
CustomerExportCreateInput
CustomerCourseCertificate
Course
CustomerCourseParticipation
RestHook
RestHookCreateInput
CustomerGroup
CourseInvitationReadDto
CourseInvitationPaginated
CourseInvitationCreateInput
CustomerGroupPaginated
CustomerGroupCreateInput
CustomerCourseCertificatePaginated