1. Workflows
ScuolaSemplice Web API
  • v2
    • Payments
      • registerInstallmentPayment
    • Orders
      • fetchUserOrders
    • Aggregator
      • Update timetable
      • Booking lesson
      • Cancel booking
      • Set attendances
    • Custom fields
      • Read all custom fields
      • Fetch ustom field
    • Workflows
      • Returns list of all workflows
        GET
      • Start a new workflow instance
        POST
    • StudyPlans
      • Returns list of all study plans
    • Subscriptions
      • fetchSubscriptions
      • Subscribe a student to a class
      • Alter subscriprion of a student to a class
    • Classes
      • Retuns list of class models
      • Creates a class model / catalogue
      • Updates a class model / catalogue
      • Creates a class from a model
      • Reads all list of classes from archive
      • Reads all classes added or updated after timestamp
    • Students
      • Reads paginated list of students
      • Fetch student
      • Creates new student and return the id
      • Updates an existing student and return the id
      • Reads all list of students from archive
      • Reads all students added or updated after timestamp
    • Catalogues
      • Returns list of system branches
      • Returns list of classes custom fields
      • Returns list of all locations
  • v3
    • Classes
      • classes
      • classes/{id}
    • Exams
      • exams
      • exams/{id}
    • Lessons
      • lessons
      • lessons/{id}
    • Orders
      • orders
      • orders/{id}
      • Order creation
    • PackageOffers
      • packageoffers
      • packageoffers/{id}
    • ProfileCustomSelectValues
      • profilecustomselectvalues
    • Payments
      • payments
      • payments/{id}
    • QrReadings
      • qrreadings
      • qrreadings/{id}
      • qrreadings
    • Students
      • students
      • students/{id}
      • create
      • update
      • update by externid
      • create student comment
    • Teachers
      • teachers/{id}
      • teachers
      • create
      • update
      • update by externid
    • CustomerCompanies
      • customercompanies
      • customercompanies/{id}
    • Subscriptions
      • classes
        • subscriptions/classes
        • subscriptions/classes/{id}
        • create subscription class
      • exams
        • subscriptions/exams
        • subscriptions/exams/{id}
        • create subscription exam
      • studyplans
        • subscriptions/studyplans
        • subscriptions/studyplans/{id}
    • Tutors
      • tutors
      • tutors/{id}
    • Transactions
      • Create
      • Delete
    • TeacherPayments
      • List teacher payments
      • Get a teacher payment by id
    • subscriptions
      GET
  • Schemas
    • Schemas
      • Generic key value parameters
      • Generic parameters array
      • CustomFieldValue
      • user
      • inline_response_200
      • parameters_1
      • parameters_2
      • parameters_3
      • inline_response_200_1
      • parameters_4
      • parameters_5
      • parameters_6
    • Aggregator
      • Lesson
      • Course timetable
      • Attendance
    • ErrorBadRequest
    • StudyPlan
    • TeacherPaymentLine
    • TeacherPayment
    • PaginationLinks
    • PaginationMeta
    • TeacherPaymentCollection
  1. Workflows

Start a new workflow instance

POST
api/v2workflows/start
Last modified:2026-01-21 10:25:18

Request

Authorization
Basic Auth
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
or
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Body Params application/json

Example
{
    "workflowid": 0,
    "parameters": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://prod.your-api-server.comapi/v2workflows/start' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
    "workflowid": 0,
    "parameters": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}'

Responses

🟢200Success
application/json
Bodyapplication/json

Example
{}
Modified at 2026-01-21 10:25:18
Previous
Returns list of all workflows
Next
Returns list of all study plans
Built with