The authorizable object
1234567891011121314
{   "Authorizations": ["G_6d73bd94-9620-4aa7-8a9c-79c63db68b64"],   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9350947",   "ExtraData": {"Key":"Value"},   "ID": "G_263e79e3-2115-4596-9ce8-20fe938cc661",   "ModifiedDate": "2026-06-06T10:38:47.9350947",   "ParentMemberships": ["G_323f5602-cc61-482a-b79c-8d5db5597434"],   "PreferredLanguage": "en",   "ProfileImage": null,   "Tag": "",   "Type": "Authorizables" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/authorizables

Returns a list of authorizables.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of authorizable objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/authorizables \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
12345678910111213
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "ID": "G_263e79e3-2115-4596-9ce8-20fe938cc661",       "Tag": "",       "Type": "Authorizables"     }   ]   "Date": "2026-06-06T10:38:47.9819666", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/authorizables/{authorizable_id}

Retrieves an authorizable.

Path parameters

authorizable_id

string

required

ID of the authorizable to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The authorizable object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/authorizables/g_263e79e3-2115-4596-9ce8-20fe938cc661 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
12345
{   "ID": "G_263e79e3-2115-4596-9ce8-20fe938cc661",   "Tag": "",   "Type": "Authorizables" } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/authorizables/{authorizable_id}/.report

Path parameters

authorizable_id

string

required

ID of the authorizable on which the call is applied.

Query parameters

stream

boolean

optional

Stream results using Server-Sent Events

Request body

ActivityAttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Only include specific attempts

ActivityStructures

array of strings

optional

IDs of activity structures

DeltaDate

date

optional

ISO date format

Only include results after date

IncludeActivities

bool

optional

Add results on each activity to the output

IncludeGroupSummary

bool

optional

Add summaries of person groups to the output

IncludeIntermediateActivityStructures

bool

optional

Include intermediate ActivityStructures

IncludeNotAttempted

bool

optional

Include not attempted results

IncludeParentActivityStructure

bool

optional

Include ID of Parent ActivityStructure

IncludeParentAuthorizable

bool

optional

Include ID of Parent Authorizable

IncludePersons

bool

optional

Add individual results to the output

IncludeProgramSummary

bool

optional

Add calculated program status to the output

IncludeResultDetails

bool

optional

Add details of answered questions to the output

IncludeUnassigned

bool

optional

Add results of activities that are not currently assigned

LearnAuthorizations

array of strings

optional

IDs of learn authorizations

ProgramSummaryAttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Setting used for program status calculation

ReferenceDate

date

optional

ISO date format

Only include results before date

Verbose

bool

optional

Add messages to the output

Response body

enumeration of ProgressReportingBaseResults

The ProgressReportingBaseResult object (abstract)

Base class for report entries

Type

string

The ProgressReportingMessage object (inherits from ProgressReportingBaseResult)

Progress or logging during reporting

Type = report.message

Message

string

DateTime

date

ISO date format

Current time stamp

The ProgressReportingDone object (inherits from ProgressReportingBaseResult)

Indicates that reporting finished successfully

Type = report.finished

DeltaDate

date

ISO date format

ReferenceDate

date

ISO date format

This date can be used for next delta

The ProgressReportingBaseResultLine object (abstract) (inherits from ProgressReportingBaseResult)

Base class for report results

ParentAuthorizable

string

expandable

ID of an Authorizable

Authorizable

string

expandable

ID of an Authorizable

ParentActivityStructure

string

expandable

ID of an ActivityStructure

ActivityStructure

string

expandable

ID of an ActivityStructure

Authorization

string

expandable

ID of an Authorization

ContentTime

integer

Progress

float

NormalizedScore

float

ValidUntil

date

ISO date format

Certificate activities only

RecertificationAfter

date

ISO date format

Certificate activities only

The ProgressReportingGroupResult object (inherits from ProgressReportingBaseResultLine)

Summary of an Activity for a PersonGroup

Type = report.activity.summary

ResultCount

integer

NotStarted

integer

Started

integer

Completed

integer

Passed

integer

Failed

integer

The ProgressReportingGroupProgramResult object (inherits from ProgressReportingGroupResult)

Summary of an ActivityStructure for a PersonGroup

Type = report.program.summary

StatusRules

bool

StatusProgress

float

The ProgressReportingResult object (inherits from ProgressReportingBaseResultLine)

Result of a Person on an Activity

Type = report.activity.result

DateCompleted

date

ISO date format

DateStarted

date

ISO date format

Status

integer

Allowed values: NotStarted (0), Busy (1), Pending (10), Done (20), Failed (30), Passed (40), NotAssigned (-1)

Result

string

ID of an ActivityResult

The ProgressReportingProgramResult object (inherits from ProgressReportingResult)

Result of a Person on an ActivityGroup

Type = report.program.result

StatusRules

bool

StatusProgress

float

Example request
1234567891011121314151617181920212223
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/authorizables/g_263e79e3-2115-4596-9ce8-20fe938cc661/.report \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "ActivityAttemptMode": "All",   "ActivityStructures": null,   "DeltaDate": null,   "IncludeActivities": true,   "IncludeGroupSummary": false,   "IncludeIntermediateActivityStructures": false,   "IncludeNotAttempted": false,   "IncludeParentActivityStructure": false,   "IncludeParentAuthorizable": false,   "IncludePersons": true,   "IncludeProgramSummary": false,   "IncludeResultDetails": false,   "IncludeUnassigned": false,   "LearnAuthorizations": null,   "ProgramSummaryAttemptMode": "Last",   "ReferenceDate": null,   "Verbose": false }' 

Example response
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
[   {     "Type": "report.message",     "Message": "Hello world",     "DateTime": "2026-06-06T10:38:47.9350947"   }   ,   {     "Type": "report.finished",     "DeltaDate": "2026-06-06T10:38:47.9350947",     "ReferenceDate": "2026-06-06T10:38:47.9350947"   }   ,   {     "Type": "report.activity.summary",     "ParentAuthorizable": "G_3f68f1b1-05fa-4ba6-83cf-4a5202df6c53",     "Authorizable": "G_2c1a9399-84b4-457e-9e6f-738214ace12b",     "ParentActivityStructure": "G_0938c9fb-42b8-49cb-952c-bd32d884e67a",     "ActivityStructure": "G_c3d7cbc6-6b39-468f-b2ab-71f68a42710c",     "Authorization": "G_01cd1462-f0ec-4137-86f1-e1d6922581be",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9350947",     "RecertificationAfter": "2026-06-06T10:38:47.9350947",     "ResultCount": 1,     "NotStarted": 2,     "Started": 1,     "Completed": 3,     "Passed": 1,     "Failed": 0   }   ,   {     "Type": "report.program.summary",     "ParentAuthorizable": "G_3f68f1b1-05fa-4ba6-83cf-4a5202df6c53",     "Authorizable": "G_2c1a9399-84b4-457e-9e6f-738214ace12b",     "ParentActivityStructure": "G_0938c9fb-42b8-49cb-952c-bd32d884e67a",     "ActivityStructure": "G_c3d7cbc6-6b39-468f-b2ab-71f68a42710c",     "Authorization": "G_01cd1462-f0ec-4137-86f1-e1d6922581be",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9350947",     "RecertificationAfter": "2026-06-06T10:38:47.9350947",     "ResultCount": 1,     "NotStarted": 2,     "Started": 1,     "Completed": 3,     "Passed": 1,     "Failed": 0,     "StatusRules": true,     "StatusProgress": null   }   ,   {     "Type": "report.activity.result",     "ParentAuthorizable": "G_3f68f1b1-05fa-4ba6-83cf-4a5202df6c53",     "Authorizable": "G_2c1a9399-84b4-457e-9e6f-738214ace12b",     "ParentActivityStructure": "G_0938c9fb-42b8-49cb-952c-bd32d884e67a",     "ActivityStructure": "G_c3d7cbc6-6b39-468f-b2ab-71f68a42710c",     "Authorization": "G_01cd1462-f0ec-4137-86f1-e1d6922581be",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9350947",     "RecertificationAfter": "2026-06-06T10:38:47.9350947",     "DateCompleted": "2026-06-06T10:38:47.9350947",     "DateStarted": "2026-06-06T10:38:47.9350947",     "Status": null,     "Result": "E_9d941aab-0a3e-47e3-a653-8155b03542d8"   }   ,   {     "Type": "report.program.result",     "ParentAuthorizable": "G_3f68f1b1-05fa-4ba6-83cf-4a5202df6c53",     "Authorizable": "G_2c1a9399-84b4-457e-9e6f-738214ace12b",     "ParentActivityStructure": "G_0938c9fb-42b8-49cb-952c-bd32d884e67a",     "ActivityStructure": "G_c3d7cbc6-6b39-468f-b2ab-71f68a42710c",     "Authorization": "G_01cd1462-f0ec-4137-86f1-e1d6922581be",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9350947",     "RecertificationAfter": "2026-06-06T10:38:47.9350947",     "DateCompleted": "2026-06-06T10:38:47.9350947",     "DateStarted": "2026-06-06T10:38:47.9350947",     "Status": null,     "Result": "E_9d941aab-0a3e-47e3-a653-8155b03542d8",     "StatusRules": true,     "StatusProgress": null   } ] 

EventPersonGroups

Special case PersonGroup for self registration of Persons.

Authorizations

array of strings

readonly request expandable

IDs of Entities

Filter not supported

ChildMemberships

array of strings

readonly request expandable

IDs of Entities

Filter not supported

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

Code

string

readwrite default

Max 255 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

ExtraData

mapping

readwrite request

List of key/value pairs

Filter not supported

GroupName

string

readwrite default

Max 255 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

string

readonly always

Unique

Available filter operations: EQUALS,PATH_TO_ROOT,SUB_TREE,MEMBER_OF

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

ParentMemberships

array of strings

readonly request expandable

IDs of Entities

Filter not supported

PreferredLanguage

string

readwrite request

ISO language code

Filter not supported

ProfileImage

asset

readwrite request

Image

Filter not supported

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

The event person group object
1234567891011121314151617
{   "Authorizations": ["G_23418bd0-5632-48ad-bf2a-a701066c2eeb"],   "ChildMemberships": ["G_7b24347b-6d16-487d-a8f8-1ad4287e8925"],   "ClassID": "",   "ClassName": "",   "Code": "Example event",   "CreateDate": "2026-06-06T10:38:47.9507106",   "ExtraData": {"Key":"Value"},   "GroupName": "Example group",   "ID": "G_c84f5f37-6f39-430a-9aa3-99e6425453bc",   "ModifiedDate": "2026-06-06T10:38:47.9507106",   "ParentMemberships": ["G_7c8e2ebc-ec1f-40db-9572-2ff8091f84cd"],   "PreferredLanguage": "en",   "ProfileImage": null,   "Tag": "",   "Type": "EventPersonGroups" } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/eventpersongroups

Creates a new event person group.

Request body

Code

string

optional

Max 255 chars

ExtraData

mapping

optional

List of key/value pairs

GroupName

string

optional

Max 255 chars

PreferredLanguage

string

optional

ISO language code

ProfileImage

asset

optional

Image

Tag

string

optional

Max 100 chars

Returns

The newly created event person group object.

Example request
123456789101112
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/eventpersongroups \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "Code": "Example event",   "ExtraData": {"Key":"Value"},   "GroupName": "Example group",   "PreferredLanguage": "en",   "ProfileImage": null,   "Tag": "" }' 

Response
1234567891011121314151617
{   "Authorizations": ["G_23418bd0-5632-48ad-bf2a-a701066c2eeb"],   "ChildMemberships": ["G_7b24347b-6d16-487d-a8f8-1ad4287e8925"],   "ClassID": "",   "ClassName": "",   "Code": "Example event",   "CreateDate": "2026-06-06T10:38:47.9507106",   "ExtraData": {"Key":"Value"},   "GroupName": "Example group",   "ID": "G_c84f5f37-6f39-430a-9aa3-99e6425453bc",   "ModifiedDate": "2026-06-06T10:38:47.9507106",   "ParentMemberships": ["G_7c8e2ebc-ec1f-40db-9572-2ff8091f84cd"],   "PreferredLanguage": "en",   "ProfileImage": null,   "Tag": "",   "Type": "EventPersonGroups" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/eventpersongroups

Returns a list of event person groups.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of event person group objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/eventpersongroups \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456789101112131415
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "Code": "Example event",       "GroupName": "Example group",       "ID": "G_c84f5f37-6f39-430a-9aa3-99e6425453bc",       "Tag": "",       "Type": "EventPersonGroups"     }   ]   "Date": "2026-06-06T10:38:47.9975763", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/eventpersongroups/{eventpersongroup_id}

Retrieves an event person group.

Path parameters

eventpersongroup_id

string

required

ID of the event person group to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The event person group object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/eventpersongroups/g_c84f5f37-6f39-430a-9aa3-99e6425453bc \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
1234567
{   "Code": "Example event",   "GroupName": "Example group",   "ID": "G_c84f5f37-6f39-430a-9aa3-99e6425453bc",   "Tag": "",   "Type": "EventPersonGroups" } 

PUT https://genapiv1.growsparks.com/rest/genapiv1/v1/eventpersongroups/{eventpersongroup_id}

Modifies an event person group.

Path parameters

eventpersongroup_id

string

required

ID of the event person group to modify.

Request body

Code

string

optional

Max 255 chars

ExtraData

mapping

optional

List of key/value pairs

GroupName

string

optional

Max 255 chars

PreferredLanguage

string

optional

ISO language code

ProfileImage

asset

optional

Image

Tag

string

optional

Max 100 chars

Returns

The modified event person group object.

Example request
123456789101112
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/eventpersongroups/g_c84f5f37-6f39-430a-9aa3-99e6425453bc \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X PUT \   -d '{   "Code": "Example event",   "ExtraData": {"Key":"Value"},   "GroupName": "Example group",   "PreferredLanguage": "en",   "ProfileImage": null,   "Tag": "" }' 

Response
1234567891011121314151617
{   "Authorizations": ["G_23418bd0-5632-48ad-bf2a-a701066c2eeb"],   "ChildMemberships": ["G_7b24347b-6d16-487d-a8f8-1ad4287e8925"],   "ClassID": "",   "ClassName": "",   "Code": "Example event",   "CreateDate": "2026-06-06T10:38:47.9507106",   "ExtraData": {"Key":"Value"},   "GroupName": "Example group",   "ID": "G_c84f5f37-6f39-430a-9aa3-99e6425453bc",   "ModifiedDate": "2026-06-06T10:38:47.9507106",   "ParentMemberships": ["G_7c8e2ebc-ec1f-40db-9572-2ff8091f84cd"],   "PreferredLanguage": "en",   "ProfileImage": null,   "Tag": "",   "Type": "EventPersonGroups" } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/eventpersongroups/{eventpersongroup_id}/.activityrecords

Enumerate records of start dates, duration and context of activities and trainings for all persons in this group.

Path parameters

eventpersongroup_id

string

required

ID of the event person group on which the call is applied.

Query parameters

stream

boolean

optional

Stream results using Server-Sent Events

Request body

StartedAfter

date

optional

ISO date format

StartedBefore

date

optional

ISO date format

Response body

enumeration of ActivityRecordBases

The ActivityRecordBase object (abstract)

Base class for activity records

Type

string

One of activityrecord.activity|activityrecord.training

Person

string

expandable

ID of a Person

Activity

string

expandable

ID of an Activity

Duration

integer

Duration in seconds

StartDate

date

ISO date format

The ActivityRecordActivity object (inherits from ActivityRecordBase)

Record of the start and duration of an Activity

Type = activityrecord.activity

ContextActivityGroup

string

expandable

ID of the ActivityGroup in the context of which the activity was started.

ActivityResult

string

ID of an ActivityResult

The ActivityRecordTraining object (inherits from ActivityRecordBase)

Record of the attendance at a ClassroomTraining

Type = activityrecord.training

Attendance

string

expandable

ID of the associated Attendance object.

Example request
12345678
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/eventpersongroups/g_c84f5f37-6f39-430a-9aa3-99e6425453bc/.activityrecords \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "StartedAfter": null,   "StartedBefore": null }' 

Example response
1234567891011121314151617181920
[   {     "Type": "activityrecord.activity",     "Person": "G_2d60aa9d-9295-4796-b9a3-209885af3386",     "Activity": "G_1791265c-95fb-47f4-800f-e0e2b78621bc",     "Duration": 100,     "StartDate": "2026-06-06T10:38:47.9507106",     "ContextActivityGroup": "G_ca3db842-4eb1-4f1a-b1ac-f6c606e96782",     "ActivityResult": "E_8cf7f1c6-347a-434c-a4f4-8679454588a0"   }   ,   {     "Type": "activityrecord.training",     "Person": "G_2d60aa9d-9295-4796-b9a3-209885af3386",     "Activity": "G_1791265c-95fb-47f4-800f-e0e2b78621bc",     "Duration": 100,     "StartDate": "2026-06-06T10:38:47.9507106",     "Attendance": "G_95af79d7-578c-461e-b140-eb3ff9ac414b"   } ] 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/eventpersongroups/{eventpersongroup_id}/.progress

Calculate status, progress and score of all persons in this group on a specific activitystructure.

Path parameters

eventpersongroup_id

string

required

ID of the event person group on which the call is applied.

Query parameters

stream

boolean

optional

Stream results using Server-Sent Events

Request body

ActivityStructure

string

required

ID of an activity structure

AttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Setting used for program status calculation

EndingAfter

date

optional

ISO date format

Only include memberships ending after date

IncludeDeleted

bool

optional

Include deleted memberships

StartingBefore

date

optional

ISO date format

Only include memberships starting before date

Response body

enumeration of ActivityStatus

The ActivityStatus object

Progress, status and score a single person on an Activity or ActivityGroup

Person

string

expandable

ID of a Person

ActivityStructure

string

expandable

ID of an ActivityStructure

Attempt

integer

# Attempt on this activity, starting from 0

Progress

integer

MaxProgress

integer

Score

integer

MaxScore

integer

Completed

bool

DateCompleted

date

ISO date format

Status

integer

Allowed values: NotStarted (0), Busy (1), Pending (10), Done (20), Failed (30), Passed (40), NotAssigned (-1)

ContentTime

integer

NormalizedScore

float

Example request
1234567891011
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/eventpersongroups/g_c84f5f37-6f39-430a-9aa3-99e6425453bc/.progress \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "ActivityStructure": "G_0d3c341e-ae95-4c06-a875-9ea46fd5d27d",   "AttemptMode": "Last",   "EndingAfter": null,   "IncludeDeleted": false,   "StartingBefore": null }' 

Example response
12345678910111213141516
[   {     "Person": "G_35d4ec9d-389c-43b8-babd-78d6639c7c8c",     "ActivityStructure": "G_32b30da1-49e5-4466-81a8-93e6f6c61332",     "Attempt": 0,     "Progress": 9,     "MaxProgress": 10,     "Score": 5,     "MaxScore": 10,     "Completed": true,     "DateCompleted": "2026-06-06T10:38:47.9507106",     "Status": 20,     "ContentTime": 60,     "NormalizedScore": 0.5   } ] 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/eventpersongroups/{eventpersongroup_id}/.report

Path parameters

eventpersongroup_id

string

required

ID of the event person group on which the call is applied.

Query parameters

stream

boolean

optional

Stream results using Server-Sent Events

Request body

ActivityAttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Only include specific attempts

ActivityStructures

array of strings

optional

IDs of activity structures

DeltaDate

date

optional

ISO date format

Only include results after date

IncludeActivities

bool

optional

Add results on each activity to the output

IncludeGroupSummary

bool

optional

Add summaries of person groups to the output

IncludeIntermediateActivityStructures

bool

optional

Include intermediate ActivityStructures

IncludeNotAttempted

bool

optional

Include not attempted results

IncludeParentActivityStructure

bool

optional

Include ID of Parent ActivityStructure

IncludeParentAuthorizable

bool

optional

Include ID of Parent Authorizable

IncludePersons

bool

optional

Add individual results to the output

IncludeProgramSummary

bool

optional

Add calculated program status to the output

IncludeResultDetails

bool

optional

Add details of answered questions to the output

IncludeUnassigned

bool

optional

Add results of activities that are not currently assigned

LearnAuthorizations

array of strings

optional

IDs of learn authorizations

ProgramSummaryAttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Setting used for program status calculation

ReferenceDate

date

optional

ISO date format

Only include results before date

Verbose

bool

optional

Add messages to the output

Response body

enumeration of ProgressReportingBaseResults

The ProgressReportingBaseResult object (abstract)

Base class for report entries

Type

string

The ProgressReportingMessage object (inherits from ProgressReportingBaseResult)

Progress or logging during reporting

Type = report.message

Message

string

DateTime

date

ISO date format

Current time stamp

The ProgressReportingDone object (inherits from ProgressReportingBaseResult)

Indicates that reporting finished successfully

Type = report.finished

DeltaDate

date

ISO date format

ReferenceDate

date

ISO date format

This date can be used for next delta

The ProgressReportingBaseResultLine object (abstract) (inherits from ProgressReportingBaseResult)

Base class for report results

ParentAuthorizable

string

expandable

ID of an Authorizable

Authorizable

string

expandable

ID of an Authorizable

ParentActivityStructure

string

expandable

ID of an ActivityStructure

ActivityStructure

string

expandable

ID of an ActivityStructure

Authorization

string

expandable

ID of an Authorization

ContentTime

integer

Progress

float

NormalizedScore

float

ValidUntil

date

ISO date format

Certificate activities only

RecertificationAfter

date

ISO date format

Certificate activities only

The ProgressReportingGroupResult object (inherits from ProgressReportingBaseResultLine)

Summary of an Activity for a PersonGroup

Type = report.activity.summary

ResultCount

integer

NotStarted

integer

Started

integer

Completed

integer

Passed

integer

Failed

integer

The ProgressReportingGroupProgramResult object (inherits from ProgressReportingGroupResult)

Summary of an ActivityStructure for a PersonGroup

Type = report.program.summary

StatusRules

bool

StatusProgress

float

The ProgressReportingResult object (inherits from ProgressReportingBaseResultLine)

Result of a Person on an Activity

Type = report.activity.result

DateCompleted

date

ISO date format

DateStarted

date

ISO date format

Status

integer

Allowed values: NotStarted (0), Busy (1), Pending (10), Done (20), Failed (30), Passed (40), NotAssigned (-1)

Result

string

ID of an ActivityResult

The ProgressReportingProgramResult object (inherits from ProgressReportingResult)

Result of a Person on an ActivityGroup

Type = report.program.result

StatusRules

bool

StatusProgress

float

Example request
1234567891011121314151617181920212223
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/eventpersongroups/g_c84f5f37-6f39-430a-9aa3-99e6425453bc/.report \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "ActivityAttemptMode": "All",   "ActivityStructures": null,   "DeltaDate": null,   "IncludeActivities": true,   "IncludeGroupSummary": false,   "IncludeIntermediateActivityStructures": false,   "IncludeNotAttempted": false,   "IncludeParentActivityStructure": false,   "IncludeParentAuthorizable": false,   "IncludePersons": true,   "IncludeProgramSummary": false,   "IncludeResultDetails": false,   "IncludeUnassigned": false,   "LearnAuthorizations": null,   "ProgramSummaryAttemptMode": "Last",   "ReferenceDate": null,   "Verbose": false }' 

Example response
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
[   {     "Type": "report.message",     "Message": "Hello world",     "DateTime": "2026-06-06T10:38:47.9507106"   }   ,   {     "Type": "report.finished",     "DeltaDate": "2026-06-06T10:38:47.9507106",     "ReferenceDate": "2026-06-06T10:38:47.9507106"   }   ,   {     "Type": "report.activity.summary",     "ParentAuthorizable": "G_8f257b4f-a6d0-48cb-9446-718f5d433e70",     "Authorizable": "G_2d2029f4-98bb-4a3b-834c-f26d976ab8a0",     "ParentActivityStructure": "G_6485958e-80e0-498f-8b20-4abb72ed4c97",     "ActivityStructure": "G_6a115909-ef8b-4761-bef9-8e8487041d3d",     "Authorization": "G_2e854304-4f0d-4cf9-be26-f0cc03173084",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9507106",     "RecertificationAfter": "2026-06-06T10:38:47.9507106",     "ResultCount": 1,     "NotStarted": 2,     "Started": 1,     "Completed": 3,     "Passed": 1,     "Failed": 0   }   ,   {     "Type": "report.program.summary",     "ParentAuthorizable": "G_8f257b4f-a6d0-48cb-9446-718f5d433e70",     "Authorizable": "G_2d2029f4-98bb-4a3b-834c-f26d976ab8a0",     "ParentActivityStructure": "G_6485958e-80e0-498f-8b20-4abb72ed4c97",     "ActivityStructure": "G_6a115909-ef8b-4761-bef9-8e8487041d3d",     "Authorization": "G_2e854304-4f0d-4cf9-be26-f0cc03173084",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9507106",     "RecertificationAfter": "2026-06-06T10:38:47.9507106",     "ResultCount": 1,     "NotStarted": 2,     "Started": 1,     "Completed": 3,     "Passed": 1,     "Failed": 0,     "StatusRules": true,     "StatusProgress": null   }   ,   {     "Type": "report.activity.result",     "ParentAuthorizable": "G_8f257b4f-a6d0-48cb-9446-718f5d433e70",     "Authorizable": "G_2d2029f4-98bb-4a3b-834c-f26d976ab8a0",     "ParentActivityStructure": "G_6485958e-80e0-498f-8b20-4abb72ed4c97",     "ActivityStructure": "G_6a115909-ef8b-4761-bef9-8e8487041d3d",     "Authorization": "G_2e854304-4f0d-4cf9-be26-f0cc03173084",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9507106",     "RecertificationAfter": "2026-06-06T10:38:47.9507106",     "DateCompleted": "2026-06-06T10:38:47.9507106",     "DateStarted": "2026-06-06T10:38:47.9507106",     "Status": null,     "Result": "E_15ba286e-9404-437c-aa27-8b56e6842b36"   }   ,   {     "Type": "report.program.result",     "ParentAuthorizable": "G_8f257b4f-a6d0-48cb-9446-718f5d433e70",     "Authorizable": "G_2d2029f4-98bb-4a3b-834c-f26d976ab8a0",     "ParentActivityStructure": "G_6485958e-80e0-498f-8b20-4abb72ed4c97",     "ActivityStructure": "G_6a115909-ef8b-4761-bef9-8e8487041d3d",     "Authorization": "G_2e854304-4f0d-4cf9-be26-f0cc03173084",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9507106",     "RecertificationAfter": "2026-06-06T10:38:47.9507106",     "DateCompleted": "2026-06-06T10:38:47.9507106",     "DateStarted": "2026-06-06T10:38:47.9507106",     "Status": null,     "Result": "E_15ba286e-9404-437c-aa27-8b56e6842b36",     "StatusRules": true,     "StatusProgress": null   } ] 

ExternalPersonGroups

Special case PersonGroup for Persons managed by an external system.

Authorizations

array of strings

readonly request expandable

IDs of Entities

Filter not supported

ChildMemberships

array of strings

readonly request expandable

IDs of Entities

Filter not supported

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

ExtraData

mapping

readwrite request

List of key/value pairs

Filter not supported

GroupName

string

readwrite default

Max 255 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

string

readonly always

Unique

Available filter operations: EQUALS,PATH_TO_ROOT,SUB_TREE,MEMBER_OF

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

ParentMemberships

array of strings

readonly request expandable

IDs of Entities

Filter not supported

PreferredLanguage

string

readwrite request

ISO language code

Filter not supported

ProfileImage

asset

readwrite request

Image

Filter not supported

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

The external person group object
12345678910111213141516
{   "Authorizations": ["G_e50d5855-c28b-4ba4-89eb-555d60d9f4af"],   "ChildMemberships": ["G_20b9c36c-5b3c-413e-b794-1099cc1cf41c"],   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9507106",   "ExtraData": {"Key":"Value"},   "GroupName": "Example group",   "ID": "G_b375dc80-1225-429d-9fb3-5e48b4208bdc",   "ModifiedDate": "2026-06-06T10:38:47.9507106",   "ParentMemberships": ["G_cdbfed17-bab0-4bed-9d2e-c25ca5bef532"],   "PreferredLanguage": "en",   "ProfileImage": null,   "Tag": "",   "Type": "ExternalPersonGroups" } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/externalpersongroups

Creates a new external person group.

Request body

ExtraData

mapping

optional

List of key/value pairs

GroupName

string

optional

Max 255 chars

PreferredLanguage

string

optional

ISO language code

ProfileImage

asset

optional

Image

Tag

string

optional

Max 100 chars

Returns

The newly created external person group object.

Example request
1234567891011
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/externalpersongroups \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "ExtraData": {"Key":"Value"},   "GroupName": "Example group",   "PreferredLanguage": "en",   "ProfileImage": null,   "Tag": "" }' 

Response
12345678910111213141516
{   "Authorizations": ["G_e50d5855-c28b-4ba4-89eb-555d60d9f4af"],   "ChildMemberships": ["G_20b9c36c-5b3c-413e-b794-1099cc1cf41c"],   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9507106",   "ExtraData": {"Key":"Value"},   "GroupName": "Example group",   "ID": "G_b375dc80-1225-429d-9fb3-5e48b4208bdc",   "ModifiedDate": "2026-06-06T10:38:47.9507106",   "ParentMemberships": ["G_cdbfed17-bab0-4bed-9d2e-c25ca5bef532"],   "PreferredLanguage": "en",   "ProfileImage": null,   "Tag": "",   "Type": "ExternalPersonGroups" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/externalpersongroups

Returns a list of external person groups.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of external person group objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/externalpersongroups \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
1234567891011121314
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "GroupName": "Example group",       "ID": "G_b375dc80-1225-429d-9fb3-5e48b4208bdc",       "Tag": "",       "Type": "ExternalPersonGroups"     }   ]   "Date": "2026-06-06T10:38:47.9975763", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/externalpersongroups/{externalpersongroup_id}

Retrieves an external person group.

Path parameters

externalpersongroup_id

string

required

ID of the external person group to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The external person group object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/externalpersongroups/g_b375dc80-1225-429d-9fb3-5e48b4208bdc \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456
{   "GroupName": "Example group",   "ID": "G_b375dc80-1225-429d-9fb3-5e48b4208bdc",   "Tag": "",   "Type": "ExternalPersonGroups" } 

PUT https://genapiv1.growsparks.com/rest/genapiv1/v1/externalpersongroups/{externalpersongroup_id}

Modifies an external person group.

Path parameters

externalpersongroup_id

string

required

ID of the external person group to modify.

Request body

ExtraData

mapping

optional

List of key/value pairs

GroupName

string

optional

Max 255 chars

PreferredLanguage

string

optional

ISO language code

ProfileImage

asset

optional

Image

Tag

string

optional

Max 100 chars

Returns

The modified external person group object.

Example request
1234567891011
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/externalpersongroups/g_b375dc80-1225-429d-9fb3-5e48b4208bdc \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X PUT \   -d '{   "ExtraData": {"Key":"Value"},   "GroupName": "Example group",   "PreferredLanguage": "en",   "ProfileImage": null,   "Tag": "" }' 

Response
12345678910111213141516
{   "Authorizations": ["G_e50d5855-c28b-4ba4-89eb-555d60d9f4af"],   "ChildMemberships": ["G_20b9c36c-5b3c-413e-b794-1099cc1cf41c"],   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9507106",   "ExtraData": {"Key":"Value"},   "GroupName": "Example group",   "ID": "G_b375dc80-1225-429d-9fb3-5e48b4208bdc",   "ModifiedDate": "2026-06-06T10:38:47.9507106",   "ParentMemberships": ["G_cdbfed17-bab0-4bed-9d2e-c25ca5bef532"],   "PreferredLanguage": "en",   "ProfileImage": null,   "Tag": "",   "Type": "ExternalPersonGroups" } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/externalpersongroups/{externalpersongroup_id}/.activityrecords

Enumerate records of start dates, duration and context of activities and trainings for all persons in this group.

Path parameters

externalpersongroup_id

string

required

ID of the external person group on which the call is applied.

Query parameters

stream

boolean

optional

Stream results using Server-Sent Events

Request body

StartedAfter

date

optional

ISO date format

StartedBefore

date

optional

ISO date format

Response body

enumeration of ActivityRecordBases

The ActivityRecordBase object (abstract)

Base class for activity records

Type

string

One of activityrecord.activity|activityrecord.training

Person

string

expandable

ID of a Person

Activity

string

expandable

ID of an Activity

Duration

integer

Duration in seconds

StartDate

date

ISO date format

The ActivityRecordActivity object (inherits from ActivityRecordBase)

Record of the start and duration of an Activity

Type = activityrecord.activity

ContextActivityGroup

string

expandable

ID of the ActivityGroup in the context of which the activity was started.

ActivityResult

string

ID of an ActivityResult

The ActivityRecordTraining object (inherits from ActivityRecordBase)

Record of the attendance at a ClassroomTraining

Type = activityrecord.training

Attendance

string

expandable

ID of the associated Attendance object.

Example request
12345678
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/externalpersongroups/g_b375dc80-1225-429d-9fb3-5e48b4208bdc/.activityrecords \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "StartedAfter": null,   "StartedBefore": null }' 

Example response
1234567891011121314151617181920
[   {     "Type": "activityrecord.activity",     "Person": "G_63a3d562-72bd-4394-bbac-ae2c3515414a",     "Activity": "G_04c1a2e5-203e-439c-9421-5a7de34c15bb",     "Duration": 100,     "StartDate": "2026-06-06T10:38:47.9507106",     "ContextActivityGroup": "G_92061080-bfbd-42fe-991f-535b3d583aad",     "ActivityResult": "E_155cfe73-9ce7-4ca3-b809-196d44f66bf4"   }   ,   {     "Type": "activityrecord.training",     "Person": "G_63a3d562-72bd-4394-bbac-ae2c3515414a",     "Activity": "G_04c1a2e5-203e-439c-9421-5a7de34c15bb",     "Duration": 100,     "StartDate": "2026-06-06T10:38:47.9507106",     "Attendance": "G_ec72a021-6911-4bb3-8cde-00c3433794fb"   } ] 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/externalpersongroups/{externalpersongroup_id}/.addusers

Add persons to an external person group using an external resource

Path parameters

externalpersongroup_id

string

required

ID of the external person group on which the call is applied.

Request body

Test

bool

optional

Users

object

required

Response body

UserSyncResult

The UserSyncResult object

Success

bool

Example request
12345678
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/externalpersongroups/g_b375dc80-1225-429d-9fb3-5e48b4208bdc/.addusers \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "Test": false,   "Users": null }' 

Example response
123
{   "Success": true } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/externalpersongroups/{externalpersongroup_id}/.exchangemsgraphtoken

Path parameters

externalpersongroup_id

string

required

ID of the external person group on which the call is applied.

Request body

Token

string

required

Returns

Result of the call of type: WebTokenR

Example request
1234567
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/externalpersongroups/g_b375dc80-1225-429d-9fb3-5e48b4208bdc/.exchangemsgraphtoken \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "Token": null }' 

Example response
1
null 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/externalpersongroups/{externalpersongroup_id}/.progress

Calculate status, progress and score of all persons in this group on a specific activitystructure.

Path parameters

externalpersongroup_id

string

required

ID of the external person group on which the call is applied.

Query parameters

stream

boolean

optional

Stream results using Server-Sent Events

Request body

ActivityStructure

string

required

ID of an activity structure

AttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Setting used for program status calculation

EndingAfter

date

optional

ISO date format

Only include memberships ending after date

IncludeDeleted

bool

optional

Include deleted memberships

StartingBefore

date

optional

ISO date format

Only include memberships starting before date

Response body

enumeration of ActivityStatus

The ActivityStatus object

Progress, status and score a single person on an Activity or ActivityGroup

Person

string

expandable

ID of a Person

ActivityStructure

string

expandable

ID of an ActivityStructure

Attempt

integer

# Attempt on this activity, starting from 0

Progress

integer

MaxProgress

integer

Score

integer

MaxScore

integer

Completed

bool

DateCompleted

date

ISO date format

Status

integer

Allowed values: NotStarted (0), Busy (1), Pending (10), Done (20), Failed (30), Passed (40), NotAssigned (-1)

ContentTime

integer

NormalizedScore

float

Example request
1234567891011
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/externalpersongroups/g_b375dc80-1225-429d-9fb3-5e48b4208bdc/.progress \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "ActivityStructure": "G_0d3c341e-ae95-4c06-a875-9ea46fd5d27d",   "AttemptMode": "Last",   "EndingAfter": null,   "IncludeDeleted": false,   "StartingBefore": null }' 

Example response
12345678910111213141516
[   {     "Person": "G_52597b95-dd27-493e-af1c-8f62845008b6",     "ActivityStructure": "G_30021034-bdbf-4f24-be54-30e488c6df9d",     "Attempt": 0,     "Progress": 9,     "MaxProgress": 10,     "Score": 5,     "MaxScore": 10,     "Completed": true,     "DateCompleted": "2026-06-06T10:38:47.9507106",     "Status": 20,     "ContentTime": 60,     "NormalizedScore": 0.5   } ] 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/externalpersongroups/{externalpersongroup_id}/.queryeventlog

Query eventlog for (SSO) events on an external person group

Path parameters

externalpersongroup_id

string

required

ID of the external person group on which the call is applied.

Query parameters

stream

boolean

optional

Stream results using Server-Sent Events

Request body

From

date

optional

ISO date format

Search after ISO date format

Limit

integer

optional

Limit result set (default = 1000)

LogID

integer

optional

Specific log item id if known

string

optional

Plain text search

date

optional

ISO date format

Search before ISO date format

Returns

Result of the call of type: enumeration of BaseLogResults

Example request
1234567891011
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/externalpersongroups/g_b375dc80-1225-429d-9fb3-5e48b4208bdc/.queryeventlog \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "From": null,   "Limit": 1000,   "LogID": null,   "Search": null,   "To": null }' 

Example response
1
null 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/externalpersongroups/{externalpersongroup_id}/.removeusers

Remove persons from an external person group using an external resource

Path parameters

externalpersongroup_id

string

required

ID of the external person group on which the call is applied.

Request body

Test

bool

optional

Users

object

required

Response body

UserSyncResult

The UserSyncResult object

Success

bool

Example request
12345678
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/externalpersongroups/g_b375dc80-1225-429d-9fb3-5e48b4208bdc/.removeusers \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "Test": false,   "Users": null }' 

Example response
123
{   "Success": true } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/externalpersongroups/{externalpersongroup_id}/.report

Path parameters

externalpersongroup_id

string

required

ID of the external person group on which the call is applied.

Query parameters

stream

boolean

optional

Stream results using Server-Sent Events

Request body

ActivityAttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Only include specific attempts

ActivityStructures

array of strings

optional

IDs of activity structures

DeltaDate

date

optional

ISO date format

Only include results after date

IncludeActivities

bool

optional

Add results on each activity to the output

IncludeGroupSummary

bool

optional

Add summaries of person groups to the output

IncludeIntermediateActivityStructures

bool

optional

Include intermediate ActivityStructures

IncludeNotAttempted

bool

optional

Include not attempted results

IncludeParentActivityStructure

bool

optional

Include ID of Parent ActivityStructure

IncludeParentAuthorizable

bool

optional

Include ID of Parent Authorizable

IncludePersons

bool

optional

Add individual results to the output

IncludeProgramSummary

bool

optional

Add calculated program status to the output

IncludeResultDetails

bool

optional

Add details of answered questions to the output

IncludeUnassigned

bool

optional

Add results of activities that are not currently assigned

LearnAuthorizations

array of strings

optional

IDs of learn authorizations

ProgramSummaryAttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Setting used for program status calculation

ReferenceDate

date

optional

ISO date format

Only include results before date

Verbose

bool

optional

Add messages to the output

Response body

enumeration of ProgressReportingBaseResults

The ProgressReportingBaseResult object (abstract)

Base class for report entries

Type

string

The ProgressReportingMessage object (inherits from ProgressReportingBaseResult)

Progress or logging during reporting

Type = report.message

Message

string

DateTime

date

ISO date format

Current time stamp

The ProgressReportingDone object (inherits from ProgressReportingBaseResult)

Indicates that reporting finished successfully

Type = report.finished

DeltaDate

date

ISO date format

ReferenceDate

date

ISO date format

This date can be used for next delta

The ProgressReportingBaseResultLine object (abstract) (inherits from ProgressReportingBaseResult)

Base class for report results

ParentAuthorizable

string

expandable

ID of an Authorizable

Authorizable

string

expandable

ID of an Authorizable

ParentActivityStructure

string

expandable

ID of an ActivityStructure

ActivityStructure

string

expandable

ID of an ActivityStructure

Authorization

string

expandable

ID of an Authorization

ContentTime

integer

Progress

float

NormalizedScore

float

ValidUntil

date

ISO date format

Certificate activities only

RecertificationAfter

date

ISO date format

Certificate activities only

The ProgressReportingGroupResult object (inherits from ProgressReportingBaseResultLine)

Summary of an Activity for a PersonGroup

Type = report.activity.summary

ResultCount

integer

NotStarted

integer

Started

integer

Completed

integer

Passed

integer

Failed

integer

The ProgressReportingGroupProgramResult object (inherits from ProgressReportingGroupResult)

Summary of an ActivityStructure for a PersonGroup

Type = report.program.summary

StatusRules

bool

StatusProgress

float

The ProgressReportingResult object (inherits from ProgressReportingBaseResultLine)

Result of a Person on an Activity

Type = report.activity.result

DateCompleted

date

ISO date format

DateStarted

date

ISO date format

Status

integer

Allowed values: NotStarted (0), Busy (1), Pending (10), Done (20), Failed (30), Passed (40), NotAssigned (-1)

Result

string

ID of an ActivityResult

The ProgressReportingProgramResult object (inherits from ProgressReportingResult)

Result of a Person on an ActivityGroup

Type = report.program.result

StatusRules

bool

StatusProgress

float

Example request
1234567891011121314151617181920212223
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/externalpersongroups/g_b375dc80-1225-429d-9fb3-5e48b4208bdc/.report \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "ActivityAttemptMode": "All",   "ActivityStructures": null,   "DeltaDate": null,   "IncludeActivities": true,   "IncludeGroupSummary": false,   "IncludeIntermediateActivityStructures": false,   "IncludeNotAttempted": false,   "IncludeParentActivityStructure": false,   "IncludeParentAuthorizable": false,   "IncludePersons": true,   "IncludeProgramSummary": false,   "IncludeResultDetails": false,   "IncludeUnassigned": false,   "LearnAuthorizations": null,   "ProgramSummaryAttemptMode": "Last",   "ReferenceDate": null,   "Verbose": false }' 

Example response
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
[   {     "Type": "report.message",     "Message": "Hello world",     "DateTime": "2026-06-06T10:38:47.9507106"   }   ,   {     "Type": "report.finished",     "DeltaDate": "2026-06-06T10:38:47.9507106",     "ReferenceDate": "2026-06-06T10:38:47.9507106"   }   ,   {     "Type": "report.activity.summary",     "ParentAuthorizable": "G_2e660e45-f95b-4891-b72b-74fa89c62f12",     "Authorizable": "G_f295f30c-9b9b-4832-a82f-7b59094982b8",     "ParentActivityStructure": "G_2e308942-c245-4323-9582-4f5c7e7e5793",     "ActivityStructure": "G_899e035a-faa1-415c-91f3-9c3fadfe0261",     "Authorization": "G_d5254b4c-1f68-4146-9384-3f64b8798d6a",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9507106",     "RecertificationAfter": "2026-06-06T10:38:47.9507106",     "ResultCount": 1,     "NotStarted": 2,     "Started": 1,     "Completed": 3,     "Passed": 1,     "Failed": 0   }   ,   {     "Type": "report.program.summary",     "ParentAuthorizable": "G_2e660e45-f95b-4891-b72b-74fa89c62f12",     "Authorizable": "G_f295f30c-9b9b-4832-a82f-7b59094982b8",     "ParentActivityStructure": "G_2e308942-c245-4323-9582-4f5c7e7e5793",     "ActivityStructure": "G_899e035a-faa1-415c-91f3-9c3fadfe0261",     "Authorization": "G_d5254b4c-1f68-4146-9384-3f64b8798d6a",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9507106",     "RecertificationAfter": "2026-06-06T10:38:47.9507106",     "ResultCount": 1,     "NotStarted": 2,     "Started": 1,     "Completed": 3,     "Passed": 1,     "Failed": 0,     "StatusRules": true,     "StatusProgress": null   }   ,   {     "Type": "report.activity.result",     "ParentAuthorizable": "G_2e660e45-f95b-4891-b72b-74fa89c62f12",     "Authorizable": "G_f295f30c-9b9b-4832-a82f-7b59094982b8",     "ParentActivityStructure": "G_2e308942-c245-4323-9582-4f5c7e7e5793",     "ActivityStructure": "G_899e035a-faa1-415c-91f3-9c3fadfe0261",     "Authorization": "G_d5254b4c-1f68-4146-9384-3f64b8798d6a",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9507106",     "RecertificationAfter": "2026-06-06T10:38:47.9507106",     "DateCompleted": "2026-06-06T10:38:47.9507106",     "DateStarted": "2026-06-06T10:38:47.9507106",     "Status": null,     "Result": "E_b0f12896-41eb-4925-a096-3c3bceb87248"   }   ,   {     "Type": "report.program.result",     "ParentAuthorizable": "G_2e660e45-f95b-4891-b72b-74fa89c62f12",     "Authorizable": "G_f295f30c-9b9b-4832-a82f-7b59094982b8",     "ParentActivityStructure": "G_2e308942-c245-4323-9582-4f5c7e7e5793",     "ActivityStructure": "G_899e035a-faa1-415c-91f3-9c3fadfe0261",     "Authorization": "G_d5254b4c-1f68-4146-9384-3f64b8798d6a",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9507106",     "RecertificationAfter": "2026-06-06T10:38:47.9507106",     "DateCompleted": "2026-06-06T10:38:47.9507106",     "DateStarted": "2026-06-06T10:38:47.9507106",     "Status": null,     "Result": "E_b0f12896-41eb-4925-a096-3c3bceb87248",     "StatusRules": true,     "StatusProgress": null   } ] 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/externalpersongroups/{externalpersongroup_id}/.syncusers

Synchronize external person group with an external resource

Path parameters

externalpersongroup_id

string

required

ID of the external person group on which the call is applied.

Request body

Test

bool

optional

Users

object

required

Response body

UserSyncResult

The UserSyncResult object

Success

bool

Example request
12345678
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/externalpersongroups/g_b375dc80-1225-429d-9fb3-5e48b4208bdc/.syncusers \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "Test": false,   "Users": null }' 

Example response
123
{   "Success": true } 

MembershipRoles

Assignment of a role on a membership.

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

string

readonly always

Unique

Available filter operations: EQUALS

Membership

string

immutable default

Available filter operations: EQUALS

ID of a PersonGroupMembership

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Role

string

immutable default expandable

Available filter operations: EQUALS

ID of a Role

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

The membership role object
1234567891011
{   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9507106",   "ID": "G_ee9e4225-fa8d-4bee-91a0-467e5ac96f95",   "Membership": "G_f98ad4e4-a348-45f2-922a-bed427f1e913",   "ModifiedDate": "2026-06-06T10:38:47.9507106",   "Role": "G_33b47846-b5ab-4b7a-b9c5-eb5aa660a326",   "Tag": "",   "Type": "MembershipRoles" } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/membershiproles

Creates a new membership role.

Request body

Membership

string

required

ID of a PersonGroupMembership

Role

string

required

ID of a Role

Tag

string

optional

Max 100 chars

Returns

The newly created membership role object.

Example request
123456789
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/membershiproles \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "Membership": "G_f98ad4e4-a348-45f2-922a-bed427f1e913",   "Role": "G_33b47846-b5ab-4b7a-b9c5-eb5aa660a326",   "Tag": "" }' 

Response
1234567891011
{   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9507106",   "ID": "G_ee9e4225-fa8d-4bee-91a0-467e5ac96f95",   "Membership": "G_f98ad4e4-a348-45f2-922a-bed427f1e913",   "ModifiedDate": "2026-06-06T10:38:47.9507106",   "Role": "G_33b47846-b5ab-4b7a-b9c5-eb5aa660a326",   "Tag": "",   "Type": "MembershipRoles" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/membershiproles

Returns a list of membership roles.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of membership role objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/membershiproles \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456789101112131415
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "ID": "G_ee9e4225-fa8d-4bee-91a0-467e5ac96f95",       "Membership": "G_f98ad4e4-a348-45f2-922a-bed427f1e913",       "Role": "G_33b47846-b5ab-4b7a-b9c5-eb5aa660a326",       "Tag": "",       "Type": "MembershipRoles"     }   ]   "Date": "2026-06-06T10:38:47.9975763", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/membershiproles/{membershiprole_id}

Retrieves a membership role.

Path parameters

membershiprole_id

string

required

ID of the membership role to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The membership role object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/membershiproles/g_ee9e4225-fa8d-4bee-91a0-467e5ac96f95 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
1234567
{   "ID": "G_ee9e4225-fa8d-4bee-91a0-467e5ac96f95",   "Membership": "G_f98ad4e4-a348-45f2-922a-bed427f1e913",   "Role": "G_33b47846-b5ab-4b7a-b9c5-eb5aa660a326",   "Tag": "",   "Type": "MembershipRoles" } 

PUT https://genapiv1.growsparks.com/rest/genapiv1/v1/membershiproles/{membershiprole_id}

Modifies a membership role.

Path parameters

membershiprole_id

string

required

ID of the membership role to modify.

Request body

Tag

string

optional

Max 100 chars

Returns

The modified membership role object.

Example request
1234567
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/membershiproles/g_ee9e4225-fa8d-4bee-91a0-467e5ac96f95 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X PUT \   -d '{   "Tag": "" }' 

Response
1234567891011
{   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9507106",   "ID": "G_ee9e4225-fa8d-4bee-91a0-467e5ac96f95",   "Membership": "G_f98ad4e4-a348-45f2-922a-bed427f1e913",   "ModifiedDate": "2026-06-06T10:38:47.9507106",   "Role": "G_33b47846-b5ab-4b7a-b9c5-eb5aa660a326",   "Tag": "",   "Type": "MembershipRoles" } 

PersonGroupMemberships

Authorizables can be member of PersonGroups. This membership is expressed by PersonGroupMemberships

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Deleted

bool

readwrite default

Available filter operations: EQUALS

EndDate

date

readwrite default

ISO date format

Filter not supported

string

readonly always

Unique

Available filter operations: EQUALS

Member

string

immutable default expandable

Available filter operations: EQUALS

ID of an Authorizable

MemberOf

string

readwrite default expandable

Available filter operations: EQUALS

ID of a PersonGroup

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

StartDate

date

readwrite default

ISO date format

Filter not supported

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

The person group membership object
1234567891011121314
{   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9507106",   "Deleted": false,   "EndDate": "2026-01-01T00:00:00",   "ID": "G_12f99a9e-4f4b-4394-9ebc-d333bf1e9a79",   "Member": "G_c25f5429-3257-434b-9028-5d8c0a37894b",   "MemberOf": "G_956f9fad-5a87-4b13-8c7d-01eb8dbe28fb",   "ModifiedDate": "2026-06-06T10:38:47.9507106",   "StartDate": "2026-01-01T00:00:00",   "Tag": "",   "Type": "PersonGroupMemberships" } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/persongroupmemberships

Creates a new person group membership.

Request body

Deleted

bool

optional

EndDate

date

optional

ISO date format

Member

string

required

ID of an Authorizable

MemberOf

string

required

ID of a PersonGroup

StartDate

date

optional

ISO date format

Tag

string

optional

Max 100 chars

Returns

The newly created person group membership object.

Example request
123456789101112
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/persongroupmemberships \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "Deleted": false,   "EndDate": "2026-01-01T00:00:00",   "Member": "G_c25f5429-3257-434b-9028-5d8c0a37894b",   "MemberOf": "G_956f9fad-5a87-4b13-8c7d-01eb8dbe28fb",   "StartDate": "2026-01-01T00:00:00",   "Tag": "" }' 

Response
1234567891011121314
{   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9507106",   "Deleted": false,   "EndDate": "2026-01-01T00:00:00",   "ID": "G_12f99a9e-4f4b-4394-9ebc-d333bf1e9a79",   "Member": "G_c25f5429-3257-434b-9028-5d8c0a37894b",   "MemberOf": "G_956f9fad-5a87-4b13-8c7d-01eb8dbe28fb",   "ModifiedDate": "2026-06-06T10:38:47.9507106",   "StartDate": "2026-01-01T00:00:00",   "Tag": "",   "Type": "PersonGroupMemberships" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/persongroupmemberships

Returns a list of person group memberships.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of person group membership objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/persongroupmemberships \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456789101112131415161718
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "Deleted": false,       "EndDate": "2026-01-01T00:00:00",       "ID": "G_12f99a9e-4f4b-4394-9ebc-d333bf1e9a79",       "Member": "G_c25f5429-3257-434b-9028-5d8c0a37894b",       "MemberOf": "G_956f9fad-5a87-4b13-8c7d-01eb8dbe28fb",       "StartDate": "2026-01-01T00:00:00",       "Tag": "",       "Type": "PersonGroupMemberships"     }   ]   "Date": "2026-06-06T10:38:47.9975763", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/persongroupmemberships/{persongroupmembership_id}

Retrieves a person group membership.

Path parameters

persongroupmembership_id

string

required

ID of the person group membership to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The person group membership object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/persongroupmemberships/g_12f99a9e-4f4b-4394-9ebc-d333bf1e9a79 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
12345678910
{   "Deleted": false,   "EndDate": "2026-01-01T00:00:00",   "ID": "G_12f99a9e-4f4b-4394-9ebc-d333bf1e9a79",   "Member": "G_c25f5429-3257-434b-9028-5d8c0a37894b",   "MemberOf": "G_956f9fad-5a87-4b13-8c7d-01eb8dbe28fb",   "StartDate": "2026-01-01T00:00:00",   "Tag": "",   "Type": "PersonGroupMemberships" } 

PUT https://genapiv1.growsparks.com/rest/genapiv1/v1/persongroupmemberships/{persongroupmembership_id}

Modifies a person group membership.

Path parameters

persongroupmembership_id

string

required

ID of the person group membership to modify.

Request body

Deleted

bool

optional

EndDate

date

optional

ISO date format

MemberOf

string

required

ID of a PersonGroup

StartDate

date

optional

ISO date format

Tag

string

optional

Max 100 chars

Returns

The modified person group membership object.

Example request
1234567891011
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/persongroupmemberships/g_12f99a9e-4f4b-4394-9ebc-d333bf1e9a79 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X PUT \   -d '{   "Deleted": false,   "EndDate": "2026-01-01T00:00:00",   "MemberOf": "G_956f9fad-5a87-4b13-8c7d-01eb8dbe28fb",   "StartDate": "2026-01-01T00:00:00",   "Tag": "" }' 

Response
1234567891011121314
{   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9507106",   "Deleted": false,   "EndDate": "2026-01-01T00:00:00",   "ID": "G_12f99a9e-4f4b-4394-9ebc-d333bf1e9a79",   "Member": "G_c25f5429-3257-434b-9028-5d8c0a37894b",   "MemberOf": "G_956f9fad-5a87-4b13-8c7d-01eb8dbe28fb",   "ModifiedDate": "2026-06-06T10:38:47.9507106",   "StartDate": "2026-01-01T00:00:00",   "Tag": "",   "Type": "PersonGroupMemberships" } 

DELETE https://genapiv1.growsparks.com/rest/genapiv1/v1/persongroupmemberships/{persongroupmembership_id}

Deletes a person group membership.

Path parameters

persongroupmembership_id

string

required

ID of the person group membership to delete.

Returns

Nothing

Example request
1234
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/persongroupmemberships/g_12f99a9e-4f4b-4394-9ebc-d333bf1e9a79 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X DELETE 

PersonGroups

Use PersonGroups to group Authorizables like Persons and other PersonGroups

Authorizations

array of strings

readonly request expandable

IDs of Entities

Filter not supported

ChildMemberships

array of strings

readonly request expandable

IDs of Entities

Filter not supported

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

ExtraData

mapping

readwrite request

List of key/value pairs

Filter not supported

GroupName

string

readwrite default

Max 255 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

string

readonly always

Unique

Available filter operations: EQUALS,PATH_TO_ROOT,SUB_TREE,MEMBER_OF

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

ParentMemberships

array of strings

readonly request expandable

IDs of Entities

Filter not supported

PreferredLanguage

string

readwrite request

ISO language code

Filter not supported

ProfileImage

asset

readwrite request

Image

Filter not supported

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

The person group object
12345678910111213141516
{   "Authorizations": ["G_ad27d4c5-6c3c-452b-80f8-e5cd27d3302e"],   "ChildMemberships": ["G_e3c415d6-8e1b-40d3-b0f2-61eef96d8334"],   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9507106",   "ExtraData": {"Key":"Value"},   "GroupName": "Example group",   "ID": "G_b0ebc3ea-aa54-458e-9ba4-642bc99ae1b0",   "ModifiedDate": "2026-06-06T10:38:47.9507106",   "ParentMemberships": ["G_0d3fc614-c992-4d31-88d9-f5993ff00441"],   "PreferredLanguage": "en",   "ProfileImage": null,   "Tag": "",   "Type": "PersonGroups" } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/persongroups

Creates a new person group.

Request body

ExtraData

mapping

optional

List of key/value pairs

GroupName

string

optional

Max 255 chars

PreferredLanguage

string

optional

ISO language code

ProfileImage

asset

optional

Image

Tag

string

optional

Max 100 chars

Returns

The newly created person group object.

Example request
1234567891011
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/persongroups \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "ExtraData": {"Key":"Value"},   "GroupName": "Example group",   "PreferredLanguage": "en",   "ProfileImage": null,   "Tag": "" }' 

Response
12345678910111213141516
{   "Authorizations": ["G_ad27d4c5-6c3c-452b-80f8-e5cd27d3302e"],   "ChildMemberships": ["G_e3c415d6-8e1b-40d3-b0f2-61eef96d8334"],   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9507106",   "ExtraData": {"Key":"Value"},   "GroupName": "Example group",   "ID": "G_b0ebc3ea-aa54-458e-9ba4-642bc99ae1b0",   "ModifiedDate": "2026-06-06T10:38:47.9507106",   "ParentMemberships": ["G_0d3fc614-c992-4d31-88d9-f5993ff00441"],   "PreferredLanguage": "en",   "ProfileImage": null,   "Tag": "",   "Type": "PersonGroups" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/persongroups

Returns a list of person groups.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of person group objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/persongroups \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
1234567891011121314
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "GroupName": "Example group",       "ID": "G_b0ebc3ea-aa54-458e-9ba4-642bc99ae1b0",       "Tag": "",       "Type": "PersonGroups"     }   ]   "Date": "2026-06-06T10:38:47.9975763", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/persongroups/{persongroup_id}

Retrieves a person group.

Path parameters

persongroup_id

string

required

ID of the person group to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The person group object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/persongroups/g_b0ebc3ea-aa54-458e-9ba4-642bc99ae1b0 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456
{   "GroupName": "Example group",   "ID": "G_b0ebc3ea-aa54-458e-9ba4-642bc99ae1b0",   "Tag": "",   "Type": "PersonGroups" } 

PUT https://genapiv1.growsparks.com/rest/genapiv1/v1/persongroups/{persongroup_id}

Modifies a person group.

Path parameters

persongroup_id

string

required

ID of the person group to modify.

Request body

ExtraData

mapping

optional

List of key/value pairs

GroupName

string

optional

Max 255 chars

PreferredLanguage

string

optional

ISO language code

ProfileImage

asset

optional

Image

Tag

string

optional

Max 100 chars

Returns

The modified person group object.

Example request
1234567891011
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/persongroups/g_b0ebc3ea-aa54-458e-9ba4-642bc99ae1b0 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X PUT \   -d '{   "ExtraData": {"Key":"Value"},   "GroupName": "Example group",   "PreferredLanguage": "en",   "ProfileImage": null,   "Tag": "" }' 

Response
12345678910111213141516
{   "Authorizations": ["G_ad27d4c5-6c3c-452b-80f8-e5cd27d3302e"],   "ChildMemberships": ["G_e3c415d6-8e1b-40d3-b0f2-61eef96d8334"],   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9507106",   "ExtraData": {"Key":"Value"},   "GroupName": "Example group",   "ID": "G_b0ebc3ea-aa54-458e-9ba4-642bc99ae1b0",   "ModifiedDate": "2026-06-06T10:38:47.9507106",   "ParentMemberships": ["G_0d3fc614-c992-4d31-88d9-f5993ff00441"],   "PreferredLanguage": "en",   "ProfileImage": null,   "Tag": "",   "Type": "PersonGroups" } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/persongroups/{persongroup_id}/.activityrecords

Enumerate records of start dates, duration and context of activities and trainings for all persons in this group.

Path parameters

persongroup_id

string

required

ID of the person group on which the call is applied.

Query parameters

stream

boolean

optional

Stream results using Server-Sent Events

Request body

StartedAfter

date

optional

ISO date format

StartedBefore

date

optional

ISO date format

Response body

enumeration of ActivityRecordBases

The ActivityRecordBase object (abstract)

Base class for activity records

Type

string

One of activityrecord.activity|activityrecord.training

Person

string

expandable

ID of a Person

Activity

string

expandable

ID of an Activity

Duration

integer

Duration in seconds

StartDate

date

ISO date format

The ActivityRecordActivity object (inherits from ActivityRecordBase)

Record of the start and duration of an Activity

Type = activityrecord.activity

ContextActivityGroup

string

expandable

ID of the ActivityGroup in the context of which the activity was started.

ActivityResult

string

ID of an ActivityResult

The ActivityRecordTraining object (inherits from ActivityRecordBase)

Record of the attendance at a ClassroomTraining

Type = activityrecord.training

Attendance

string

expandable

ID of the associated Attendance object.

Example request
12345678
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/persongroups/g_b0ebc3ea-aa54-458e-9ba4-642bc99ae1b0/.activityrecords \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "StartedAfter": null,   "StartedBefore": null }' 

Example response
1234567891011121314151617181920
[   {     "Type": "activityrecord.activity",     "Person": "G_ecb7ee15-6126-4528-876f-facffe96dca4",     "Activity": "G_4d8dc47a-2313-4780-b452-267dd2072710",     "Duration": 100,     "StartDate": "2026-06-06T10:38:47.9507106",     "ContextActivityGroup": "G_4b9adb40-5ecb-49c8-8596-af580afeb056",     "ActivityResult": "E_16039f31-202c-4f54-871d-c2cdc0ffff80"   }   ,   {     "Type": "activityrecord.training",     "Person": "G_ecb7ee15-6126-4528-876f-facffe96dca4",     "Activity": "G_4d8dc47a-2313-4780-b452-267dd2072710",     "Duration": 100,     "StartDate": "2026-06-06T10:38:47.9507106",     "Attendance": "G_5eff733e-d7aa-4c0e-b9f4-ea97d20730cd"   } ] 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/persongroups/{persongroup_id}/.progress

Calculate status, progress and score of all persons in this group on a specific activitystructure.

Path parameters

persongroup_id

string

required

ID of the person group on which the call is applied.

Query parameters

stream

boolean

optional

Stream results using Server-Sent Events

Request body

ActivityStructure

string

required

ID of an activity structure

AttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Setting used for program status calculation

EndingAfter

date

optional

ISO date format

Only include memberships ending after date

IncludeDeleted

bool

optional

Include deleted memberships

StartingBefore

date

optional

ISO date format

Only include memberships starting before date

Response body

enumeration of ActivityStatus

The ActivityStatus object

Progress, status and score a single person on an Activity or ActivityGroup

Person

string

expandable

ID of a Person

ActivityStructure

string

expandable

ID of an ActivityStructure

Attempt

integer

# Attempt on this activity, starting from 0

Progress

integer

MaxProgress

integer

Score

integer

MaxScore

integer

Completed

bool

DateCompleted

date

ISO date format

Status

integer

Allowed values: NotStarted (0), Busy (1), Pending (10), Done (20), Failed (30), Passed (40), NotAssigned (-1)

ContentTime

integer

NormalizedScore

float

Example request
1234567891011
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/persongroups/g_b0ebc3ea-aa54-458e-9ba4-642bc99ae1b0/.progress \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "ActivityStructure": "G_0d3c341e-ae95-4c06-a875-9ea46fd5d27d",   "AttemptMode": "Last",   "EndingAfter": null,   "IncludeDeleted": false,   "StartingBefore": null }' 

Example response
12345678910111213141516
[   {     "Person": "G_772853d5-11be-450c-ac25-86f165965cec",     "ActivityStructure": "G_9f5072c0-9871-4858-b317-6e94c0449f46",     "Attempt": 0,     "Progress": 9,     "MaxProgress": 10,     "Score": 5,     "MaxScore": 10,     "Completed": true,     "DateCompleted": "2026-06-06T10:38:47.9507106",     "Status": 20,     "ContentTime": 60,     "NormalizedScore": 0.5   } ] 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/persongroups/{persongroup_id}/.report

Path parameters

persongroup_id

string

required

ID of the person group on which the call is applied.

Query parameters

stream

boolean

optional

Stream results using Server-Sent Events

Request body

ActivityAttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Only include specific attempts

ActivityStructures

array of strings

optional

IDs of activity structures

DeltaDate

date

optional

ISO date format

Only include results after date

IncludeActivities

bool

optional

Add results on each activity to the output

IncludeGroupSummary

bool

optional

Add summaries of person groups to the output

IncludeIntermediateActivityStructures

bool

optional

Include intermediate ActivityStructures

IncludeNotAttempted

bool

optional

Include not attempted results

IncludeParentActivityStructure

bool

optional

Include ID of Parent ActivityStructure

IncludeParentAuthorizable

bool

optional

Include ID of Parent Authorizable

IncludePersons

bool

optional

Add individual results to the output

IncludeProgramSummary

bool

optional

Add calculated program status to the output

IncludeResultDetails

bool

optional

Add details of answered questions to the output

IncludeUnassigned

bool

optional

Add results of activities that are not currently assigned

LearnAuthorizations

array of strings

optional

IDs of learn authorizations

ProgramSummaryAttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Setting used for program status calculation

ReferenceDate

date

optional

ISO date format

Only include results before date

Verbose

bool

optional

Add messages to the output

Response body

enumeration of ProgressReportingBaseResults

The ProgressReportingBaseResult object (abstract)

Base class for report entries

Type

string

The ProgressReportingMessage object (inherits from ProgressReportingBaseResult)

Progress or logging during reporting

Type = report.message

Message

string

DateTime

date

ISO date format

Current time stamp

The ProgressReportingDone object (inherits from ProgressReportingBaseResult)

Indicates that reporting finished successfully

Type = report.finished

DeltaDate

date

ISO date format

ReferenceDate

date

ISO date format

This date can be used for next delta

The ProgressReportingBaseResultLine object (abstract) (inherits from ProgressReportingBaseResult)

Base class for report results

ParentAuthorizable

string

expandable

ID of an Authorizable

Authorizable

string

expandable

ID of an Authorizable

ParentActivityStructure

string

expandable

ID of an ActivityStructure

ActivityStructure

string

expandable

ID of an ActivityStructure

Authorization

string

expandable

ID of an Authorization

ContentTime

integer

Progress

float

NormalizedScore

float

ValidUntil

date

ISO date format

Certificate activities only

RecertificationAfter

date

ISO date format

Certificate activities only

The ProgressReportingGroupResult object (inherits from ProgressReportingBaseResultLine)

Summary of an Activity for a PersonGroup

Type = report.activity.summary

ResultCount

integer

NotStarted

integer

Started

integer

Completed

integer

Passed

integer

Failed

integer

The ProgressReportingGroupProgramResult object (inherits from ProgressReportingGroupResult)

Summary of an ActivityStructure for a PersonGroup

Type = report.program.summary

StatusRules

bool

StatusProgress

float

The ProgressReportingResult object (inherits from ProgressReportingBaseResultLine)

Result of a Person on an Activity

Type = report.activity.result

DateCompleted

date

ISO date format

DateStarted

date

ISO date format

Status

integer

Allowed values: NotStarted (0), Busy (1), Pending (10), Done (20), Failed (30), Passed (40), NotAssigned (-1)

Result

string

ID of an ActivityResult

The ProgressReportingProgramResult object (inherits from ProgressReportingResult)

Result of a Person on an ActivityGroup

Type = report.program.result

StatusRules

bool

StatusProgress

float

Example request
1234567891011121314151617181920212223
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/persongroups/g_b0ebc3ea-aa54-458e-9ba4-642bc99ae1b0/.report \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "ActivityAttemptMode": "All",   "ActivityStructures": null,   "DeltaDate": null,   "IncludeActivities": true,   "IncludeGroupSummary": false,   "IncludeIntermediateActivityStructures": false,   "IncludeNotAttempted": false,   "IncludeParentActivityStructure": false,   "IncludeParentAuthorizable": false,   "IncludePersons": true,   "IncludeProgramSummary": false,   "IncludeResultDetails": false,   "IncludeUnassigned": false,   "LearnAuthorizations": null,   "ProgramSummaryAttemptMode": "Last",   "ReferenceDate": null,   "Verbose": false }' 

Example response
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
[   {     "Type": "report.message",     "Message": "Hello world",     "DateTime": "2026-06-06T10:38:47.9663409"   }   ,   {     "Type": "report.finished",     "DeltaDate": "2026-06-06T10:38:47.9663409",     "ReferenceDate": "2026-06-06T10:38:47.9663409"   }   ,   {     "Type": "report.activity.summary",     "ParentAuthorizable": "G_be433ad7-fa61-4825-b45e-6703d67933c6",     "Authorizable": "G_49d267b8-c8a5-4d72-b64d-ab3f24fcc572",     "ParentActivityStructure": "G_c484d000-59e5-46c8-a34c-fadc448b3ab4",     "ActivityStructure": "G_8c9ab018-f5fe-48ae-9af0-310b0b9f8f0c",     "Authorization": "G_6034226e-9948-4329-9093-421a32977ff8",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9663409",     "RecertificationAfter": "2026-06-06T10:38:47.9663409",     "ResultCount": 1,     "NotStarted": 2,     "Started": 1,     "Completed": 3,     "Passed": 1,     "Failed": 0   }   ,   {     "Type": "report.program.summary",     "ParentAuthorizable": "G_be433ad7-fa61-4825-b45e-6703d67933c6",     "Authorizable": "G_49d267b8-c8a5-4d72-b64d-ab3f24fcc572",     "ParentActivityStructure": "G_c484d000-59e5-46c8-a34c-fadc448b3ab4",     "ActivityStructure": "G_8c9ab018-f5fe-48ae-9af0-310b0b9f8f0c",     "Authorization": "G_6034226e-9948-4329-9093-421a32977ff8",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9663409",     "RecertificationAfter": "2026-06-06T10:38:47.9663409",     "ResultCount": 1,     "NotStarted": 2,     "Started": 1,     "Completed": 3,     "Passed": 1,     "Failed": 0,     "StatusRules": true,     "StatusProgress": null   }   ,   {     "Type": "report.activity.result",     "ParentAuthorizable": "G_be433ad7-fa61-4825-b45e-6703d67933c6",     "Authorizable": "G_49d267b8-c8a5-4d72-b64d-ab3f24fcc572",     "ParentActivityStructure": "G_c484d000-59e5-46c8-a34c-fadc448b3ab4",     "ActivityStructure": "G_8c9ab018-f5fe-48ae-9af0-310b0b9f8f0c",     "Authorization": "G_6034226e-9948-4329-9093-421a32977ff8",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9663409",     "RecertificationAfter": "2026-06-06T10:38:47.9663409",     "DateCompleted": "2026-06-06T10:38:47.9663409",     "DateStarted": "2026-06-06T10:38:47.9663409",     "Status": null,     "Result": "E_00c5a286-048a-4fba-a2b8-fc2c00fa779e"   }   ,   {     "Type": "report.program.result",     "ParentAuthorizable": "G_be433ad7-fa61-4825-b45e-6703d67933c6",     "Authorizable": "G_49d267b8-c8a5-4d72-b64d-ab3f24fcc572",     "ParentActivityStructure": "G_c484d000-59e5-46c8-a34c-fadc448b3ab4",     "ActivityStructure": "G_8c9ab018-f5fe-48ae-9af0-310b0b9f8f0c",     "Authorization": "G_6034226e-9948-4329-9093-421a32977ff8",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9663409",     "RecertificationAfter": "2026-06-06T10:38:47.9663409",     "DateCompleted": "2026-06-06T10:38:47.9663409",     "DateStarted": "2026-06-06T10:38:47.9663409",     "Status": null,     "Result": "E_00c5a286-048a-4fba-a2b8-fc2c00fa779e",     "StatusRules": true,     "StatusProgress": null   } ] 

Persons

Representation of a real life person

Authorizations

array of strings

readonly request expandable

IDs of Entities

Filter not supported

BirthDate

date

readwrite request

ISO date format

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

DisplayName

string

readwrite request

Max 255 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

string

readwrite default

Max 255 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

ExternalID

string

readwrite default

Max 255 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

ExtraData

mapping

readwrite request

List of key/value pairs

Filter not supported

FirstName

string

readwrite default

Max 255 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

string

readonly always

Unique

Available filter operations: EQUALS,PATH_TO_ROOT,SUB_TREE,MEMBER_OF

Initials

string

readwrite request

Max 255 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

LastName

string

readwrite default

Max 255 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

MidName

string

readwrite request

Max 255 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

ParentMemberships

array of strings

readonly request expandable

IDs of Entities

Filter not supported

PreferredLanguage

string

readwrite request

ISO language code

Filter not supported

ProfileImage

asset

readwrite request

Image

Filter not supported

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

The person object
12345678910111213141516171819202122
{   "Authorizations": ["G_c1d04521-05ae-44be-ad66-11a171106018"],   "BirthDate": null,   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9663409",   "DisplayName": "Johnny Doe",   "Email": "john@example.com",   "ExternalID": "jd01",   "ExtraData": {"Key":"Value"},   "FirstName": "John",   "ID": "G_6450be15-0561-407f-bc27-1eb6ccdef02f",   "Initials": null,   "LastName": "Doe",   "MidName": null,   "ModifiedDate": "2026-06-06T10:38:47.9663409",   "ParentMemberships": ["G_dbbe9d66-9a34-4d59-b4ad-131a0252683e"],   "PreferredLanguage": "en",   "ProfileImage": null,   "Tag": "",   "Type": "Persons" } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/persons

Creates a new person.

Request body

BirthDate

date

optional

ISO date format

DisplayName

string

optional

Max 255 chars

string

optional

Max 255 chars

ExternalID

string

optional

Max 255 chars

ExtraData

mapping

optional

List of key/value pairs

FirstName

string

optional

Max 255 chars

Initials

string

optional

Max 255 chars

LastName

string

optional

Max 255 chars

MidName

string

optional

Max 255 chars

PreferredLanguage

string

optional

ISO language code

ProfileImage

asset

optional

Image

Tag

string

optional

Max 100 chars

Returns

The newly created person object.

Example request
123456789101112131415161718
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/persons \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "BirthDate": null,   "DisplayName": "Johnny Doe",   "Email": "john@example.com",   "ExternalID": "jd01",   "ExtraData": {"Key":"Value"},   "FirstName": "John",   "Initials": null,   "LastName": "Doe",   "MidName": null,   "PreferredLanguage": "en",   "ProfileImage": null,   "Tag": "" }' 

Response
12345678910111213141516171819202122
{   "Authorizations": ["G_c1d04521-05ae-44be-ad66-11a171106018"],   "BirthDate": null,   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9663409",   "DisplayName": "Johnny Doe",   "Email": "john@example.com",   "ExternalID": "jd01",   "ExtraData": {"Key":"Value"},   "FirstName": "John",   "ID": "G_6450be15-0561-407f-bc27-1eb6ccdef02f",   "Initials": null,   "LastName": "Doe",   "MidName": null,   "ModifiedDate": "2026-06-06T10:38:47.9663409",   "ParentMemberships": ["G_dbbe9d66-9a34-4d59-b4ad-131a0252683e"],   "PreferredLanguage": "en",   "ProfileImage": null,   "Tag": "",   "Type": "Persons" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/persons

Returns a list of persons.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of person objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/persons \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
1234567891011121314151617
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "Email": "john@example.com",       "ExternalID": "jd01",       "FirstName": "John",       "ID": "G_6450be15-0561-407f-bc27-1eb6ccdef02f",       "LastName": "Doe",       "Tag": "",       "Type": "Persons"     }   ]   "Date": "2026-06-06T10:38:47.9975763", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/persons/{person_id}

Retrieves a person.

Path parameters

person_id

string

required

ID of the person to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The person object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/persons/g_6450be15-0561-407f-bc27-1eb6ccdef02f \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456789
{   "Email": "john@example.com",   "ExternalID": "jd01",   "FirstName": "John",   "ID": "G_6450be15-0561-407f-bc27-1eb6ccdef02f",   "LastName": "Doe",   "Tag": "",   "Type": "Persons" } 

PUT https://genapiv1.growsparks.com/rest/genapiv1/v1/persons/{person_id}

Modifies a person.

Path parameters

person_id

string

required

ID of the person to modify.

Request body

BirthDate

date

optional

ISO date format

DisplayName

string

optional

Max 255 chars

string

optional

Max 255 chars

ExternalID

string

optional

Max 255 chars

ExtraData

mapping

optional

List of key/value pairs

FirstName

string

optional

Max 255 chars

Initials

string

optional

Max 255 chars

LastName

string

optional

Max 255 chars

MidName

string

optional

Max 255 chars

PreferredLanguage

string

optional

ISO language code

ProfileImage

asset

optional

Image

Tag

string

optional

Max 100 chars

Returns

The modified person object.

Example request
123456789101112131415161718
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/persons/g_6450be15-0561-407f-bc27-1eb6ccdef02f \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X PUT \   -d '{   "BirthDate": null,   "DisplayName": "Johnny Doe",   "Email": "john@example.com",   "ExternalID": "jd01",   "ExtraData": {"Key":"Value"},   "FirstName": "John",   "Initials": null,   "LastName": "Doe",   "MidName": null,   "PreferredLanguage": "en",   "ProfileImage": null,   "Tag": "" }' 

Response
12345678910111213141516171819202122
{   "Authorizations": ["G_c1d04521-05ae-44be-ad66-11a171106018"],   "BirthDate": null,   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9663409",   "DisplayName": "Johnny Doe",   "Email": "john@example.com",   "ExternalID": "jd01",   "ExtraData": {"Key":"Value"},   "FirstName": "John",   "ID": "G_6450be15-0561-407f-bc27-1eb6ccdef02f",   "Initials": null,   "LastName": "Doe",   "MidName": null,   "ModifiedDate": "2026-06-06T10:38:47.9663409",   "ParentMemberships": ["G_dbbe9d66-9a34-4d59-b4ad-131a0252683e"],   "PreferredLanguage": "en",   "ProfileImage": null,   "Tag": "",   "Type": "Persons" } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/persons/{person_id}/.createemailimpersonation

Create an impersonation for the person using an email address.

Path parameters

person_id

string

required

ID of the person on which the call is applied.

Request body

LoginEmail

string

optional

Response body

ImpersonationObject

The ImpersonationObject object

ContactEmail

string

UserUniqueID

string

UserIsNew

bool

ImpersonationIsNew

bool

MailSent

bool

Example request
1234567
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/persons/g_6450be15-0561-407f-bc27-1eb6ccdef02f/.createemailimpersonation \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "LoginEmail": "john@example.com" }' 

Example response
1234567
{   "ContactEmail": "john@example.com",   "UserUniqueID": "email:john@example.com",   "UserIsNew": false,   "ImpersonationIsNew": false,   "MailSent": true } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/persons/{person_id}/.createsinglesignonurl

Create a Single Sign On URL for the person.

Path parameters

person_id

string

required

ID of the person on which the call is applied.

Request body

ActivityMode

enum

optional

Allowed values: Normal, View, Preview, Review, Edit

ContactEmail

string

optional

StartActivityStructure

string

optional

ID of an activity structure

ID of an activity or program to start after sign on

Response body

SingleSignOnURLObject

The SingleSignOnURLObject object

URL

string

ContactEmail

string

UserUniqueID

string

UserIsNew

bool

StartupOptions

mapping

Example request
123456789
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/persons/g_6450be15-0561-407f-bc27-1eb6ccdef02f/.createsinglesignonurl \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "ActivityMode": "Normal",   "ContactEmail": "john@example.com",   "StartActivityStructure": "G_a845b752-7cf4-43a6-8dc4-f65439a15ee0" }' 

Example response
1234567
{   "URL": "https://example.flowsparks.com?store=4564b942-b744-4a9b-986e-1d09887e59c5",   "ContactEmail": "john@example.com",   "UserUniqueID": "\RESTV1\467cb8ba-cb51-44f2-8a44-905958cdfa05",   "UserIsNew": false,   "StartupOptions": {"Key":"Value"} } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/persons/{person_id}/.createusernameimpersonation

Create an impersonation for the person using an unique username.

Path parameters

person_id

string

required

ID of the person on which the call is applied.

Request body

ContactEmail

string

optional

Username

string

required

Response body

ImpersonationObject

The ImpersonationObject object

ContactEmail

string

UserUniqueID

string

UserIsNew

bool

ImpersonationIsNew

bool

MailSent

bool

Example request
12345678
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/persons/g_6450be15-0561-407f-bc27-1eb6ccdef02f/.createusernameimpersonation \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "ContactEmail": "john@example.com",   "Username": "usr.john" }' 

Example response
1234567
{   "ContactEmail": "john@example.com",   "UserUniqueID": "email:john@example.com",   "UserIsNew": false,   "ImpersonationIsNew": false,   "MailSent": true } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/persons/{person_id}/.merge

Merge person on another Person. Caution: this operation is irreversible

Path parameters

person_id

string

required

ID of the person on which the call is applied.

Request body

Target

string

required

ID of a person

ID of the person this person is merged with

Response body

MergeResult

The MergeResult object

Example request
1234567
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/persons/g_6450be15-0561-407f-bc27-1eb6ccdef02f/.merge \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "Target": "G_a845b752-7cf4-43a6-8dc4-f65439a15ee0" }' 

Example response
12
{ } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/persons/{person_id}/.progress

Return the status, progress and score of the person on a specific activitystructure.

Path parameters

person_id

string

required

ID of the person on which the call is applied.

Request body

ActivityStructure

string

required

ID of an activity structure

Response body

ActivityStatus

The ActivityStatus object

Progress, status and score a single person on an Activity or ActivityGroup

Person

string

expandable

ID of a Person

ActivityStructure

string

expandable

ID of an ActivityStructure

Attempt

integer

# Attempt on this activity, starting from 0

Progress

integer

MaxProgress

integer

Score

integer

MaxScore

integer

Completed

bool

DateCompleted

date

ISO date format

Status

integer

Allowed values: NotStarted (0), Busy (1), Pending (10), Done (20), Failed (30), Passed (40), NotAssigned (-1)

ContentTime

integer

NormalizedScore

float

Example request
1234567
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/persons/g_6450be15-0561-407f-bc27-1eb6ccdef02f/.progress \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "ActivityStructure": "G_0d3c341e-ae95-4c06-a875-9ea46fd5d27d" }' 

Example response
1234567891011121314
{   "Person": "G_cdbf79b9-5699-4062-ab8a-8af9a6116eae",   "ActivityStructure": "G_8fe6bdd3-4d63-46ce-ade4-9dc153c701f5",   "Attempt": 0,   "Progress": 9,   "MaxProgress": 10,   "Score": 5,   "MaxScore": 10,   "Completed": true,   "DateCompleted": "2026-06-06T10:38:47.9663409",   "Status": 20,   "ContentTime": 60,   "NormalizedScore": 0.5 } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/persons/{person_id}/.recertify

Start re-certification for the person.

Path parameters

person_id

string

required

ID of the person on which the call is applied.

Request body

Certificate

string

required

ID of a certificate activity

Response body

RecertifyObject

The RecertifyObject object

Success

bool

RestartedActivities

string

MailSent

bool

Example request
1234567
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/persons/g_6450be15-0561-407f-bc27-1eb6ccdef02f/.recertify \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "Certificate": "G_0d3c341e-ae95-4c06-a875-9ea46fd5d27d" }' 

Example response
12345
{   "Success": true,   "RestartedActivities": ["G_0d3c341e-ae95-4c06-a875-9ea46fd5d27d"],   "MailSent": true } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/persons/{person_id}/.report

Path parameters

person_id

string

required

ID of the person on which the call is applied.

Query parameters

stream

boolean

optional

Stream results using Server-Sent Events

Request body

ActivityAttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Only include specific attempts

ActivityStructures

array of strings

optional

IDs of activity structures

DeltaDate

date

optional

ISO date format

Only include results after date

IncludeActivities

bool

optional

Add results on each activity to the output

IncludeGroupSummary

bool

optional

Add summaries of person groups to the output

IncludeIntermediateActivityStructures

bool

optional

Include intermediate ActivityStructures

IncludeNotAttempted

bool

optional

Include not attempted results

IncludeParentActivityStructure

bool

optional

Include ID of Parent ActivityStructure

IncludeParentAuthorizable

bool

optional

Include ID of Parent Authorizable

IncludePersons

bool

optional

Add individual results to the output

IncludeProgramSummary

bool

optional

Add calculated program status to the output

IncludeResultDetails

bool

optional

Add details of answered questions to the output

IncludeUnassigned

bool

optional

Add results of activities that are not currently assigned

LearnAuthorizations

array of strings

optional

IDs of learn authorizations

ProgramSummaryAttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Setting used for program status calculation

ReferenceDate

date

optional

ISO date format

Only include results before date

Verbose

bool

optional

Add messages to the output

Response body

enumeration of ProgressReportingBaseResults

The ProgressReportingBaseResult object (abstract)

Base class for report entries

Type

string

The ProgressReportingMessage object (inherits from ProgressReportingBaseResult)

Progress or logging during reporting

Type = report.message

Message

string

DateTime

date

ISO date format

Current time stamp

The ProgressReportingDone object (inherits from ProgressReportingBaseResult)

Indicates that reporting finished successfully

Type = report.finished

DeltaDate

date

ISO date format

ReferenceDate

date

ISO date format

This date can be used for next delta

The ProgressReportingBaseResultLine object (abstract) (inherits from ProgressReportingBaseResult)

Base class for report results

ParentAuthorizable

string

expandable

ID of an Authorizable

Authorizable

string

expandable

ID of an Authorizable

ParentActivityStructure

string

expandable

ID of an ActivityStructure

ActivityStructure

string

expandable

ID of an ActivityStructure

Authorization

string

expandable

ID of an Authorization

ContentTime

integer

Progress

float

NormalizedScore

float

ValidUntil

date

ISO date format

Certificate activities only

RecertificationAfter

date

ISO date format

Certificate activities only

The ProgressReportingGroupResult object (inherits from ProgressReportingBaseResultLine)

Summary of an Activity for a PersonGroup

Type = report.activity.summary

ResultCount

integer

NotStarted

integer

Started

integer

Completed

integer

Passed

integer

Failed

integer

The ProgressReportingGroupProgramResult object (inherits from ProgressReportingGroupResult)

Summary of an ActivityStructure for a PersonGroup

Type = report.program.summary

StatusRules

bool

StatusProgress

float

The ProgressReportingResult object (inherits from ProgressReportingBaseResultLine)

Result of a Person on an Activity

Type = report.activity.result

DateCompleted

date

ISO date format

DateStarted

date

ISO date format

Status

integer

Allowed values: NotStarted (0), Busy (1), Pending (10), Done (20), Failed (30), Passed (40), NotAssigned (-1)

Result

string

ID of an ActivityResult

The ProgressReportingProgramResult object (inherits from ProgressReportingResult)

Result of a Person on an ActivityGroup

Type = report.program.result

StatusRules

bool

StatusProgress

float

Example request
1234567891011121314151617181920212223
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/persons/g_6450be15-0561-407f-bc27-1eb6ccdef02f/.report \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "ActivityAttemptMode": "All",   "ActivityStructures": null,   "DeltaDate": null,   "IncludeActivities": true,   "IncludeGroupSummary": false,   "IncludeIntermediateActivityStructures": false,   "IncludeNotAttempted": false,   "IncludeParentActivityStructure": false,   "IncludeParentAuthorizable": false,   "IncludePersons": true,   "IncludeProgramSummary": false,   "IncludeResultDetails": false,   "IncludeUnassigned": false,   "LearnAuthorizations": null,   "ProgramSummaryAttemptMode": "Last",   "ReferenceDate": null,   "Verbose": false }' 

Example response
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
[   {     "Type": "report.message",     "Message": "Hello world",     "DateTime": "2026-06-06T10:38:47.9663409"   }   ,   {     "Type": "report.finished",     "DeltaDate": "2026-06-06T10:38:47.9663409",     "ReferenceDate": "2026-06-06T10:38:47.9663409"   }   ,   {     "Type": "report.activity.summary",     "ParentAuthorizable": "G_e76ea3c3-7628-4b3a-a4fe-5fc8b29d1295",     "Authorizable": "G_a3eb51c5-e46f-465d-addf-261bef963896",     "ParentActivityStructure": "G_ffd27697-184a-47c6-af74-6cd67c0ae2a0",     "ActivityStructure": "G_388d08fb-5de8-4641-8cc0-78ce5cbbb985",     "Authorization": "G_a636e3fd-ca67-4c60-a008-6e68a8da31ed",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9663409",     "RecertificationAfter": "2026-06-06T10:38:47.9663409",     "ResultCount": 1,     "NotStarted": 2,     "Started": 1,     "Completed": 3,     "Passed": 1,     "Failed": 0   }   ,   {     "Type": "report.program.summary",     "ParentAuthorizable": "G_e76ea3c3-7628-4b3a-a4fe-5fc8b29d1295",     "Authorizable": "G_a3eb51c5-e46f-465d-addf-261bef963896",     "ParentActivityStructure": "G_ffd27697-184a-47c6-af74-6cd67c0ae2a0",     "ActivityStructure": "G_388d08fb-5de8-4641-8cc0-78ce5cbbb985",     "Authorization": "G_a636e3fd-ca67-4c60-a008-6e68a8da31ed",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9663409",     "RecertificationAfter": "2026-06-06T10:38:47.9663409",     "ResultCount": 1,     "NotStarted": 2,     "Started": 1,     "Completed": 3,     "Passed": 1,     "Failed": 0,     "StatusRules": true,     "StatusProgress": null   }   ,   {     "Type": "report.activity.result",     "ParentAuthorizable": "G_e76ea3c3-7628-4b3a-a4fe-5fc8b29d1295",     "Authorizable": "G_a3eb51c5-e46f-465d-addf-261bef963896",     "ParentActivityStructure": "G_ffd27697-184a-47c6-af74-6cd67c0ae2a0",     "ActivityStructure": "G_388d08fb-5de8-4641-8cc0-78ce5cbbb985",     "Authorization": "G_a636e3fd-ca67-4c60-a008-6e68a8da31ed",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9663409",     "RecertificationAfter": "2026-06-06T10:38:47.9663409",     "DateCompleted": "2026-06-06T10:38:47.9663409",     "DateStarted": "2026-06-06T10:38:47.9663409",     "Status": null,     "Result": "E_e085c8f1-9934-4e3f-802c-0ead92c85375"   }   ,   {     "Type": "report.program.result",     "ParentAuthorizable": "G_e76ea3c3-7628-4b3a-a4fe-5fc8b29d1295",     "Authorizable": "G_a3eb51c5-e46f-465d-addf-261bef963896",     "ParentActivityStructure": "G_ffd27697-184a-47c6-af74-6cd67c0ae2a0",     "ActivityStructure": "G_388d08fb-5de8-4641-8cc0-78ce5cbbb985",     "Authorization": "G_a636e3fd-ca67-4c60-a008-6e68a8da31ed",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9663409",     "RecertificationAfter": "2026-06-06T10:38:47.9663409",     "DateCompleted": "2026-06-06T10:38:47.9663409",     "DateStarted": "2026-06-06T10:38:47.9663409",     "Status": null,     "Result": "E_e085c8f1-9934-4e3f-802c-0ead92c85375",     "StatusRules": true,     "StatusProgress": null   } ] 

PortfolioEntries

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

Code

string

readwrite default

Max 255 chars

Filter not supported

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Credits

float

readwrite default

Filter not supported

DateCompleted

date

readwrite default

ISO date format

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

string

readonly always

Unique

Available filter operations: EQUALS

Institute

string

readwrite default

Max 255 chars

Filter not supported

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Name

string

readwrite default

Max 255 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

string

immutable default expandable

Available filter operations: EQUALS

ID of a Person

PortfolioType

enum

readwrite default

Allowed values: ManualCertificate, ManualExperience, ManualTraining, ManualOther, FlowsparksTraining, FlowsparksCredit

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

Unit

string

readwrite default

Max 255 chars

Filter not supported

The portfolio entry object
1234567891011121314151617
{   "ClassID": "",   "ClassName": "",   "Code": null,   "CreateDate": "2026-06-06T10:38:47.9663409",   "Credits": null,   "DateCompleted": null,   "ID": "G_6d9b7b11-b317-4200-8c9b-ef11e96c0863",   "Institute": null,   "ModifiedDate": "2026-06-06T10:38:47.9663409",   "Name": null,   "Of": "G_e3f34cb9-2121-4f6e-b53b-cdfe3afdb181",   "PortfolioType": null,   "Tag": "",   "Type": "PortfolioEntries",   "Unit": null } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/portfolioentries

Creates a new portfolio entry.

Request body

Code

string

optional

Max 255 chars

Credits

float

optional

DateCompleted

date

optional

ISO date format

Institute

string

optional

Max 255 chars

Name

string

optional

Max 255 chars

string

required

ID of a Person

PortfolioType

enum

optional

Allowed values: ManualCertificate, ManualExperience, ManualTraining, ManualOther, FlowsparksTraining, FlowsparksCredit

Tag

string

optional

Max 100 chars

Unit

string

optional

Max 255 chars

Returns

The newly created portfolio entry object.

Example request
123456789101112131415
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/portfolioentries \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "Code": null,   "Credits": null,   "DateCompleted": null,   "Institute": null,   "Name": null,   "Of": "G_e3f34cb9-2121-4f6e-b53b-cdfe3afdb181",   "PortfolioType": null,   "Tag": "",   "Unit": null }' 

Response
1234567891011121314151617
{   "ClassID": "",   "ClassName": "",   "Code": null,   "CreateDate": "2026-06-06T10:38:47.9663409",   "Credits": null,   "DateCompleted": null,   "ID": "G_6d9b7b11-b317-4200-8c9b-ef11e96c0863",   "Institute": null,   "ModifiedDate": "2026-06-06T10:38:47.9663409",   "Name": null,   "Of": "G_e3f34cb9-2121-4f6e-b53b-cdfe3afdb181",   "PortfolioType": null,   "Tag": "",   "Type": "PortfolioEntries",   "Unit": null } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/portfolioentries

Returns a list of portfolio entries.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of portfolio entry objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/portfolioentries \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456789101112131415161718192021
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "Code": null,       "Credits": null,       "DateCompleted": null,       "ID": "G_6d9b7b11-b317-4200-8c9b-ef11e96c0863",       "Institute": null,       "Name": null,       "Of": "G_e3f34cb9-2121-4f6e-b53b-cdfe3afdb181",       "PortfolioType": null,       "Tag": "",       "Type": "PortfolioEntries",       "Unit": null     }   ]   "Date": "2026-06-06T10:38:47.9975763", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/portfolioentries/{portfolioentry_id}

Retrieves a portfolio entry.

Path parameters

portfolioentry_id

string

required

ID of the portfolio entry to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The portfolio entry object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/portfolioentries/g_6d9b7b11-b317-4200-8c9b-ef11e96c0863 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
12345678910111213
{   "Code": null,   "Credits": null,   "DateCompleted": null,   "ID": "G_6d9b7b11-b317-4200-8c9b-ef11e96c0863",   "Institute": null,   "Name": null,   "Of": "G_e3f34cb9-2121-4f6e-b53b-cdfe3afdb181",   "PortfolioType": null,   "Tag": "",   "Type": "PortfolioEntries",   "Unit": null } 

Ratings

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

string

readonly always

Unique

Available filter operations: EQUALS

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

string

immutable default expandable

Available filter operations: EQUALS

ID of a Person

string

immutable default expandable

Available filter operations: EQUALS

ID of the rated Entity

Rating

integer

readwrite default

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

The rating object
123456789101112
{   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9663409",   "ID": "G_0c97bb7f-7902-4d81-ad43-7343f6c7ee59",   "ModifiedDate": "2026-06-06T10:38:47.9663409",   "Of": "G_3b66b40a-8a93-43af-b18b-527614475c8a",   "On": "G_fedcac23-faf6-44b7-9b78-21c75fac006b",   "Rating": 100,   "Tag": "",   "Type": "Ratings" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/ratings

Returns a list of ratings.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of rating objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/ratings \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
12345678910111213141516
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "ID": "G_0c97bb7f-7902-4d81-ad43-7343f6c7ee59",       "Of": "G_3b66b40a-8a93-43af-b18b-527614475c8a",       "On": "G_fedcac23-faf6-44b7-9b78-21c75fac006b",       "Rating": 100,       "Tag": "",       "Type": "Ratings"     }   ]   "Date": "2026-06-06T10:38:47.9975763", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/ratings/{rating_id}

Retrieves a rating.

Path parameters

rating_id

string

required

ID of the rating to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The rating object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/ratings/g_0c97bb7f-7902-4d81-ad43-7343f6c7ee59 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
12345678
{   "ID": "G_0c97bb7f-7902-4d81-ad43-7343f6c7ee59",   "Of": "G_3b66b40a-8a93-43af-b18b-527614475c8a",   "On": "G_fedcac23-faf6-44b7-9b78-21c75fac006b",   "Rating": 100,   "Tag": "",   "Type": "Ratings" } 

PUT https://genapiv1.growsparks.com/rest/genapiv1/v1/ratings/{rating_id}

Modifies a rating.

Path parameters

rating_id

string

required

ID of the rating to modify.

Request body

Rating

integer

optional

Tag

string

optional

Max 100 chars

Returns

The modified rating object.

Example request
12345678
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/ratings/g_0c97bb7f-7902-4d81-ad43-7343f6c7ee59 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X PUT \   -d '{   "Rating": 100,   "Tag": "" }' 

Response
123456789101112
{   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9663409",   "ID": "G_0c97bb7f-7902-4d81-ad43-7343f6c7ee59",   "ModifiedDate": "2026-06-06T10:38:47.9663409",   "Of": "G_3b66b40a-8a93-43af-b18b-527614475c8a",   "On": "G_fedcac23-faf6-44b7-9b78-21c75fac006b",   "Rating": 100,   "Tag": "",   "Type": "Ratings" } 

Roles

Roles can be assigned to PersonGroupMemberships. Roles give extra authorizations on the group of the membership.

Authorizations

array of strings

readonly request expandable

IDs of Entities

Filter not supported

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

ExtraData

mapping

readwrite request

List of key/value pairs

Filter not supported

string

readonly always

Unique

Available filter operations: EQUALS,PATH_TO_ROOT,SUB_TREE,MEMBER_OF

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

ParentMemberships

array of strings

readonly request expandable

IDs of Entities

Filter not supported

PreferredLanguage

string

readwrite request

ISO language code

Filter not supported

ProfileImage

asset

readwrite request

Image

Filter not supported

RoleName

string

readwrite default

Max 255 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

The role object
123456789101112131415
{   "Authorizations": ["G_8699afc5-b818-48dd-8add-8ce2fab81882"],   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9663409",   "ExtraData": {"Key":"Value"},   "ID": "G_90f2a392-de96-4ff9-aae7-b7ae20281359",   "ModifiedDate": "2026-06-06T10:38:47.9663409",   "ParentMemberships": ["G_07fbf616-b89c-44a9-a734-cba5d183acbc"],   "PreferredLanguage": "en",   "ProfileImage": null,   "RoleName": "Example role",   "Tag": "",   "Type": "Roles" } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/roles

Creates a new role.

Request body

ExtraData

mapping

optional

List of key/value pairs

PreferredLanguage

string

optional

ISO language code

ProfileImage

asset

optional

Image

RoleName

string

optional

Max 255 chars

Tag

string

optional

Max 100 chars

Returns

The newly created role object.

Example request
1234567891011
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/roles \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "ExtraData": {"Key":"Value"},   "PreferredLanguage": "en",   "ProfileImage": null,   "RoleName": "Example role",   "Tag": "" }' 

Response
123456789101112131415
{   "Authorizations": ["G_8699afc5-b818-48dd-8add-8ce2fab81882"],   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9663409",   "ExtraData": {"Key":"Value"},   "ID": "G_90f2a392-de96-4ff9-aae7-b7ae20281359",   "ModifiedDate": "2026-06-06T10:38:47.9663409",   "ParentMemberships": ["G_07fbf616-b89c-44a9-a734-cba5d183acbc"],   "PreferredLanguage": "en",   "ProfileImage": null,   "RoleName": "Example role",   "Tag": "",   "Type": "Roles" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/roles

Returns a list of roles.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of role objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/roles \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
1234567891011121314
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "ID": "G_90f2a392-de96-4ff9-aae7-b7ae20281359",       "RoleName": "Example role",       "Tag": "",       "Type": "Roles"     }   ]   "Date": "2026-06-06T10:38:48.0132222", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/roles/{role_id}

Retrieves a role.

Path parameters

role_id

string

required

ID of the role to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The role object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/roles/g_90f2a392-de96-4ff9-aae7-b7ae20281359 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456
{   "ID": "G_90f2a392-de96-4ff9-aae7-b7ae20281359",   "RoleName": "Example role",   "Tag": "",   "Type": "Roles" } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/roles/{role_id}/.report

Path parameters

role_id

string

required

ID of the role on which the call is applied.

Query parameters

stream

boolean

optional

Stream results using Server-Sent Events

Request body

ActivityAttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Only include specific attempts

ActivityStructures

array of strings

optional

IDs of activity structures

DeltaDate

date

optional

ISO date format

Only include results after date

IncludeActivities

bool

optional

Add results on each activity to the output

IncludeGroupSummary

bool

optional

Add summaries of person groups to the output

IncludeIntermediateActivityStructures

bool

optional

Include intermediate ActivityStructures

IncludeNotAttempted

bool

optional

Include not attempted results

IncludeParentActivityStructure

bool

optional

Include ID of Parent ActivityStructure

IncludeParentAuthorizable

bool

optional

Include ID of Parent Authorizable

IncludePersons

bool

optional

Add individual results to the output

IncludeProgramSummary

bool

optional

Add calculated program status to the output

IncludeResultDetails

bool

optional

Add details of answered questions to the output

IncludeUnassigned

bool

optional

Add results of activities that are not currently assigned

LearnAuthorizations

array of strings

optional

IDs of learn authorizations

ProgramSummaryAttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Setting used for program status calculation

ReferenceDate

date

optional

ISO date format

Only include results before date

Verbose

bool

optional

Add messages to the output

Response body

enumeration of ProgressReportingBaseResults

The ProgressReportingBaseResult object (abstract)

Base class for report entries

Type

string

The ProgressReportingMessage object (inherits from ProgressReportingBaseResult)

Progress or logging during reporting

Type = report.message

Message

string

DateTime

date

ISO date format

Current time stamp

The ProgressReportingDone object (inherits from ProgressReportingBaseResult)

Indicates that reporting finished successfully

Type = report.finished

DeltaDate

date

ISO date format

ReferenceDate

date

ISO date format

This date can be used for next delta

The ProgressReportingBaseResultLine object (abstract) (inherits from ProgressReportingBaseResult)

Base class for report results

ParentAuthorizable

string

expandable

ID of an Authorizable

Authorizable

string

expandable

ID of an Authorizable

ParentActivityStructure

string

expandable

ID of an ActivityStructure

ActivityStructure

string

expandable

ID of an ActivityStructure

Authorization

string

expandable

ID of an Authorization

ContentTime

integer

Progress

float

NormalizedScore

float

ValidUntil

date

ISO date format

Certificate activities only

RecertificationAfter

date

ISO date format

Certificate activities only

The ProgressReportingGroupResult object (inherits from ProgressReportingBaseResultLine)

Summary of an Activity for a PersonGroup

Type = report.activity.summary

ResultCount

integer

NotStarted

integer

Started

integer

Completed

integer

Passed

integer

Failed

integer

The ProgressReportingGroupProgramResult object (inherits from ProgressReportingGroupResult)

Summary of an ActivityStructure for a PersonGroup

Type = report.program.summary

StatusRules

bool

StatusProgress

float

The ProgressReportingResult object (inherits from ProgressReportingBaseResultLine)

Result of a Person on an Activity

Type = report.activity.result

DateCompleted

date

ISO date format

DateStarted

date

ISO date format

Status

integer

Allowed values: NotStarted (0), Busy (1), Pending (10), Done (20), Failed (30), Passed (40), NotAssigned (-1)

Result

string

ID of an ActivityResult

The ProgressReportingProgramResult object (inherits from ProgressReportingResult)

Result of a Person on an ActivityGroup

Type = report.program.result

StatusRules

bool

StatusProgress

float

Example request
1234567891011121314151617181920212223
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/roles/g_90f2a392-de96-4ff9-aae7-b7ae20281359/.report \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "ActivityAttemptMode": "All",   "ActivityStructures": null,   "DeltaDate": null,   "IncludeActivities": true,   "IncludeGroupSummary": false,   "IncludeIntermediateActivityStructures": false,   "IncludeNotAttempted": false,   "IncludeParentActivityStructure": false,   "IncludeParentAuthorizable": false,   "IncludePersons": true,   "IncludeProgramSummary": false,   "IncludeResultDetails": false,   "IncludeUnassigned": false,   "LearnAuthorizations": null,   "ProgramSummaryAttemptMode": "Last",   "ReferenceDate": null,   "Verbose": false }' 

Example response
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
[   {     "Type": "report.message",     "Message": "Hello world",     "DateTime": "2026-06-06T10:38:47.9663409"   }   ,   {     "Type": "report.finished",     "DeltaDate": "2026-06-06T10:38:47.9663409",     "ReferenceDate": "2026-06-06T10:38:47.9663409"   }   ,   {     "Type": "report.activity.summary",     "ParentAuthorizable": "G_f13a77ec-337c-46c9-a376-03f4b210bdc3",     "Authorizable": "G_07ae5564-0fa9-4dfd-b2d6-9f27797350ad",     "ParentActivityStructure": "G_aed212be-4eea-432b-a998-72c61006f8cb",     "ActivityStructure": "G_6554887c-27e8-425a-9e08-5008904e4f85",     "Authorization": "G_f7035166-ca55-44b7-a1ee-345a9de25df1",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9663409",     "RecertificationAfter": "2026-06-06T10:38:47.9663409",     "ResultCount": 1,     "NotStarted": 2,     "Started": 1,     "Completed": 3,     "Passed": 1,     "Failed": 0   }   ,   {     "Type": "report.program.summary",     "ParentAuthorizable": "G_f13a77ec-337c-46c9-a376-03f4b210bdc3",     "Authorizable": "G_07ae5564-0fa9-4dfd-b2d6-9f27797350ad",     "ParentActivityStructure": "G_aed212be-4eea-432b-a998-72c61006f8cb",     "ActivityStructure": "G_6554887c-27e8-425a-9e08-5008904e4f85",     "Authorization": "G_f7035166-ca55-44b7-a1ee-345a9de25df1",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9663409",     "RecertificationAfter": "2026-06-06T10:38:47.9663409",     "ResultCount": 1,     "NotStarted": 2,     "Started": 1,     "Completed": 3,     "Passed": 1,     "Failed": 0,     "StatusRules": true,     "StatusProgress": null   }   ,   {     "Type": "report.activity.result",     "ParentAuthorizable": "G_f13a77ec-337c-46c9-a376-03f4b210bdc3",     "Authorizable": "G_07ae5564-0fa9-4dfd-b2d6-9f27797350ad",     "ParentActivityStructure": "G_aed212be-4eea-432b-a998-72c61006f8cb",     "ActivityStructure": "G_6554887c-27e8-425a-9e08-5008904e4f85",     "Authorization": "G_f7035166-ca55-44b7-a1ee-345a9de25df1",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9663409",     "RecertificationAfter": "2026-06-06T10:38:47.9663409",     "DateCompleted": "2026-06-06T10:38:47.9663409",     "DateStarted": "2026-06-06T10:38:47.9663409",     "Status": null,     "Result": "E_8c5ca3ab-ad56-4839-8506-60397976fcda"   }   ,   {     "Type": "report.program.result",     "ParentAuthorizable": "G_f13a77ec-337c-46c9-a376-03f4b210bdc3",     "Authorizable": "G_07ae5564-0fa9-4dfd-b2d6-9f27797350ad",     "ParentActivityStructure": "G_aed212be-4eea-432b-a998-72c61006f8cb",     "ActivityStructure": "G_6554887c-27e8-425a-9e08-5008904e4f85",     "Authorization": "G_f7035166-ca55-44b7-a1ee-345a9de25df1",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9663409",     "RecertificationAfter": "2026-06-06T10:38:47.9663409",     "DateCompleted": "2026-06-06T10:38:47.9663409",     "DateStarted": "2026-06-06T10:38:47.9663409",     "Status": null,     "Result": "E_8c5ca3ab-ad56-4839-8506-60397976fcda",     "StatusRules": true,     "StatusProgress": null   } ] 

Activities

Smallest unit of e-Learning content

CatalogEntry

bool

readonly default

Available filter operations: EQUALS,NOT_EQUALS

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Description

string

readonly default

Formatting allowed

Filter not supported

ExpectedActivityDuration

enum

readonly default

Allowed values: unknown, one, two, three, four, five, six, seven, eight, nine, ten, eleven, twelve, thirteen, fourteen, fifteen, twenty, twentyfive, thirty, thirtyFive, forty, fortyFive, hour, oneAndAHalfHour, moreThanOneAndAHalfHours, moreThanTwoHours, moreThanTwoAndAHalfHours

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

string

readonly always

Unique

Available filter operations: EQUALS,PATH_TO_ROOT,SUB_TREE,MEMBER_OF

Image

asset

readonly default

Image

Filter not supported

Metadata

string

readonly default

Filter not supported

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Name

string

readonly default

Max 255 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

ParentMemberships

array of strings

readonly request expandable

IDs of Entities

Filter not supported

SearchTags

string

readonly default

Filter not supported

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

The activity object
1234567891011121314151617
{   "CatalogEntry": false,   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9194568",   "Description": null,   "ExpectedActivityDuration": "unknown",   "ID": "G_ba00478e-26e5-4050-b307-6440f4852057",   "Image": null,   "Metadata": null,   "ModifiedDate": "2026-06-06T10:38:47.9194568",   "Name": "Example content",   "ParentMemberships": ["G_b98ad4c3-aecf-4ef1-aad8-7eb13c78ea16"],   "SearchTags": null,   "Tag": "",   "Type": "Activities" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/activities

Returns a list of activities.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of activity objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/activities \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
1234567891011121314151617181920
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "CatalogEntry": false,       "Description": null,       "ExpectedActivityDuration": "unknown",       "ID": "G_ba00478e-26e5-4050-b307-6440f4852057",       "Image": null,       "Metadata": null,       "Name": "Example content",       "SearchTags": null,       "Tag": "",       "Type": "Activities"     }   ]   "Date": "2026-06-06T10:38:48.0132222", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/activities/{activity_id}

Retrieves an activity.

Path parameters

activity_id

string

required

ID of the activity to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The activity object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/activities/g_ba00478e-26e5-4050-b307-6440f4852057 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456789101112
{   "CatalogEntry": false,   "Description": null,   "ExpectedActivityDuration": "unknown",   "ID": "G_ba00478e-26e5-4050-b307-6440f4852057",   "Image": null,   "Metadata": null,   "Name": "Example content",   "SearchTags": null,   "Tag": "",   "Type": "Activities" } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/activities/{activity_id}/.report

Path parameters

activity_id

string

required

ID of the activity on which the call is applied.

Query parameters

stream

boolean

optional

Stream results using Server-Sent Events

Request body

ActivityAttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Only include specific attempts

Authorizables

array of strings

optional

IDs of authorizables

DeltaDate

date

optional

ISO date format

Only include results after date

IncludeActivities

bool

optional

Add results on each activity to the output

IncludeGroupSummary

bool

optional

Add summaries of person groups to the output

IncludeIntermediateActivityStructures

bool

optional

Include intermediate ActivityStructures

IncludeNotAttempted

bool

optional

Include not attempted results

IncludeParentActivityStructure

bool

optional

Include ID of Parent ActivityStructure

IncludeParentAuthorizable

bool

optional

Include ID of Parent Authorizable

IncludePersons

bool

optional

Add individual results to the output

IncludeProgramSummary

bool

optional

Add calculated program status to the output

IncludeResultDetails

bool

optional

Add details of answered questions to the output

IncludeUnassigned

bool

optional

Add results of activities that are not currently assigned

LearnAuthorizations

array of strings

optional

IDs of learn authorizations

ProgramSummaryAttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Setting used for program status calculation

ReferenceDate

date

optional

ISO date format

Only include results before date

Verbose

bool

optional

Add messages to the output

Response body

enumeration of ProgressReportingBaseResults

The ProgressReportingBaseResult object (abstract)

Base class for report entries

Type

string

The ProgressReportingMessage object (inherits from ProgressReportingBaseResult)

Progress or logging during reporting

Type = report.message

Message

string

DateTime

date

ISO date format

Current time stamp

The ProgressReportingDone object (inherits from ProgressReportingBaseResult)

Indicates that reporting finished successfully

Type = report.finished

DeltaDate

date

ISO date format

ReferenceDate

date

ISO date format

This date can be used for next delta

The ProgressReportingBaseResultLine object (abstract) (inherits from ProgressReportingBaseResult)

Base class for report results

ParentAuthorizable

string

expandable

ID of an Authorizable

Authorizable

string

expandable

ID of an Authorizable

ParentActivityStructure

string

expandable

ID of an ActivityStructure

ActivityStructure

string

expandable

ID of an ActivityStructure

Authorization

string

expandable

ID of an Authorization

ContentTime

integer

Progress

float

NormalizedScore

float

ValidUntil

date

ISO date format

Certificate activities only

RecertificationAfter

date

ISO date format

Certificate activities only

The ProgressReportingGroupResult object (inherits from ProgressReportingBaseResultLine)

Summary of an Activity for a PersonGroup

Type = report.activity.summary

ResultCount

integer

NotStarted

integer

Started

integer

Completed

integer

Passed

integer

Failed

integer

The ProgressReportingGroupProgramResult object (inherits from ProgressReportingGroupResult)

Summary of an ActivityStructure for a PersonGroup

Type = report.program.summary

StatusRules

bool

StatusProgress

float

The ProgressReportingResult object (inherits from ProgressReportingBaseResultLine)

Result of a Person on an Activity

Type = report.activity.result

DateCompleted

date

ISO date format

DateStarted

date

ISO date format

Status

integer

Allowed values: NotStarted (0), Busy (1), Pending (10), Done (20), Failed (30), Passed (40), NotAssigned (-1)

Result

string

ID of an ActivityResult

The ProgressReportingProgramResult object (inherits from ProgressReportingResult)

Result of a Person on an ActivityGroup

Type = report.program.result

StatusRules

bool

StatusProgress

float

Example request
1234567891011121314151617181920212223
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/activities/g_ba00478e-26e5-4050-b307-6440f4852057/.report \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "ActivityAttemptMode": "All",   "Authorizables": null,   "DeltaDate": null,   "IncludeActivities": true,   "IncludeGroupSummary": false,   "IncludeIntermediateActivityStructures": false,   "IncludeNotAttempted": false,   "IncludeParentActivityStructure": false,   "IncludeParentAuthorizable": false,   "IncludePersons": true,   "IncludeProgramSummary": false,   "IncludeResultDetails": false,   "IncludeUnassigned": false,   "LearnAuthorizations": null,   "ProgramSummaryAttemptMode": "Last",   "ReferenceDate": null,   "Verbose": false }' 

Example response
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
[   {     "Type": "report.message",     "Message": "Hello world",     "DateTime": "2026-06-06T10:38:47.9194568"   }   ,   {     "Type": "report.finished",     "DeltaDate": "2026-06-06T10:38:47.9194568",     "ReferenceDate": "2026-06-06T10:38:47.9194568"   }   ,   {     "Type": "report.activity.summary",     "ParentAuthorizable": "G_fc31be97-6c85-47f4-b3e9-3d098fafa00e",     "Authorizable": "G_dd7373ce-eb16-4edc-9aef-6eb3e3002a02",     "ParentActivityStructure": "G_482efec2-46ab-493c-ae34-6f64aca0aee2",     "ActivityStructure": "G_7e3ef03d-7013-4488-8580-967c1e04bbbc",     "Authorization": "G_7b8ea0da-d2c9-49da-992a-91cf57179956",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9194568",     "RecertificationAfter": "2026-06-06T10:38:47.9194568",     "ResultCount": 1,     "NotStarted": 2,     "Started": 1,     "Completed": 3,     "Passed": 1,     "Failed": 0   }   ,   {     "Type": "report.program.summary",     "ParentAuthorizable": "G_fc31be97-6c85-47f4-b3e9-3d098fafa00e",     "Authorizable": "G_dd7373ce-eb16-4edc-9aef-6eb3e3002a02",     "ParentActivityStructure": "G_482efec2-46ab-493c-ae34-6f64aca0aee2",     "ActivityStructure": "G_7e3ef03d-7013-4488-8580-967c1e04bbbc",     "Authorization": "G_7b8ea0da-d2c9-49da-992a-91cf57179956",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9194568",     "RecertificationAfter": "2026-06-06T10:38:47.9194568",     "ResultCount": 1,     "NotStarted": 2,     "Started": 1,     "Completed": 3,     "Passed": 1,     "Failed": 0,     "StatusRules": true,     "StatusProgress": null   }   ,   {     "Type": "report.activity.result",     "ParentAuthorizable": "G_fc31be97-6c85-47f4-b3e9-3d098fafa00e",     "Authorizable": "G_dd7373ce-eb16-4edc-9aef-6eb3e3002a02",     "ParentActivityStructure": "G_482efec2-46ab-493c-ae34-6f64aca0aee2",     "ActivityStructure": "G_7e3ef03d-7013-4488-8580-967c1e04bbbc",     "Authorization": "G_7b8ea0da-d2c9-49da-992a-91cf57179956",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9194568",     "RecertificationAfter": "2026-06-06T10:38:47.9194568",     "DateCompleted": "2026-06-06T10:38:47.9194568",     "DateStarted": "2026-06-06T10:38:47.9194568",     "Status": null,     "Result": "E_089981ee-436d-4743-a520-b72410ec9a72"   }   ,   {     "Type": "report.program.result",     "ParentAuthorizable": "G_fc31be97-6c85-47f4-b3e9-3d098fafa00e",     "Authorizable": "G_dd7373ce-eb16-4edc-9aef-6eb3e3002a02",     "ParentActivityStructure": "G_482efec2-46ab-493c-ae34-6f64aca0aee2",     "ActivityStructure": "G_7e3ef03d-7013-4488-8580-967c1e04bbbc",     "Authorization": "G_7b8ea0da-d2c9-49da-992a-91cf57179956",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9194568",     "RecertificationAfter": "2026-06-06T10:38:47.9194568",     "DateCompleted": "2026-06-06T10:38:47.9194568",     "DateStarted": "2026-06-06T10:38:47.9194568",     "Status": null,     "Result": "E_089981ee-436d-4743-a520-b72410ec9a72",     "StatusRules": true,     "StatusProgress": null   } ] 

ActivityGroupMemberships

ActivityStructures can be member of ActivityGroups. This membership is expressed by ActivityGroupMemberships

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Deleted

bool

readwrite default

Available filter operations: EQUALS

string

readonly always

Unique

Available filter operations: EQUALS

Member

string

immutable default expandable

Available filter operations: EQUALS

ID of an ActivityStructure

MemberOf

string

readwrite default expandable

Available filter operations: EQUALS

ID of a Program

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

SortOrder

integer

readwrite default

Filter not supported

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

The activity group membership object
12345678910111213
{   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9350947",   "Deleted": false,   "ID": "G_f654ebcc-4ccc-4e26-a07f-564b84def729",   "Member": "G_897570cd-6ba6-4fd4-8ca8-5a6cb56bfacb",   "MemberOf": "G_4111e667-6fe0-4b98-8a4a-7a50ad0e9b4a",   "ModifiedDate": "2026-06-06T10:38:47.9350947",   "SortOrder": 0,   "Tag": "",   "Type": "ActivityGroupMemberships" } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/activitygroupmemberships

Creates a new activity group membership.

Request body

Deleted

bool

optional

Member

string

required

ID of an ActivityStructure

MemberOf

string

required

ID of a Program

SortOrder

integer

optional

Tag

string

optional

Max 100 chars

Returns

The newly created activity group membership object.

Example request
1234567891011
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/activitygroupmemberships \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "Deleted": false,   "Member": "G_897570cd-6ba6-4fd4-8ca8-5a6cb56bfacb",   "MemberOf": "G_4111e667-6fe0-4b98-8a4a-7a50ad0e9b4a",   "SortOrder": 0,   "Tag": "" }' 

Response
12345678910111213
{   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9350947",   "Deleted": false,   "ID": "G_f654ebcc-4ccc-4e26-a07f-564b84def729",   "Member": "G_897570cd-6ba6-4fd4-8ca8-5a6cb56bfacb",   "MemberOf": "G_4111e667-6fe0-4b98-8a4a-7a50ad0e9b4a",   "ModifiedDate": "2026-06-06T10:38:47.9350947",   "SortOrder": 0,   "Tag": "",   "Type": "ActivityGroupMemberships" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/activitygroupmemberships

Returns a list of activity group memberships.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of activity group membership objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/activitygroupmemberships \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
1234567891011121314151617
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "Deleted": false,       "ID": "G_f654ebcc-4ccc-4e26-a07f-564b84def729",       "Member": "G_897570cd-6ba6-4fd4-8ca8-5a6cb56bfacb",       "MemberOf": "G_4111e667-6fe0-4b98-8a4a-7a50ad0e9b4a",       "SortOrder": 0,       "Tag": "",       "Type": "ActivityGroupMemberships"     }   ]   "Date": "2026-06-06T10:38:48.0132222", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/activitygroupmemberships/{activitygroupmembership_id}

Retrieves an activity group membership.

Path parameters

activitygroupmembership_id

string

required

ID of the activity group membership to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The activity group membership object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/activitygroupmemberships/g_f654ebcc-4ccc-4e26-a07f-564b84def729 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456789
{   "Deleted": false,   "ID": "G_f654ebcc-4ccc-4e26-a07f-564b84def729",   "Member": "G_897570cd-6ba6-4fd4-8ca8-5a6cb56bfacb",   "MemberOf": "G_4111e667-6fe0-4b98-8a4a-7a50ad0e9b4a",   "SortOrder": 0,   "Tag": "",   "Type": "ActivityGroupMemberships" } 

PUT https://genapiv1.growsparks.com/rest/genapiv1/v1/activitygroupmemberships/{activitygroupmembership_id}

Modifies an activity group membership.

Path parameters

activitygroupmembership_id

string

required

ID of the activity group membership to modify.

Request body

Deleted

bool

optional

MemberOf

string

required

ID of a Program

SortOrder

integer

optional

Tag

string

optional

Max 100 chars

Returns

The modified activity group membership object.

Example request
12345678910
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/activitygroupmemberships/g_f654ebcc-4ccc-4e26-a07f-564b84def729 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X PUT \   -d '{   "Deleted": false,   "MemberOf": "G_4111e667-6fe0-4b98-8a4a-7a50ad0e9b4a",   "SortOrder": 0,   "Tag": "" }' 

Response
12345678910111213
{   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9350947",   "Deleted": false,   "ID": "G_f654ebcc-4ccc-4e26-a07f-564b84def729",   "Member": "G_897570cd-6ba6-4fd4-8ca8-5a6cb56bfacb",   "MemberOf": "G_4111e667-6fe0-4b98-8a4a-7a50ad0e9b4a",   "ModifiedDate": "2026-06-06T10:38:47.9350947",   "SortOrder": 0,   "Tag": "",   "Type": "ActivityGroupMemberships" } 

DELETE https://genapiv1.growsparks.com/rest/genapiv1/v1/activitygroupmemberships/{activitygroupmembership_id}

Deletes an activity group membership.

Path parameters

activitygroupmembership_id

string

required

ID of the activity group membership to delete.

Returns

Nothing

Example request
1234
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/activitygroupmemberships/g_f654ebcc-4ccc-4e26-a07f-564b84def729 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X DELETE 

ActivityGroups

Use ActivityGroups to group ActivityStructures like Activities and other ActivityGroups

CatalogEntry

bool

readonly default

Available filter operations: EQUALS,NOT_EQUALS

ChildMemberships

array of strings

readonly request expandable

IDs of Entities

Filter not supported

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Description

string

readonly default

Formatting allowed

Filter not supported

ExpectedActivityDuration

enum

readonly default

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

string

readonly always

Unique

Available filter operations: EQUALS,PATH_TO_ROOT,SUB_TREE,MEMBER_OF

Image

asset

readonly default

Image

Filter not supported

Metadata

string

readonly default

Filter not supported

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Name

string

readonly default

Max 255 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

ParentMemberships

array of strings

readonly request expandable

IDs of Entities

Filter not supported

SearchTags

string

readonly default

Filter not supported

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

The activity group object
123456789101112131415161718
{   "CatalogEntry": false,   "ChildMemberships": ["G_b435346a-3c8c-44ff-b960-77586354f21d"],   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9350947",   "Description": null,   "ExpectedActivityDuration": "unknown",   "ID": "G_9d88380f-2544-46fc-8051-4bed399160c4",   "Image": null,   "Metadata": null,   "ModifiedDate": "2026-06-06T10:38:47.9350947",   "Name": "Example content",   "ParentMemberships": ["G_e61392f2-7978-417d-a852-cf5ae34378df"],   "SearchTags": null,   "Tag": "",   "Type": "ActivityGroups" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/activitygroups

Returns a list of activity groups.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of activity group objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/activitygroups \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
1234567891011121314151617181920
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "CatalogEntry": false,       "Description": null,       "ExpectedActivityDuration": "unknown",       "ID": "G_9d88380f-2544-46fc-8051-4bed399160c4",       "Image": null,       "Metadata": null,       "Name": "Example content",       "SearchTags": null,       "Tag": "",       "Type": "ActivityGroups"     }   ]   "Date": "2026-06-06T10:38:48.0132222", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/activitygroups/{activitygroup_id}

Retrieves an activity group.

Path parameters

activitygroup_id

string

required

ID of the activity group to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The activity group object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/activitygroups/g_9d88380f-2544-46fc-8051-4bed399160c4 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456789101112
{   "CatalogEntry": false,   "Description": null,   "ExpectedActivityDuration": "unknown",   "ID": "G_9d88380f-2544-46fc-8051-4bed399160c4",   "Image": null,   "Metadata": null,   "Name": "Example content",   "SearchTags": null,   "Tag": "",   "Type": "ActivityGroups" } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/activitygroups/{activitygroup_id}/.report

Path parameters

activitygroup_id

string

required

ID of the activity group on which the call is applied.

Query parameters

stream

boolean

optional

Stream results using Server-Sent Events

Request body

ActivityAttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Only include specific attempts

Authorizables

array of strings

optional

IDs of authorizables

DeltaDate

date

optional

ISO date format

Only include results after date

IncludeActivities

bool

optional

Add results on each activity to the output

IncludeGroupSummary

bool

optional

Add summaries of person groups to the output

IncludeIntermediateActivityStructures

bool

optional

Include intermediate ActivityStructures

IncludeNotAttempted

bool

optional

Include not attempted results

IncludeParentActivityStructure

bool

optional

Include ID of Parent ActivityStructure

IncludeParentAuthorizable

bool

optional

Include ID of Parent Authorizable

IncludePersons

bool

optional

Add individual results to the output

IncludeProgramSummary

bool

optional

Add calculated program status to the output

IncludeResultDetails

bool

optional

Add details of answered questions to the output

IncludeUnassigned

bool

optional

Add results of activities that are not currently assigned

LearnAuthorizations

array of strings

optional

IDs of learn authorizations

ProgramSummaryAttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Setting used for program status calculation

ReferenceDate

date

optional

ISO date format

Only include results before date

Verbose

bool

optional

Add messages to the output

Response body

enumeration of ProgressReportingBaseResults

The ProgressReportingBaseResult object (abstract)

Base class for report entries

Type

string

The ProgressReportingMessage object (inherits from ProgressReportingBaseResult)

Progress or logging during reporting

Type = report.message

Message

string

DateTime

date

ISO date format

Current time stamp

The ProgressReportingDone object (inherits from ProgressReportingBaseResult)

Indicates that reporting finished successfully

Type = report.finished

DeltaDate

date

ISO date format

ReferenceDate

date

ISO date format

This date can be used for next delta

The ProgressReportingBaseResultLine object (abstract) (inherits from ProgressReportingBaseResult)

Base class for report results

ParentAuthorizable

string

expandable

ID of an Authorizable

Authorizable

string

expandable

ID of an Authorizable

ParentActivityStructure

string

expandable

ID of an ActivityStructure

ActivityStructure

string

expandable

ID of an ActivityStructure

Authorization

string

expandable

ID of an Authorization

ContentTime

integer

Progress

float

NormalizedScore

float

ValidUntil

date

ISO date format

Certificate activities only

RecertificationAfter

date

ISO date format

Certificate activities only

The ProgressReportingGroupResult object (inherits from ProgressReportingBaseResultLine)

Summary of an Activity for a PersonGroup

Type = report.activity.summary

ResultCount

integer

NotStarted

integer

Started

integer

Completed

integer

Passed

integer

Failed

integer

The ProgressReportingGroupProgramResult object (inherits from ProgressReportingGroupResult)

Summary of an ActivityStructure for a PersonGroup

Type = report.program.summary

StatusRules

bool

StatusProgress

float

The ProgressReportingResult object (inherits from ProgressReportingBaseResultLine)

Result of a Person on an Activity

Type = report.activity.result

DateCompleted

date

ISO date format

DateStarted

date

ISO date format

Status

integer

Allowed values: NotStarted (0), Busy (1), Pending (10), Done (20), Failed (30), Passed (40), NotAssigned (-1)

Result

string

ID of an ActivityResult

The ProgressReportingProgramResult object (inherits from ProgressReportingResult)

Result of a Person on an ActivityGroup

Type = report.program.result

StatusRules

bool

StatusProgress

float

Example request
1234567891011121314151617181920212223
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/activitygroups/g_9d88380f-2544-46fc-8051-4bed399160c4/.report \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "ActivityAttemptMode": "All",   "Authorizables": null,   "DeltaDate": null,   "IncludeActivities": true,   "IncludeGroupSummary": false,   "IncludeIntermediateActivityStructures": false,   "IncludeNotAttempted": false,   "IncludeParentActivityStructure": false,   "IncludeParentAuthorizable": false,   "IncludePersons": true,   "IncludeProgramSummary": false,   "IncludeResultDetails": false,   "IncludeUnassigned": false,   "LearnAuthorizations": null,   "ProgramSummaryAttemptMode": "Last",   "ReferenceDate": null,   "Verbose": false }' 

Example response
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
[   {     "Type": "report.message",     "Message": "Hello world",     "DateTime": "2026-06-06T10:38:47.9350947"   }   ,   {     "Type": "report.finished",     "DeltaDate": "2026-06-06T10:38:47.9350947",     "ReferenceDate": "2026-06-06T10:38:47.9350947"   }   ,   {     "Type": "report.activity.summary",     "ParentAuthorizable": "G_9b569094-1458-43b6-a9e9-ee2cfeb162c1",     "Authorizable": "G_4ed5afd0-b99f-44e9-a81c-3fdf078c695f",     "ParentActivityStructure": "G_70666425-e6b7-4b11-9e0d-dd0144f188bd",     "ActivityStructure": "G_4c9a1741-313e-4a65-ad66-f477b0d631b8",     "Authorization": "G_1fc0279d-2088-4db9-bbaa-86a650f62fe3",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9350947",     "RecertificationAfter": "2026-06-06T10:38:47.9350947",     "ResultCount": 1,     "NotStarted": 2,     "Started": 1,     "Completed": 3,     "Passed": 1,     "Failed": 0   }   ,   {     "Type": "report.program.summary",     "ParentAuthorizable": "G_9b569094-1458-43b6-a9e9-ee2cfeb162c1",     "Authorizable": "G_4ed5afd0-b99f-44e9-a81c-3fdf078c695f",     "ParentActivityStructure": "G_70666425-e6b7-4b11-9e0d-dd0144f188bd",     "ActivityStructure": "G_4c9a1741-313e-4a65-ad66-f477b0d631b8",     "Authorization": "G_1fc0279d-2088-4db9-bbaa-86a650f62fe3",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9350947",     "RecertificationAfter": "2026-06-06T10:38:47.9350947",     "ResultCount": 1,     "NotStarted": 2,     "Started": 1,     "Completed": 3,     "Passed": 1,     "Failed": 0,     "StatusRules": true,     "StatusProgress": null   }   ,   {     "Type": "report.activity.result",     "ParentAuthorizable": "G_9b569094-1458-43b6-a9e9-ee2cfeb162c1",     "Authorizable": "G_4ed5afd0-b99f-44e9-a81c-3fdf078c695f",     "ParentActivityStructure": "G_70666425-e6b7-4b11-9e0d-dd0144f188bd",     "ActivityStructure": "G_4c9a1741-313e-4a65-ad66-f477b0d631b8",     "Authorization": "G_1fc0279d-2088-4db9-bbaa-86a650f62fe3",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9350947",     "RecertificationAfter": "2026-06-06T10:38:47.9350947",     "DateCompleted": "2026-06-06T10:38:47.9350947",     "DateStarted": "2026-06-06T10:38:47.9350947",     "Status": null,     "Result": "E_0f0a6bec-1fd2-4a3c-b3f6-faed2f3d5907"   }   ,   {     "Type": "report.program.result",     "ParentAuthorizable": "G_9b569094-1458-43b6-a9e9-ee2cfeb162c1",     "Authorizable": "G_4ed5afd0-b99f-44e9-a81c-3fdf078c695f",     "ParentActivityStructure": "G_70666425-e6b7-4b11-9e0d-dd0144f188bd",     "ActivityStructure": "G_4c9a1741-313e-4a65-ad66-f477b0d631b8",     "Authorization": "G_1fc0279d-2088-4db9-bbaa-86a650f62fe3",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9350947",     "RecertificationAfter": "2026-06-06T10:38:47.9350947",     "DateCompleted": "2026-06-06T10:38:47.9350947",     "DateStarted": "2026-06-06T10:38:47.9350947",     "Status": null,     "Result": "E_0f0a6bec-1fd2-4a3c-b3f6-faed2f3d5907",     "StatusRules": true,     "StatusProgress": null   } ] 

ActivityStructures

ActivityStructures is the union of all ActivityGroups and Activities

CatalogEntry

bool

readonly default

Available filter operations: EQUALS,NOT_EQUALS

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Description

string

readonly default

Formatting allowed

Filter not supported

ExpectedActivityDuration

enum

readonly default

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

string

readonly always

Unique

Available filter operations: EQUALS,PATH_TO_ROOT,SUB_TREE,MEMBER_OF

Image

asset

readonly default

Image

Filter not supported

Metadata

string

readonly default

Filter not supported

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Name

string

readonly default

Max 255 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

ParentMemberships

array of strings

readonly request expandable

IDs of Entities

Filter not supported

SearchTags

string

readonly default

Filter not supported

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

The activity structure object
1234567891011121314151617
{   "CatalogEntry": false,   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9350947",   "Description": null,   "ExpectedActivityDuration": "unknown",   "ID": "G_73346645-1375-49a5-8f7a-c269052ff1ea",   "Image": null,   "Metadata": null,   "ModifiedDate": "2026-06-06T10:38:47.9350947",   "Name": "Example content",   "ParentMemberships": ["G_e524c947-e7e2-40a6-acf7-6e43b6679372"],   "SearchTags": null,   "Tag": "",   "Type": "ActivityStructures" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/activitystructures

Returns a list of activity structures.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of activity structure objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/activitystructures \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
1234567891011121314151617181920
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "CatalogEntry": false,       "Description": null,       "ExpectedActivityDuration": "unknown",       "ID": "G_73346645-1375-49a5-8f7a-c269052ff1ea",       "Image": null,       "Metadata": null,       "Name": "Example content",       "SearchTags": null,       "Tag": "",       "Type": "ActivityStructures"     }   ]   "Date": "2026-06-06T10:38:48.0132222", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/activitystructures/{activitystructure_id}

Retrieves an activity structure.

Path parameters

activitystructure_id

string

required

ID of the activity structure to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The activity structure object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/activitystructures/g_73346645-1375-49a5-8f7a-c269052ff1ea \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456789101112
{   "CatalogEntry": false,   "Description": null,   "ExpectedActivityDuration": "unknown",   "ID": "G_73346645-1375-49a5-8f7a-c269052ff1ea",   "Image": null,   "Metadata": null,   "Name": "Example content",   "SearchTags": null,   "Tag": "",   "Type": "ActivityStructures" } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/activitystructures/{activitystructure_id}/.report

Path parameters

activitystructure_id

string

required

ID of the activity structure on which the call is applied.

Query parameters

stream

boolean

optional

Stream results using Server-Sent Events

Request body

ActivityAttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Only include specific attempts

Authorizables

array of strings

optional

IDs of authorizables

DeltaDate

date

optional

ISO date format

Only include results after date

IncludeActivities

bool

optional

Add results on each activity to the output

IncludeGroupSummary

bool

optional

Add summaries of person groups to the output

IncludeIntermediateActivityStructures

bool

optional

Include intermediate ActivityStructures

IncludeNotAttempted

bool

optional

Include not attempted results

IncludeParentActivityStructure

bool

optional

Include ID of Parent ActivityStructure

IncludeParentAuthorizable

bool

optional

Include ID of Parent Authorizable

IncludePersons

bool

optional

Add individual results to the output

IncludeProgramSummary

bool

optional

Add calculated program status to the output

IncludeResultDetails

bool

optional

Add details of answered questions to the output

IncludeUnassigned

bool

optional

Add results of activities that are not currently assigned

LearnAuthorizations

array of strings

optional

IDs of learn authorizations

ProgramSummaryAttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Setting used for program status calculation

ReferenceDate

date

optional

ISO date format

Only include results before date

Verbose

bool

optional

Add messages to the output

Response body

enumeration of ProgressReportingBaseResults

The ProgressReportingBaseResult object (abstract)

Base class for report entries

Type

string

The ProgressReportingMessage object (inherits from ProgressReportingBaseResult)

Progress or logging during reporting

Type = report.message

Message

string

DateTime

date

ISO date format

Current time stamp

The ProgressReportingDone object (inherits from ProgressReportingBaseResult)

Indicates that reporting finished successfully

Type = report.finished

DeltaDate

date

ISO date format

ReferenceDate

date

ISO date format

This date can be used for next delta

The ProgressReportingBaseResultLine object (abstract) (inherits from ProgressReportingBaseResult)

Base class for report results

ParentAuthorizable

string

expandable

ID of an Authorizable

Authorizable

string

expandable

ID of an Authorizable

ParentActivityStructure

string

expandable

ID of an ActivityStructure

ActivityStructure

string

expandable

ID of an ActivityStructure

Authorization

string

expandable

ID of an Authorization

ContentTime

integer

Progress

float

NormalizedScore

float

ValidUntil

date

ISO date format

Certificate activities only

RecertificationAfter

date

ISO date format

Certificate activities only

The ProgressReportingGroupResult object (inherits from ProgressReportingBaseResultLine)

Summary of an Activity for a PersonGroup

Type = report.activity.summary

ResultCount

integer

NotStarted

integer

Started

integer

Completed

integer

Passed

integer

Failed

integer

The ProgressReportingGroupProgramResult object (inherits from ProgressReportingGroupResult)

Summary of an ActivityStructure for a PersonGroup

Type = report.program.summary

StatusRules

bool

StatusProgress

float

The ProgressReportingResult object (inherits from ProgressReportingBaseResultLine)

Result of a Person on an Activity

Type = report.activity.result

DateCompleted

date

ISO date format

DateStarted

date

ISO date format

Status

integer

Allowed values: NotStarted (0), Busy (1), Pending (10), Done (20), Failed (30), Passed (40), NotAssigned (-1)

Result

string

ID of an ActivityResult

The ProgressReportingProgramResult object (inherits from ProgressReportingResult)

Result of a Person on an ActivityGroup

Type = report.program.result

StatusRules

bool

StatusProgress

float

Example request
1234567891011121314151617181920212223
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/activitystructures/g_73346645-1375-49a5-8f7a-c269052ff1ea/.report \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "ActivityAttemptMode": "All",   "Authorizables": null,   "DeltaDate": null,   "IncludeActivities": true,   "IncludeGroupSummary": false,   "IncludeIntermediateActivityStructures": false,   "IncludeNotAttempted": false,   "IncludeParentActivityStructure": false,   "IncludeParentAuthorizable": false,   "IncludePersons": true,   "IncludeProgramSummary": false,   "IncludeResultDetails": false,   "IncludeUnassigned": false,   "LearnAuthorizations": null,   "ProgramSummaryAttemptMode": "Last",   "ReferenceDate": null,   "Verbose": false }' 

Example response
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
[   {     "Type": "report.message",     "Message": "Hello world",     "DateTime": "2026-06-06T10:38:47.9350947"   }   ,   {     "Type": "report.finished",     "DeltaDate": "2026-06-06T10:38:47.9350947",     "ReferenceDate": "2026-06-06T10:38:47.9350947"   }   ,   {     "Type": "report.activity.summary",     "ParentAuthorizable": "G_57a97788-64cb-4e89-a092-ac51cf3be24d",     "Authorizable": "G_d1fb4446-6d1a-4331-956d-971a848c5936",     "ParentActivityStructure": "G_4c14d365-4c70-4526-988a-35154a42b626",     "ActivityStructure": "G_6caf2757-1800-4dd4-aeed-ed5fd0319734",     "Authorization": "G_ad37a311-0c2e-4f0c-9ffe-566a41b9834a",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9350947",     "RecertificationAfter": "2026-06-06T10:38:47.9350947",     "ResultCount": 1,     "NotStarted": 2,     "Started": 1,     "Completed": 3,     "Passed": 1,     "Failed": 0   }   ,   {     "Type": "report.program.summary",     "ParentAuthorizable": "G_57a97788-64cb-4e89-a092-ac51cf3be24d",     "Authorizable": "G_d1fb4446-6d1a-4331-956d-971a848c5936",     "ParentActivityStructure": "G_4c14d365-4c70-4526-988a-35154a42b626",     "ActivityStructure": "G_6caf2757-1800-4dd4-aeed-ed5fd0319734",     "Authorization": "G_ad37a311-0c2e-4f0c-9ffe-566a41b9834a",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9350947",     "RecertificationAfter": "2026-06-06T10:38:47.9350947",     "ResultCount": 1,     "NotStarted": 2,     "Started": 1,     "Completed": 3,     "Passed": 1,     "Failed": 0,     "StatusRules": true,     "StatusProgress": null   }   ,   {     "Type": "report.activity.result",     "ParentAuthorizable": "G_57a97788-64cb-4e89-a092-ac51cf3be24d",     "Authorizable": "G_d1fb4446-6d1a-4331-956d-971a848c5936",     "ParentActivityStructure": "G_4c14d365-4c70-4526-988a-35154a42b626",     "ActivityStructure": "G_6caf2757-1800-4dd4-aeed-ed5fd0319734",     "Authorization": "G_ad37a311-0c2e-4f0c-9ffe-566a41b9834a",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9350947",     "RecertificationAfter": "2026-06-06T10:38:47.9350947",     "DateCompleted": "2026-06-06T10:38:47.9350947",     "DateStarted": "2026-06-06T10:38:47.9350947",     "Status": null,     "Result": "E_8e7b5535-4bf4-46a2-82b3-47dd7b27c3aa"   }   ,   {     "Type": "report.program.result",     "ParentAuthorizable": "G_57a97788-64cb-4e89-a092-ac51cf3be24d",     "Authorizable": "G_d1fb4446-6d1a-4331-956d-971a848c5936",     "ParentActivityStructure": "G_4c14d365-4c70-4526-988a-35154a42b626",     "ActivityStructure": "G_6caf2757-1800-4dd4-aeed-ed5fd0319734",     "Authorization": "G_ad37a311-0c2e-4f0c-9ffe-566a41b9834a",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9350947",     "RecertificationAfter": "2026-06-06T10:38:47.9350947",     "DateCompleted": "2026-06-06T10:38:47.9350947",     "DateStarted": "2026-06-06T10:38:47.9350947",     "Status": null,     "Result": "E_8e7b5535-4bf4-46a2-82b3-47dd7b27c3aa",     "StatusRules": true,     "StatusProgress": null   } ] 

CertificateActivities

CatalogEntry

bool

readonly default

Available filter operations: EQUALS,NOT_EQUALS

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Description

string

readonly default

Formatting allowed

Filter not supported

ExpectedActivityDuration

enum

readonly default

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

string

readonly always

Unique

Available filter operations: EQUALS,PATH_TO_ROOT,SUB_TREE,MEMBER_OF

Image

asset

readonly default

Image

Filter not supported

Metadata

string

readonly default

Filter not supported

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Name

string

readonly default

Max 255 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

ParentMemberships

array of strings

readonly request expandable

IDs of Entities

Filter not supported

SearchTags

string

readonly default

Filter not supported

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

The certificate activity object
1234567891011121314151617
{   "CatalogEntry": false,   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9350947",   "Description": null,   "ExpectedActivityDuration": "unknown",   "ID": "G_287d8cc3-2452-4a90-9695-d849e144a177",   "Image": null,   "Metadata": null,   "ModifiedDate": "2026-06-06T10:38:47.9350947",   "Name": "Example content",   "ParentMemberships": ["G_8c26286b-dac3-4eb5-a784-03c46c1512a4"],   "SearchTags": null,   "Tag": "",   "Type": "CertificateActivities" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/certificateactivities

Returns a list of certificate activities.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of certificate activity objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/certificateactivities \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
1234567891011121314151617181920
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "CatalogEntry": false,       "Description": null,       "ExpectedActivityDuration": "unknown",       "ID": "G_287d8cc3-2452-4a90-9695-d849e144a177",       "Image": null,       "Metadata": null,       "Name": "Example content",       "SearchTags": null,       "Tag": "",       "Type": "CertificateActivities"     }   ]   "Date": "2026-06-06T10:38:48.0132222", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/certificateactivities/{certificateactivity_id}

Retrieves a certificate activity.

Path parameters

certificateactivity_id

string

required

ID of the certificate activity to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The certificate activity object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/certificateactivities/g_287d8cc3-2452-4a90-9695-d849e144a177 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456789101112
{   "CatalogEntry": false,   "Description": null,   "ExpectedActivityDuration": "unknown",   "ID": "G_287d8cc3-2452-4a90-9695-d849e144a177",   "Image": null,   "Metadata": null,   "Name": "Example content",   "SearchTags": null,   "Tag": "",   "Type": "CertificateActivities" } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/certificateactivities/{certificateactivity_id}/.report

Path parameters

certificateactivity_id

string

required

ID of the certificate activity on which the call is applied.

Query parameters

stream

boolean

optional

Stream results using Server-Sent Events

Request body

ActivityAttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Only include specific attempts

Authorizables

array of strings

optional

IDs of authorizables

DeltaDate

date

optional

ISO date format

Only include results after date

IncludeActivities

bool

optional

Add results on each activity to the output

IncludeGroupSummary

bool

optional

Add summaries of person groups to the output

IncludeIntermediateActivityStructures

bool

optional

Include intermediate ActivityStructures

IncludeNotAttempted

bool

optional

Include not attempted results

IncludeParentActivityStructure

bool

optional

Include ID of Parent ActivityStructure

IncludeParentAuthorizable

bool

optional

Include ID of Parent Authorizable

IncludePersons

bool

optional

Add individual results to the output

IncludeProgramSummary

bool

optional

Add calculated program status to the output

IncludeResultDetails

bool

optional

Add details of answered questions to the output

IncludeUnassigned

bool

optional

Add results of activities that are not currently assigned

LearnAuthorizations

array of strings

optional

IDs of learn authorizations

ProgramSummaryAttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Setting used for program status calculation

ReferenceDate

date

optional

ISO date format

Only include results before date

Verbose

bool

optional

Add messages to the output

Response body

enumeration of ProgressReportingBaseResults

The ProgressReportingBaseResult object (abstract)

Base class for report entries

Type

string

The ProgressReportingMessage object (inherits from ProgressReportingBaseResult)

Progress or logging during reporting

Type = report.message

Message

string

DateTime

date

ISO date format

Current time stamp

The ProgressReportingDone object (inherits from ProgressReportingBaseResult)

Indicates that reporting finished successfully

Type = report.finished

DeltaDate

date

ISO date format

ReferenceDate

date

ISO date format

This date can be used for next delta

The ProgressReportingBaseResultLine object (abstract) (inherits from ProgressReportingBaseResult)

Base class for report results

ParentAuthorizable

string

expandable

ID of an Authorizable

Authorizable

string

expandable

ID of an Authorizable

ParentActivityStructure

string

expandable

ID of an ActivityStructure

ActivityStructure

string

expandable

ID of an ActivityStructure

Authorization

string

expandable

ID of an Authorization

ContentTime

integer

Progress

float

NormalizedScore

float

ValidUntil

date

ISO date format

Certificate activities only

RecertificationAfter

date

ISO date format

Certificate activities only

The ProgressReportingGroupResult object (inherits from ProgressReportingBaseResultLine)

Summary of an Activity for a PersonGroup

Type = report.activity.summary

ResultCount

integer

NotStarted

integer

Started

integer

Completed

integer

Passed

integer

Failed

integer

The ProgressReportingGroupProgramResult object (inherits from ProgressReportingGroupResult)

Summary of an ActivityStructure for a PersonGroup

Type = report.program.summary

StatusRules

bool

StatusProgress

float

The ProgressReportingResult object (inherits from ProgressReportingBaseResultLine)

Result of a Person on an Activity

Type = report.activity.result

DateCompleted

date

ISO date format

DateStarted

date

ISO date format

Status

integer

Allowed values: NotStarted (0), Busy (1), Pending (10), Done (20), Failed (30), Passed (40), NotAssigned (-1)

Result

string

ID of an ActivityResult

The ProgressReportingProgramResult object (inherits from ProgressReportingResult)

Result of a Person on an ActivityGroup

Type = report.program.result

StatusRules

bool

StatusProgress

float

Example request
1234567891011121314151617181920212223
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/certificateactivities/g_287d8cc3-2452-4a90-9695-d849e144a177/.report \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "ActivityAttemptMode": "All",   "Authorizables": null,   "DeltaDate": null,   "IncludeActivities": true,   "IncludeGroupSummary": false,   "IncludeIntermediateActivityStructures": false,   "IncludeNotAttempted": false,   "IncludeParentActivityStructure": false,   "IncludeParentAuthorizable": false,   "IncludePersons": true,   "IncludeProgramSummary": false,   "IncludeResultDetails": false,   "IncludeUnassigned": false,   "LearnAuthorizations": null,   "ProgramSummaryAttemptMode": "Last",   "ReferenceDate": null,   "Verbose": false }' 

Example response
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
[   {     "Type": "report.message",     "Message": "Hello world",     "DateTime": "2026-06-06T10:38:47.9350947"   }   ,   {     "Type": "report.finished",     "DeltaDate": "2026-06-06T10:38:47.9350947",     "ReferenceDate": "2026-06-06T10:38:47.9350947"   }   ,   {     "Type": "report.activity.summary",     "ParentAuthorizable": "G_18c6871d-f913-461e-824b-1a44d12eb5e3",     "Authorizable": "G_4fb5f5a5-01ad-4b48-8abc-3cfe43ac9d68",     "ParentActivityStructure": "G_4791e65f-b7c4-4d18-8b6a-763c95f590b1",     "ActivityStructure": "G_b46b0176-4f15-46b4-b789-f6573bcbad4a",     "Authorization": "G_9cf260d3-cbb0-4ec0-b2b4-08105e2c7f54",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9350947",     "RecertificationAfter": "2026-06-06T10:38:47.9350947",     "ResultCount": 1,     "NotStarted": 2,     "Started": 1,     "Completed": 3,     "Passed": 1,     "Failed": 0   }   ,   {     "Type": "report.program.summary",     "ParentAuthorizable": "G_18c6871d-f913-461e-824b-1a44d12eb5e3",     "Authorizable": "G_4fb5f5a5-01ad-4b48-8abc-3cfe43ac9d68",     "ParentActivityStructure": "G_4791e65f-b7c4-4d18-8b6a-763c95f590b1",     "ActivityStructure": "G_b46b0176-4f15-46b4-b789-f6573bcbad4a",     "Authorization": "G_9cf260d3-cbb0-4ec0-b2b4-08105e2c7f54",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9350947",     "RecertificationAfter": "2026-06-06T10:38:47.9350947",     "ResultCount": 1,     "NotStarted": 2,     "Started": 1,     "Completed": 3,     "Passed": 1,     "Failed": 0,     "StatusRules": true,     "StatusProgress": null   }   ,   {     "Type": "report.activity.result",     "ParentAuthorizable": "G_18c6871d-f913-461e-824b-1a44d12eb5e3",     "Authorizable": "G_4fb5f5a5-01ad-4b48-8abc-3cfe43ac9d68",     "ParentActivityStructure": "G_4791e65f-b7c4-4d18-8b6a-763c95f590b1",     "ActivityStructure": "G_b46b0176-4f15-46b4-b789-f6573bcbad4a",     "Authorization": "G_9cf260d3-cbb0-4ec0-b2b4-08105e2c7f54",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9350947",     "RecertificationAfter": "2026-06-06T10:38:47.9350947",     "DateCompleted": "2026-06-06T10:38:47.9350947",     "DateStarted": "2026-06-06T10:38:47.9350947",     "Status": null,     "Result": "E_0a96beb4-61a2-4650-bfba-5c3cb76ad3a2"   }   ,   {     "Type": "report.program.result",     "ParentAuthorizable": "G_18c6871d-f913-461e-824b-1a44d12eb5e3",     "Authorizable": "G_4fb5f5a5-01ad-4b48-8abc-3cfe43ac9d68",     "ParentActivityStructure": "G_4791e65f-b7c4-4d18-8b6a-763c95f590b1",     "ActivityStructure": "G_b46b0176-4f15-46b4-b789-f6573bcbad4a",     "Authorization": "G_9cf260d3-cbb0-4ec0-b2b4-08105e2c7f54",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9350947",     "RecertificationAfter": "2026-06-06T10:38:47.9350947",     "DateCompleted": "2026-06-06T10:38:47.9350947",     "DateStarted": "2026-06-06T10:38:47.9350947",     "Status": null,     "Result": "E_0a96beb4-61a2-4650-bfba-5c3cb76ad3a2",     "StatusRules": true,     "StatusProgress": null   } ] 

ClassroomTrainings

BannerImage

asset

readonly default

Image

Filter not supported

CatalogEntry

bool

readonly default

Available filter operations: EQUALS,NOT_EQUALS

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Description

string

readonly default

Formatting allowed

Filter not supported

DocumentsBody

string

readonly default

Filter not supported

ExpectedActivityDuration

enum

readonly default

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

string

readonly always

Unique

Available filter operations: EQUALS,PATH_TO_ROOT,SUB_TREE,MEMBER_OF

Image

asset

readonly default

Image

Filter not supported

MaxParticipants

integer

readonly default

Filter not supported

Metadata

string

readonly default

Filter not supported

MinParticipants

integer

readonly default

Filter not supported

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Name

string

readonly default

Max 255 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

ParentMemberships

array of strings

readonly request expandable

IDs of Entities

Filter not supported

SearchTags

string

readonly default

Filter not supported

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

The classroom training object
123456789101112131415161718192021
{   "BannerImage": null,   "CatalogEntry": false,   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9507106",   "Description": null,   "DocumentsBody": null,   "ExpectedActivityDuration": "unknown",   "ID": "G_0bafcc98-7250-4f9a-a294-5ea05e5c1ecf",   "Image": null,   "MaxParticipants": null,   "Metadata": null,   "MinParticipants": null,   "ModifiedDate": "2026-06-06T10:38:47.9507106",   "Name": "Example content",   "ParentMemberships": ["G_6a078c8d-d771-489e-910e-ffd022b832ac"],   "SearchTags": null,   "Tag": "",   "Type": "ClassroomTrainings" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/classroomtrainings

Returns a list of classroom trainings.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of classroom training objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/classroomtrainings \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456789101112131415161718192021222324
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "BannerImage": null,       "CatalogEntry": false,       "Description": null,       "DocumentsBody": null,       "ExpectedActivityDuration": "unknown",       "ID": "G_0bafcc98-7250-4f9a-a294-5ea05e5c1ecf",       "Image": null,       "MaxParticipants": null,       "Metadata": null,       "MinParticipants": null,       "Name": "Example content",       "SearchTags": null,       "Tag": "",       "Type": "ClassroomTrainings"     }   ]   "Date": "2026-06-06T10:38:48.0132222", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/classroomtrainings/{classroomtraining_id}

Retrieves a classroom training.

Path parameters

classroomtraining_id

string

required

ID of the classroom training to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The classroom training object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/classroomtrainings/g_0bafcc98-7250-4f9a-a294-5ea05e5c1ecf \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
12345678910111213141516
{   "BannerImage": null,   "CatalogEntry": false,   "Description": null,   "DocumentsBody": null,   "ExpectedActivityDuration": "unknown",   "ID": "G_0bafcc98-7250-4f9a-a294-5ea05e5c1ecf",   "Image": null,   "MaxParticipants": null,   "Metadata": null,   "MinParticipants": null,   "Name": "Example content",   "SearchTags": null,   "Tag": "",   "Type": "ClassroomTrainings" } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/classroomtrainings/{classroomtraining_id}/.report

Path parameters

classroomtraining_id

string

required

ID of the classroom training on which the call is applied.

Query parameters

stream

boolean

optional

Stream results using Server-Sent Events

Request body

ActivityAttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Only include specific attempts

Authorizables

array of strings

optional

IDs of authorizables

DeltaDate

date

optional

ISO date format

Only include results after date

IncludeActivities

bool

optional

Add results on each activity to the output

IncludeGroupSummary

bool

optional

Add summaries of person groups to the output

IncludeIntermediateActivityStructures

bool

optional

Include intermediate ActivityStructures

IncludeNotAttempted

bool

optional

Include not attempted results

IncludeParentActivityStructure

bool

optional

Include ID of Parent ActivityStructure

IncludeParentAuthorizable

bool

optional

Include ID of Parent Authorizable

IncludePersons

bool

optional

Add individual results to the output

IncludeProgramSummary

bool

optional

Add calculated program status to the output

IncludeResultDetails

bool

optional

Add details of answered questions to the output

IncludeUnassigned

bool

optional

Add results of activities that are not currently assigned

LearnAuthorizations

array of strings

optional

IDs of learn authorizations

ProgramSummaryAttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Setting used for program status calculation

ReferenceDate

date

optional

ISO date format

Only include results before date

Verbose

bool

optional

Add messages to the output

Response body

enumeration of ProgressReportingBaseResults

The ProgressReportingBaseResult object (abstract)

Base class for report entries

Type

string

The ProgressReportingMessage object (inherits from ProgressReportingBaseResult)

Progress or logging during reporting

Type = report.message

Message

string

DateTime

date

ISO date format

Current time stamp

The ProgressReportingDone object (inherits from ProgressReportingBaseResult)

Indicates that reporting finished successfully

Type = report.finished

DeltaDate

date

ISO date format

ReferenceDate

date

ISO date format

This date can be used for next delta

The ProgressReportingBaseResultLine object (abstract) (inherits from ProgressReportingBaseResult)

Base class for report results

ParentAuthorizable

string

expandable

ID of an Authorizable

Authorizable

string

expandable

ID of an Authorizable

ParentActivityStructure

string

expandable

ID of an ActivityStructure

ActivityStructure

string

expandable

ID of an ActivityStructure

Authorization

string

expandable

ID of an Authorization

ContentTime

integer

Progress

float

NormalizedScore

float

ValidUntil

date

ISO date format

Certificate activities only

RecertificationAfter

date

ISO date format

Certificate activities only

The ProgressReportingGroupResult object (inherits from ProgressReportingBaseResultLine)

Summary of an Activity for a PersonGroup

Type = report.activity.summary

ResultCount

integer

NotStarted

integer

Started

integer

Completed

integer

Passed

integer

Failed

integer

The ProgressReportingGroupProgramResult object (inherits from ProgressReportingGroupResult)

Summary of an ActivityStructure for a PersonGroup

Type = report.program.summary

StatusRules

bool

StatusProgress

float

The ProgressReportingResult object (inherits from ProgressReportingBaseResultLine)

Result of a Person on an Activity

Type = report.activity.result

DateCompleted

date

ISO date format

DateStarted

date

ISO date format

Status

integer

Allowed values: NotStarted (0), Busy (1), Pending (10), Done (20), Failed (30), Passed (40), NotAssigned (-1)

Result

string

ID of an ActivityResult

The ProgressReportingProgramResult object (inherits from ProgressReportingResult)

Result of a Person on an ActivityGroup

Type = report.program.result

StatusRules

bool

StatusProgress

float

Example request
1234567891011121314151617181920212223
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/classroomtrainings/g_0bafcc98-7250-4f9a-a294-5ea05e5c1ecf/.report \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "ActivityAttemptMode": "All",   "Authorizables": null,   "DeltaDate": null,   "IncludeActivities": true,   "IncludeGroupSummary": false,   "IncludeIntermediateActivityStructures": false,   "IncludeNotAttempted": false,   "IncludeParentActivityStructure": false,   "IncludeParentAuthorizable": false,   "IncludePersons": true,   "IncludeProgramSummary": false,   "IncludeResultDetails": false,   "IncludeUnassigned": false,   "LearnAuthorizations": null,   "ProgramSummaryAttemptMode": "Last",   "ReferenceDate": null,   "Verbose": false }' 

Example response
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
[   {     "Type": "report.message",     "Message": "Hello world",     "DateTime": "2026-06-06T10:38:47.9507106"   }   ,   {     "Type": "report.finished",     "DeltaDate": "2026-06-06T10:38:47.9507106",     "ReferenceDate": "2026-06-06T10:38:47.9507106"   }   ,   {     "Type": "report.activity.summary",     "ParentAuthorizable": "G_03742555-9226-450b-a027-9d0f2afe0073",     "Authorizable": "G_f0387ac2-e1a2-41c6-823e-24f41e5a6b8b",     "ParentActivityStructure": "G_2c95998f-c2cd-42fb-8627-fc99f53af014",     "ActivityStructure": "G_2bac37d3-6114-420b-a42b-0ee567eb04aa",     "Authorization": "G_6a8b7125-7958-4125-a5af-94ce5a46a0de",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9507106",     "RecertificationAfter": "2026-06-06T10:38:47.9507106",     "ResultCount": 1,     "NotStarted": 2,     "Started": 1,     "Completed": 3,     "Passed": 1,     "Failed": 0   }   ,   {     "Type": "report.program.summary",     "ParentAuthorizable": "G_03742555-9226-450b-a027-9d0f2afe0073",     "Authorizable": "G_f0387ac2-e1a2-41c6-823e-24f41e5a6b8b",     "ParentActivityStructure": "G_2c95998f-c2cd-42fb-8627-fc99f53af014",     "ActivityStructure": "G_2bac37d3-6114-420b-a42b-0ee567eb04aa",     "Authorization": "G_6a8b7125-7958-4125-a5af-94ce5a46a0de",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9507106",     "RecertificationAfter": "2026-06-06T10:38:47.9507106",     "ResultCount": 1,     "NotStarted": 2,     "Started": 1,     "Completed": 3,     "Passed": 1,     "Failed": 0,     "StatusRules": true,     "StatusProgress": null   }   ,   {     "Type": "report.activity.result",     "ParentAuthorizable": "G_03742555-9226-450b-a027-9d0f2afe0073",     "Authorizable": "G_f0387ac2-e1a2-41c6-823e-24f41e5a6b8b",     "ParentActivityStructure": "G_2c95998f-c2cd-42fb-8627-fc99f53af014",     "ActivityStructure": "G_2bac37d3-6114-420b-a42b-0ee567eb04aa",     "Authorization": "G_6a8b7125-7958-4125-a5af-94ce5a46a0de",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9507106",     "RecertificationAfter": "2026-06-06T10:38:47.9507106",     "DateCompleted": "2026-06-06T10:38:47.9507106",     "DateStarted": "2026-06-06T10:38:47.9507106",     "Status": null,     "Result": "E_38e354a0-79a1-45d4-80e3-f1a97f609a55"   }   ,   {     "Type": "report.program.result",     "ParentAuthorizable": "G_03742555-9226-450b-a027-9d0f2afe0073",     "Authorizable": "G_f0387ac2-e1a2-41c6-823e-24f41e5a6b8b",     "ParentActivityStructure": "G_2c95998f-c2cd-42fb-8627-fc99f53af014",     "ActivityStructure": "G_2bac37d3-6114-420b-a42b-0ee567eb04aa",     "Authorization": "G_6a8b7125-7958-4125-a5af-94ce5a46a0de",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9507106",     "RecertificationAfter": "2026-06-06T10:38:47.9507106",     "DateCompleted": "2026-06-06T10:38:47.9507106",     "DateStarted": "2026-06-06T10:38:47.9507106",     "Status": null,     "Result": "E_38e354a0-79a1-45d4-80e3-f1a97f609a55",     "StatusRules": true,     "StatusProgress": null   } ] 

Authorizations

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

EndDate

date

readwrite default

ISO date format

Filter not supported

string

readonly always

Unique

Available filter operations: EQUALS

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

string

immutable default expandable

Available filter operations: EQUALS

ID of an Authorizable

string

immutable default expandable

Available filter operations: EQUALS

ID of an Entity

StartDate

date

readwrite default

ISO date format

Filter not supported

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

The authorization object
12345678910111213
{   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9350947",   "EndDate": "2026-01-01T00:00:00",   "ID": "G_e256ca85-7219-4e39-b9ca-509dc6da6601",   "ModifiedDate": "2026-06-06T10:38:47.9350947",   "Of": "G_727ab5bf-5169-4cbd-bed5-e2f04fa1e273",   "On": "G_b14a6ed5-5fc2-4b22-a502-eee96063d1f7",   "StartDate": "2026-01-01T00:00:00",   "Tag": "",   "Type": "Authorizations" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/authorizations

Returns a list of authorizations.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of authorization objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/authorizations \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
1234567891011121314151617
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "EndDate": "2026-01-01T00:00:00",       "ID": "G_e256ca85-7219-4e39-b9ca-509dc6da6601",       "Of": "G_727ab5bf-5169-4cbd-bed5-e2f04fa1e273",       "On": "G_b14a6ed5-5fc2-4b22-a502-eee96063d1f7",       "StartDate": "2026-01-01T00:00:00",       "Tag": "",       "Type": "Authorizations"     }   ]   "Date": "2026-06-06T10:38:48.0132222", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/authorizations/{authorization_id}

Retrieves an authorization.

Path parameters

authorization_id

string

required

ID of the authorization to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The authorization object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/authorizations/g_e256ca85-7219-4e39-b9ca-509dc6da6601 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456789
{   "EndDate": "2026-01-01T00:00:00",   "ID": "G_e256ca85-7219-4e39-b9ca-509dc6da6601",   "Of": "G_727ab5bf-5169-4cbd-bed5-e2f04fa1e273",   "On": "G_b14a6ed5-5fc2-4b22-a502-eee96063d1f7",   "StartDate": "2026-01-01T00:00:00",   "Tag": "",   "Type": "Authorizations" } 

PUT https://genapiv1.growsparks.com/rest/genapiv1/v1/authorizations/{authorization_id}

Modifies an authorization.

Path parameters

authorization_id

string

required

ID of the authorization to modify.

Request body

EndDate

date

optional

ISO date format

StartDate

date

optional

ISO date format

Tag

string

optional

Max 100 chars

Returns

The modified authorization object.

Example request
123456789
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/authorizations/g_e256ca85-7219-4e39-b9ca-509dc6da6601 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X PUT \   -d '{   "EndDate": "2026-01-01T00:00:00",   "StartDate": "2026-01-01T00:00:00",   "Tag": "" }' 

Response
12345678910111213
{   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9350947",   "EndDate": "2026-01-01T00:00:00",   "ID": "G_e256ca85-7219-4e39-b9ca-509dc6da6601",   "ModifiedDate": "2026-06-06T10:38:47.9350947",   "Of": "G_727ab5bf-5169-4cbd-bed5-e2f04fa1e273",   "On": "G_b14a6ed5-5fc2-4b22-a502-eee96063d1f7",   "StartDate": "2026-01-01T00:00:00",   "Tag": "",   "Type": "Authorizations" } 

LearnAuthorizations

Authorizables can have LearnAuthorizations on ActivityStructures, this means that all persons that are direct or indirect member of the Authorizable have access to the ActivityStructure

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

EndDate

date

readwrite default

ISO date format

Filter not supported

string

readonly always

Unique

Available filter operations: EQUALS

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

string

immutable default expandable

Available filter operations: EQUALS

ID of an Authorizable

string

immutable default expandable

Available filter operations: EQUALS

ID of an Entity

Recommended

bool

readwrite request

Available filter operations: EQUALS,NOT_EQUALS

StartDate

date

readwrite default

ISO date format

Filter not supported

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

The learn authorization object
1234567891011121314
{   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9507106",   "EndDate": "2026-01-01T00:00:00",   "ID": "G_c47cdabf-3c43-459f-87b5-c9a6c7a90aae",   "ModifiedDate": "2026-06-06T10:38:47.9507106",   "Of": "G_b7e9a43b-d9f1-4005-aaf4-90dd55064f09",   "On": "G_fea6e1d2-a095-41fb-b88c-e67c58b42d48",   "Recommended": null,   "StartDate": "2026-01-01T00:00:00",   "Tag": "",   "Type": "LearnAuthorizations" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/learnauthorizations

Returns a list of learn authorizations.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of learn authorization objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/learnauthorizations \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
1234567891011121314151617
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "EndDate": "2026-01-01T00:00:00",       "ID": "G_c47cdabf-3c43-459f-87b5-c9a6c7a90aae",       "Of": "G_b7e9a43b-d9f1-4005-aaf4-90dd55064f09",       "On": "G_fea6e1d2-a095-41fb-b88c-e67c58b42d48",       "StartDate": "2026-01-01T00:00:00",       "Tag": "",       "Type": "LearnAuthorizations"     }   ]   "Date": "2026-06-06T10:38:48.0132222", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/learnauthorizations/{learnauthorization_id}

Retrieves a learn authorization.

Path parameters

learnauthorization_id

string

required

ID of the learn authorization to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The learn authorization object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/learnauthorizations/g_c47cdabf-3c43-459f-87b5-c9a6c7a90aae \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456789
{   "EndDate": "2026-01-01T00:00:00",   "ID": "G_c47cdabf-3c43-459f-87b5-c9a6c7a90aae",   "Of": "G_b7e9a43b-d9f1-4005-aaf4-90dd55064f09",   "On": "G_fea6e1d2-a095-41fb-b88c-e67c58b42d48",   "StartDate": "2026-01-01T00:00:00",   "Tag": "",   "Type": "LearnAuthorizations" } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/learnauthorizations/{learnauthorization_id}/.report

Path parameters

learnauthorization_id

string

required

ID of the learn authorization on which the call is applied.

Query parameters

stream

boolean

optional

Stream results using Server-Sent Events

Request body

ActivityAttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Only include specific attempts

ActivityStructures

array of strings

optional

IDs of activity structures

Authorizables

array of strings

optional

IDs of authorizables

DeltaDate

date

optional

ISO date format

Only include results after date

IncludeActivities

bool

optional

Add results on each activity to the output

IncludeGroupSummary

bool

optional

Add summaries of person groups to the output

IncludeIntermediateActivityStructures

bool

optional

Include intermediate ActivityStructures

IncludeNotAttempted

bool

optional

Include not attempted results

IncludeParentActivityStructure

bool

optional

Include ID of Parent ActivityStructure

IncludeParentAuthorizable

bool

optional

Include ID of Parent Authorizable

IncludePersons

bool

optional

Add individual results to the output

IncludeProgramSummary

bool

optional

Add calculated program status to the output

IncludeResultDetails

bool

optional

Add details of answered questions to the output

ProgramSummaryAttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Setting used for program status calculation

ReferenceDate

date

optional

ISO date format

Only include results before date

Verbose

bool

optional

Add messages to the output

Response body

enumeration of ProgressReportingBaseResults

The ProgressReportingBaseResult object (abstract)

Base class for report entries

Type

string

The ProgressReportingMessage object (inherits from ProgressReportingBaseResult)

Progress or logging during reporting

Type = report.message

Message

string

DateTime

date

ISO date format

Current time stamp

The ProgressReportingDone object (inherits from ProgressReportingBaseResult)

Indicates that reporting finished successfully

Type = report.finished

DeltaDate

date

ISO date format

ReferenceDate

date

ISO date format

This date can be used for next delta

The ProgressReportingBaseResultLine object (abstract) (inherits from ProgressReportingBaseResult)

Base class for report results

ParentAuthorizable

string

expandable

ID of an Authorizable

Authorizable

string

expandable

ID of an Authorizable

ParentActivityStructure

string

expandable

ID of an ActivityStructure

ActivityStructure

string

expandable

ID of an ActivityStructure

Authorization

string

expandable

ID of an Authorization

ContentTime

integer

Progress

float

NormalizedScore

float

ValidUntil

date

ISO date format

Certificate activities only

RecertificationAfter

date

ISO date format

Certificate activities only

The ProgressReportingGroupResult object (inherits from ProgressReportingBaseResultLine)

Summary of an Activity for a PersonGroup

Type = report.activity.summary

ResultCount

integer

NotStarted

integer

Started

integer

Completed

integer

Passed

integer

Failed

integer

The ProgressReportingGroupProgramResult object (inherits from ProgressReportingGroupResult)

Summary of an ActivityStructure for a PersonGroup

Type = report.program.summary

StatusRules

bool

StatusProgress

float

The ProgressReportingResult object (inherits from ProgressReportingBaseResultLine)

Result of a Person on an Activity

Type = report.activity.result

DateCompleted

date

ISO date format

DateStarted

date

ISO date format

Status

integer

Allowed values: NotStarted (0), Busy (1), Pending (10), Done (20), Failed (30), Passed (40), NotAssigned (-1)

Result

string

ID of an ActivityResult

The ProgressReportingProgramResult object (inherits from ProgressReportingResult)

Result of a Person on an ActivityGroup

Type = report.program.result

StatusRules

bool

StatusProgress

float

Example request
12345678910111213141516171819202122
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/learnauthorizations/g_c47cdabf-3c43-459f-87b5-c9a6c7a90aae/.report \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "ActivityAttemptMode": "All",   "ActivityStructures": null,   "Authorizables": null,   "DeltaDate": null,   "IncludeActivities": true,   "IncludeGroupSummary": false,   "IncludeIntermediateActivityStructures": false,   "IncludeNotAttempted": false,   "IncludeParentActivityStructure": false,   "IncludeParentAuthorizable": false,   "IncludePersons": true,   "IncludeProgramSummary": false,   "IncludeResultDetails": false,   "ProgramSummaryAttemptMode": "Last",   "ReferenceDate": null,   "Verbose": false }' 

Example response
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
[   {     "Type": "report.message",     "Message": "Hello world",     "DateTime": "2026-06-06T10:38:47.9507106"   }   ,   {     "Type": "report.finished",     "DeltaDate": "2026-06-06T10:38:47.9507106",     "ReferenceDate": "2026-06-06T10:38:47.9507106"   }   ,   {     "Type": "report.activity.summary",     "ParentAuthorizable": "G_95ef6c8f-429f-4787-9e0b-f812d9f9720a",     "Authorizable": "G_442a991b-598c-4a69-ae75-250658812cc9",     "ParentActivityStructure": "G_b3fcce28-ab56-4eb2-952e-6d14c597b70a",     "ActivityStructure": "G_3def36c7-3e55-4cc0-b444-98f3d7d232a5",     "Authorization": "G_a9f6f91d-cb0b-47d5-8162-f3039031ba1c",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9507106",     "RecertificationAfter": "2026-06-06T10:38:47.9507106",     "ResultCount": 1,     "NotStarted": 2,     "Started": 1,     "Completed": 3,     "Passed": 1,     "Failed": 0   }   ,   {     "Type": "report.program.summary",     "ParentAuthorizable": "G_95ef6c8f-429f-4787-9e0b-f812d9f9720a",     "Authorizable": "G_442a991b-598c-4a69-ae75-250658812cc9",     "ParentActivityStructure": "G_b3fcce28-ab56-4eb2-952e-6d14c597b70a",     "ActivityStructure": "G_3def36c7-3e55-4cc0-b444-98f3d7d232a5",     "Authorization": "G_a9f6f91d-cb0b-47d5-8162-f3039031ba1c",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9507106",     "RecertificationAfter": "2026-06-06T10:38:47.9507106",     "ResultCount": 1,     "NotStarted": 2,     "Started": 1,     "Completed": 3,     "Passed": 1,     "Failed": 0,     "StatusRules": true,     "StatusProgress": null   }   ,   {     "Type": "report.activity.result",     "ParentAuthorizable": "G_95ef6c8f-429f-4787-9e0b-f812d9f9720a",     "Authorizable": "G_442a991b-598c-4a69-ae75-250658812cc9",     "ParentActivityStructure": "G_b3fcce28-ab56-4eb2-952e-6d14c597b70a",     "ActivityStructure": "G_3def36c7-3e55-4cc0-b444-98f3d7d232a5",     "Authorization": "G_a9f6f91d-cb0b-47d5-8162-f3039031ba1c",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9507106",     "RecertificationAfter": "2026-06-06T10:38:47.9507106",     "DateCompleted": "2026-06-06T10:38:47.9507106",     "DateStarted": "2026-06-06T10:38:47.9507106",     "Status": null,     "Result": "E_d4cc4796-acc5-478e-a36a-3ba6600770cb"   }   ,   {     "Type": "report.program.result",     "ParentAuthorizable": "G_95ef6c8f-429f-4787-9e0b-f812d9f9720a",     "Authorizable": "G_442a991b-598c-4a69-ae75-250658812cc9",     "ParentActivityStructure": "G_b3fcce28-ab56-4eb2-952e-6d14c597b70a",     "ActivityStructure": "G_3def36c7-3e55-4cc0-b444-98f3d7d232a5",     "Authorization": "G_a9f6f91d-cb0b-47d5-8162-f3039031ba1c",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9507106",     "RecertificationAfter": "2026-06-06T10:38:47.9507106",     "DateCompleted": "2026-06-06T10:38:47.9507106",     "DateStarted": "2026-06-06T10:38:47.9507106",     "Status": null,     "Result": "E_d4cc4796-acc5-478e-a36a-3ba6600770cb",     "StatusRules": true,     "StatusProgress": null   } ] 

TODOS

Authorizables can have TODOS on ActivityStructures, this means that all persons that are direct or indirect member of the Authorizable have access to the ActivityStructure

AddPortfolio

bool

readwrite request

Filter not supported

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

EndDate

date

readwrite default

ISO date format

Filter not supported

string

readonly always

Unique

Available filter operations: EQUALS

Mandatory

bool

readwrite request

Available filter operations: EQUALS,NOT_EQUALS

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

string

immutable default expandable

Available filter operations: EQUALS

ID of an Authorizable

string

immutable default expandable

Available filter operations: EQUALS

ID of an Entity

Recommended

bool

readwrite request

Available filter operations: EQUALS,NOT_EQUALS

StartDate

date

readwrite default

ISO date format

Filter not supported

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

The todo object
12345678910111213141516
{   "AddPortfolio": null,   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9663409",   "EndDate": "2026-01-01T00:00:00",   "ID": "G_a229b46d-6b5e-4294-a444-c2b961c710fd",   "Mandatory": null,   "ModifiedDate": "2026-06-06T10:38:47.9663409",   "Of": "G_5a25d559-2dd7-4669-8475-41905ce98caa",   "On": "G_820b09b7-0944-41d4-975f-f69baf90bb9f",   "Recommended": null,   "StartDate": "2026-01-01T00:00:00",   "Tag": "",   "Type": "TODOS" } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/todos

Creates a new todo.

Request body

AddPortfolio

bool

optional

EndDate

date

optional

ISO date format

Mandatory

bool

optional

string

required

ID of an Authorizable

string

required

ID of an Entity

Recommended

bool

optional

StartDate

date

optional

ISO date format

Tag

string

optional

Max 100 chars

Returns

The newly created todo object.

Example request
1234567891011121314
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/todos \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "AddPortfolio": null,   "EndDate": "2026-01-01T00:00:00",   "Mandatory": null,   "Of": "G_5a25d559-2dd7-4669-8475-41905ce98caa",   "On": "G_820b09b7-0944-41d4-975f-f69baf90bb9f",   "Recommended": null,   "StartDate": "2026-01-01T00:00:00",   "Tag": "" }' 

Response
12345678910111213141516
{   "AddPortfolio": null,   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9663409",   "EndDate": "2026-01-01T00:00:00",   "ID": "G_a229b46d-6b5e-4294-a444-c2b961c710fd",   "Mandatory": null,   "ModifiedDate": "2026-06-06T10:38:47.9663409",   "Of": "G_5a25d559-2dd7-4669-8475-41905ce98caa",   "On": "G_820b09b7-0944-41d4-975f-f69baf90bb9f",   "Recommended": null,   "StartDate": "2026-01-01T00:00:00",   "Tag": "",   "Type": "TODOS" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/todos

Returns a list of todos.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of todo objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/todos \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
1234567891011121314151617
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "EndDate": "2026-01-01T00:00:00",       "ID": "G_a229b46d-6b5e-4294-a444-c2b961c710fd",       "Of": "G_5a25d559-2dd7-4669-8475-41905ce98caa",       "On": "G_820b09b7-0944-41d4-975f-f69baf90bb9f",       "StartDate": "2026-01-01T00:00:00",       "Tag": "",       "Type": "TODOS"     }   ]   "Date": "2026-06-06T10:38:48.0132222", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/todos/{todo_id}

Retrieves a todo.

Path parameters

todo_id

string

required

ID of the todo to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The todo object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/todos/g_a229b46d-6b5e-4294-a444-c2b961c710fd \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456789
{   "EndDate": "2026-01-01T00:00:00",   "ID": "G_a229b46d-6b5e-4294-a444-c2b961c710fd",   "Of": "G_5a25d559-2dd7-4669-8475-41905ce98caa",   "On": "G_820b09b7-0944-41d4-975f-f69baf90bb9f",   "StartDate": "2026-01-01T00:00:00",   "Tag": "",   "Type": "TODOS" } 

PUT https://genapiv1.growsparks.com/rest/genapiv1/v1/todos/{todo_id}

Modifies a todo.

Path parameters

todo_id

string

required

ID of the todo to modify.

Request body

AddPortfolio

bool

optional

EndDate

date

optional

ISO date format

Mandatory

bool

optional

Recommended

bool

optional

StartDate

date

optional

ISO date format

Tag

string

optional

Max 100 chars

Returns

The modified todo object.

Example request
123456789101112
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/todos/g_a229b46d-6b5e-4294-a444-c2b961c710fd \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X PUT \   -d '{   "AddPortfolio": null,   "EndDate": "2026-01-01T00:00:00",   "Mandatory": null,   "Recommended": null,   "StartDate": "2026-01-01T00:00:00",   "Tag": "" }' 

Response
12345678910111213141516
{   "AddPortfolio": null,   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9663409",   "EndDate": "2026-01-01T00:00:00",   "ID": "G_a229b46d-6b5e-4294-a444-c2b961c710fd",   "Mandatory": null,   "ModifiedDate": "2026-06-06T10:38:47.9663409",   "Of": "G_5a25d559-2dd7-4669-8475-41905ce98caa",   "On": "G_820b09b7-0944-41d4-975f-f69baf90bb9f",   "Recommended": null,   "StartDate": "2026-01-01T00:00:00",   "Tag": "",   "Type": "TODOS" } 

DELETE https://genapiv1.growsparks.com/rest/genapiv1/v1/todos/{todo_id}

Deletes a todo.

Path parameters

todo_id

string

required

ID of the todo to delete.

Returns

Nothing

Example request
1234
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/todos/g_a229b46d-6b5e-4294-a444-c2b961c710fd \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X DELETE 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/todos/{todo_id}/.report

Path parameters

todo_id

string

required

ID of the todo on which the call is applied.

Query parameters

stream

boolean

optional

Stream results using Server-Sent Events

Request body

ActivityAttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Only include specific attempts

ActivityStructures

array of strings

optional

IDs of activity structures

Authorizables

array of strings

optional

IDs of authorizables

DeltaDate

date

optional

ISO date format

Only include results after date

IncludeActivities

bool

optional

Add results on each activity to the output

IncludeGroupSummary

bool

optional

Add summaries of person groups to the output

IncludeIntermediateActivityStructures

bool

optional

Include intermediate ActivityStructures

IncludeNotAttempted

bool

optional

Include not attempted results

IncludeParentActivityStructure

bool

optional

Include ID of Parent ActivityStructure

IncludeParentAuthorizable

bool

optional

Include ID of Parent Authorizable

IncludePersons

bool

optional

Add individual results to the output

IncludeProgramSummary

bool

optional

Add calculated program status to the output

IncludeResultDetails

bool

optional

Add details of answered questions to the output

ProgramSummaryAttemptMode

enum

optional

Allowed values: First, Best, LastCompleted, Last, All, FirstCompleted

Setting used for program status calculation

ReferenceDate

date

optional

ISO date format

Only include results before date

Verbose

bool

optional

Add messages to the output

Response body

enumeration of ProgressReportingBaseResults

The ProgressReportingBaseResult object (abstract)

Base class for report entries

Type

string

The ProgressReportingMessage object (inherits from ProgressReportingBaseResult)

Progress or logging during reporting

Type = report.message

Message

string

DateTime

date

ISO date format

Current time stamp

The ProgressReportingDone object (inherits from ProgressReportingBaseResult)

Indicates that reporting finished successfully

Type = report.finished

DeltaDate

date

ISO date format

ReferenceDate

date

ISO date format

This date can be used for next delta

The ProgressReportingBaseResultLine object (abstract) (inherits from ProgressReportingBaseResult)

Base class for report results

ParentAuthorizable

string

expandable

ID of an Authorizable

Authorizable

string

expandable

ID of an Authorizable

ParentActivityStructure

string

expandable

ID of an ActivityStructure

ActivityStructure

string

expandable

ID of an ActivityStructure

Authorization

string

expandable

ID of an Authorization

ContentTime

integer

Progress

float

NormalizedScore

float

ValidUntil

date

ISO date format

Certificate activities only

RecertificationAfter

date

ISO date format

Certificate activities only

The ProgressReportingGroupResult object (inherits from ProgressReportingBaseResultLine)

Summary of an Activity for a PersonGroup

Type = report.activity.summary

ResultCount

integer

NotStarted

integer

Started

integer

Completed

integer

Passed

integer

Failed

integer

The ProgressReportingGroupProgramResult object (inherits from ProgressReportingGroupResult)

Summary of an ActivityStructure for a PersonGroup

Type = report.program.summary

StatusRules

bool

StatusProgress

float

The ProgressReportingResult object (inherits from ProgressReportingBaseResultLine)

Result of a Person on an Activity

Type = report.activity.result

DateCompleted

date

ISO date format

DateStarted

date

ISO date format

Status

integer

Allowed values: NotStarted (0), Busy (1), Pending (10), Done (20), Failed (30), Passed (40), NotAssigned (-1)

Result

string

ID of an ActivityResult

The ProgressReportingProgramResult object (inherits from ProgressReportingResult)

Result of a Person on an ActivityGroup

Type = report.program.result

StatusRules

bool

StatusProgress

float

Example request
12345678910111213141516171819202122
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/todos/g_a229b46d-6b5e-4294-a444-c2b961c710fd/.report \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "ActivityAttemptMode": "All",   "ActivityStructures": null,   "Authorizables": null,   "DeltaDate": null,   "IncludeActivities": true,   "IncludeGroupSummary": false,   "IncludeIntermediateActivityStructures": false,   "IncludeNotAttempted": false,   "IncludeParentActivityStructure": false,   "IncludeParentAuthorizable": false,   "IncludePersons": true,   "IncludeProgramSummary": false,   "IncludeResultDetails": false,   "ProgramSummaryAttemptMode": "Last",   "ReferenceDate": null,   "Verbose": false }' 

Example response
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
[   {     "Type": "report.message",     "Message": "Hello world",     "DateTime": "2026-06-06T10:38:47.9663409"   }   ,   {     "Type": "report.finished",     "DeltaDate": "2026-06-06T10:38:47.9663409",     "ReferenceDate": "2026-06-06T10:38:47.9663409"   }   ,   {     "Type": "report.activity.summary",     "ParentAuthorizable": "G_1ab9ce88-55cf-4d74-bd50-e4ad01ec129d",     "Authorizable": "G_574c0dda-7df1-4077-bb73-9c65558b385a",     "ParentActivityStructure": "G_f3c2ac3b-e3cd-41a8-8c6d-4de0ec2f75e7",     "ActivityStructure": "G_cceec10d-8de2-4493-ad5d-fbb25070f05d",     "Authorization": "G_c6c85f54-a764-4ac7-8176-480da4d8b338",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9663409",     "RecertificationAfter": "2026-06-06T10:38:47.9663409",     "ResultCount": 1,     "NotStarted": 2,     "Started": 1,     "Completed": 3,     "Passed": 1,     "Failed": 0   }   ,   {     "Type": "report.program.summary",     "ParentAuthorizable": "G_1ab9ce88-55cf-4d74-bd50-e4ad01ec129d",     "Authorizable": "G_574c0dda-7df1-4077-bb73-9c65558b385a",     "ParentActivityStructure": "G_f3c2ac3b-e3cd-41a8-8c6d-4de0ec2f75e7",     "ActivityStructure": "G_cceec10d-8de2-4493-ad5d-fbb25070f05d",     "Authorization": "G_c6c85f54-a764-4ac7-8176-480da4d8b338",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9663409",     "RecertificationAfter": "2026-06-06T10:38:47.9663409",     "ResultCount": 1,     "NotStarted": 2,     "Started": 1,     "Completed": 3,     "Passed": 1,     "Failed": 0,     "StatusRules": true,     "StatusProgress": null   }   ,   {     "Type": "report.activity.result",     "ParentAuthorizable": "G_1ab9ce88-55cf-4d74-bd50-e4ad01ec129d",     "Authorizable": "G_574c0dda-7df1-4077-bb73-9c65558b385a",     "ParentActivityStructure": "G_f3c2ac3b-e3cd-41a8-8c6d-4de0ec2f75e7",     "ActivityStructure": "G_cceec10d-8de2-4493-ad5d-fbb25070f05d",     "Authorization": "G_c6c85f54-a764-4ac7-8176-480da4d8b338",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9663409",     "RecertificationAfter": "2026-06-06T10:38:47.9663409",     "DateCompleted": "2026-06-06T10:38:47.9663409",     "DateStarted": "2026-06-06T10:38:47.9663409",     "Status": null,     "Result": "E_34b58af2-f131-4d96-9dae-0a701ead62da"   }   ,   {     "Type": "report.program.result",     "ParentAuthorizable": "G_1ab9ce88-55cf-4d74-bd50-e4ad01ec129d",     "Authorizable": "G_574c0dda-7df1-4077-bb73-9c65558b385a",     "ParentActivityStructure": "G_f3c2ac3b-e3cd-41a8-8c6d-4de0ec2f75e7",     "ActivityStructure": "G_cceec10d-8de2-4493-ad5d-fbb25070f05d",     "Authorization": "G_c6c85f54-a764-4ac7-8176-480da4d8b338",     "ContentTime": 60,     "Progress": null,     "NormalizedScore": null,     "ValidUntil": "2026-06-06T10:38:47.9663409",     "RecertificationAfter": "2026-06-06T10:38:47.9663409",     "DateCompleted": "2026-06-06T10:38:47.9663409",     "DateStarted": "2026-06-06T10:38:47.9663409",     "Status": null,     "Result": "E_34b58af2-f131-4d96-9dae-0a701ead62da",     "StatusRules": true,     "StatusProgress": null   } ] 

ActivityResults

Persons can have ActivityResults on Activities. Results keep track of score, progress and status.

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

Completed

bool

readonly request

Available filter operations: EQUALS,NOT_EQUALS

ContentTime

integer

readonly request

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

Time in seconds

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

DateCompleted

date

readonly default

ISO date format

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

string

readonly always

Unique

Available filter operations: EQUALS

MaxProgress

integer

readonly request

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

MaxScore

integer

readonly request

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

string

readonly default expandable

Available filter operations: EQUALS

ID of a Person

string

readonly default expandable

Available filter operations: EQUALS

ID of an Activity

Progress

integer

readonly request

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

ScaledScore

float

readonly request

Filter not supported

Time in seconds

Score

integer

readonly request

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

Status

enum

readonly default

Allowed values: NotStarted, Busy, Pending, Done, Failed, Passed, NotAssigned

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

The activity result object
1234567891011121314151617181920
{   "ClassID": "",   "ClassName": "",   "Completed": null,   "ContentTime": null,   "CreateDate": "2026-06-06T10:38:47.9350947",   "DateCompleted": null,   "ID": "E_f1811982-e22f-4524-abb0-3ba2edae2819",   "MaxProgress": null,   "MaxScore": null,   "ModifiedDate": "2026-06-06T10:38:47.9350947",   "Of": "G_1635fd60-e197-4f48-87c3-6506478095eb",   "On": "G_439e12c6-88dc-4837-a932-6439f07a9635",   "Progress": null,   "ScaledScore": null,   "Score": null,   "Status": null,   "Tag": "",   "Type": "ActivityResults" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/activityresults

Returns a list of activity results.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of activity result objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/activityresults \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
1234567891011121314151617
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "DateCompleted": null,       "ID": "E_f1811982-e22f-4524-abb0-3ba2edae2819",       "Of": "G_1635fd60-e197-4f48-87c3-6506478095eb",       "On": "G_439e12c6-88dc-4837-a932-6439f07a9635",       "Status": null,       "Tag": "",       "Type": "ActivityResults"     }   ]   "Date": "2026-06-06T10:38:48.0132222", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/activityresults/{activityresult_id}

Retrieves an activity result.

Path parameters

activityresult_id

string

required

ID of the activity result to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The activity result object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/activityresults/e_f1811982-e22f-4524-abb0-3ba2edae2819 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456789
{   "DateCompleted": null,   "ID": "E_f1811982-e22f-4524-abb0-3ba2edae2819",   "Of": "G_1635fd60-e197-4f48-87c3-6506478095eb",   "On": "G_439e12c6-88dc-4837-a932-6439f07a9635",   "Status": null,   "Tag": "",   "Type": "ActivityResults" } 

CertificateResults

Persons can have CertificateResults on Certificate Activities.

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

Completed

bool

readonly request

Available filter operations: EQUALS,NOT_EQUALS

ContentTime

integer

readonly request

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

Time in seconds

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

DateCompleted

date

readonly default

ISO date format

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

string

readonly always

Unique

Available filter operations: EQUALS

MaxProgress

integer

readonly request

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

MaxScore

integer

readonly request

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

string

readonly default expandable

Available filter operations: EQUALS

ID of a Person

string

readonly default expandable

Available filter operations: EQUALS

ID of an Activity

Progress

integer

readonly request

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

RecertificationAfter

date

readonly request

ISO date format

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

ScaledScore

float

readonly request

Filter not supported

Time in seconds

Score

integer

readonly request

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

Status

enum

readonly default

Allowed values: NotStarted, Busy, Pending, Done, Failed, Passed, NotAssigned

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

ValidUntil

date

readonly request

ISO date format

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

The certificate result object
12345678910111213141516171819202122
{   "ClassID": "",   "ClassName": "",   "Completed": null,   "ContentTime": null,   "CreateDate": "2026-06-06T10:38:47.9350947",   "DateCompleted": null,   "ID": "E_50a1a21f-dceb-495f-b509-913ff40e936d",   "MaxProgress": null,   "MaxScore": null,   "ModifiedDate": "2026-06-06T10:38:47.9350947",   "Of": "G_33c6d770-0a4a-4991-8b7a-b2d9846e50ce",   "On": "G_f136bbe4-90f5-49f3-9271-254e0c7296f8",   "Progress": null,   "RecertificationAfter": null,   "ScaledScore": null,   "Score": null,   "Status": null,   "Tag": "",   "Type": "CertificateResults",   "ValidUntil": null } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/certificateresults

Returns a list of certificate results.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of certificate result objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/certificateresults \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
1234567891011121314151617
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "DateCompleted": null,       "ID": "E_50a1a21f-dceb-495f-b509-913ff40e936d",       "Of": "G_33c6d770-0a4a-4991-8b7a-b2d9846e50ce",       "On": "G_f136bbe4-90f5-49f3-9271-254e0c7296f8",       "Status": null,       "Tag": "",       "Type": "CertificateResults"     }   ]   "Date": "2026-06-06T10:38:48.0132222", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/certificateresults/{certificateresult_id}

Retrieves a certificate result.

Path parameters

certificateresult_id

string

required

ID of the certificate result to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The certificate result object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/certificateresults/e_50a1a21f-dceb-495f-b509-913ff40e936d \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456789
{   "DateCompleted": null,   "ID": "E_50a1a21f-dceb-495f-b509-913ff40e936d",   "Of": "G_33c6d770-0a4a-4991-8b7a-b2d9846e50ce",   "On": "G_f136bbe4-90f5-49f3-9271-254e0c7296f8",   "Status": null,   "Tag": "",   "Type": "CertificateResults" } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/certificateresults/{certificateresult_id}/.downloadphysicalcertificate

Download PDF version of a certificate result

Path parameters

certificateresult_id

string

required

ID of the certificate result on which the call is applied.

Request body

Returns

Result of the call of type: RESTEnabledMethodDownload

Example request
123456
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/certificateresults/e_50a1a21f-dceb-495f-b509-913ff40e936d/.downloadphysicalcertificate \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{ }' 

Example response
1
null 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/certificateresults/.verifyqr

Verify a Certificate's QR code

Request body

Data

string

required

Returns

Result of the call of type: string

Example request
1234567
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/certificateresults/.verifyqr \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "Data": null }' 

Example response
1
null 

ClassroomTrainingResults

Persons can have ClassroomTrainingResults on Classroom Training Activities.

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

Completed

bool

readonly request

Available filter operations: EQUALS,NOT_EQUALS

ContentTime

integer

readonly request

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

Time in seconds

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

DateCompleted

date

readonly default

ISO date format

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

string

readonly always

Unique

Available filter operations: EQUALS

MaxProgress

integer

readonly request

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

MaxScore

integer

readonly request

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

NotCompleted

bool

readonly request

Available filter operations: EQUALS,NOT_EQUALS

string

readonly default expandable

Available filter operations: EQUALS

ID of a Person

string

readonly default expandable

Available filter operations: EQUALS

ID of an Activity

Progress

integer

readonly request

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

ScaledScore

float

readonly request

Filter not supported

Time in seconds

Score

integer

readonly request

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

Status

enum

readonly default

Allowed values: NotStarted, Busy, Pending, Done, Failed, Passed, NotAssigned

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

The classroom training result object
123456789101112131415161718192021
{   "ClassID": "",   "ClassName": "",   "Completed": null,   "ContentTime": null,   "CreateDate": "2026-06-06T10:38:47.9507106",   "DateCompleted": null,   "ID": "E_f5bb00fd-f595-4169-8cbb-ccc8012d2cfd",   "MaxProgress": null,   "MaxScore": null,   "ModifiedDate": "2026-06-06T10:38:47.9507106",   "NotCompleted": null,   "Of": "G_b42b665a-d5a3-486d-89f7-097b7ac3804e",   "On": "G_571fc8cb-c8be-45f8-92a2-02fec0995038",   "Progress": null,   "ScaledScore": null,   "Score": null,   "Status": null,   "Tag": "",   "Type": "ClassroomTrainingResults" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/classroomtrainingresults

Returns a list of classroom training results.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of classroom training result objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/classroomtrainingresults \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
1234567891011121314151617
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "DateCompleted": null,       "ID": "E_f5bb00fd-f595-4169-8cbb-ccc8012d2cfd",       "Of": "G_b42b665a-d5a3-486d-89f7-097b7ac3804e",       "On": "G_571fc8cb-c8be-45f8-92a2-02fec0995038",       "Status": null,       "Tag": "",       "Type": "ClassroomTrainingResults"     }   ]   "Date": "2026-06-06T10:38:48.0132222", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/classroomtrainingresults/{classroomtrainingresult_id}

Retrieves a classroom training result.

Path parameters

classroomtrainingresult_id

string

required

ID of the classroom training result to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The classroom training result object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/classroomtrainingresults/e_f5bb00fd-f595-4169-8cbb-ccc8012d2cfd \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456789
{   "DateCompleted": null,   "ID": "E_f5bb00fd-f595-4169-8cbb-ccc8012d2cfd",   "Of": "G_b42b665a-d5a3-486d-89f7-097b7ac3804e",   "On": "G_571fc8cb-c8be-45f8-92a2-02fec0995038",   "Status": null,   "Tag": "",   "Type": "ClassroomTrainingResults" } 

Attendance

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

ExecutionSession

string

readonly default expandable

Available filter operations: EQUALS

ID of an ExecutionSession

string

readonly always

Unique

Available filter operations: EQUALS

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Note

string

readonly request

Filter not supported

Present

bool

readonly default

Available filter operations: EQUALS,NOT_EQUALS

Subscription

string

readonly default expandable

Available filter operations: EQUALS

ID of a Subscription

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

The attendance object
12345678910111213
{   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9350947",   "ExecutionSession": "G_7c440dac-2e95-4500-8a34-e39485edc976",   "ID": "G_e869e9a5-79bb-417d-974a-2c261aa1d8b8",   "ModifiedDate": "2026-06-06T10:38:47.9350947",   "Note": null,   "Present": null,   "Subscription": "G_77f185eb-ed32-4985-9d9c-9c6a6a39569f",   "Tag": "",   "Type": "Attendance" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/attendance

Returns a list of attendance.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of attendance objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/attendance \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
12345678910111213141516
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "ExecutionSession": "G_7c440dac-2e95-4500-8a34-e39485edc976",       "ID": "G_e869e9a5-79bb-417d-974a-2c261aa1d8b8",       "Present": null,       "Subscription": "G_77f185eb-ed32-4985-9d9c-9c6a6a39569f",       "Tag": "",       "Type": "Attendance"     }   ]   "Date": "2026-06-06T10:38:48.0132222", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/attendance/{attendance_id}

Retrieves an attendance.

Path parameters

attendance_id

string

required

ID of the attendance to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The attendance object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/attendance/g_e869e9a5-79bb-417d-974a-2c261aa1d8b8 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
12345678
{   "ExecutionSession": "G_7c440dac-2e95-4500-8a34-e39485edc976",   "ID": "G_e869e9a5-79bb-417d-974a-2c261aa1d8b8",   "Present": null,   "Subscription": "G_77f185eb-ed32-4985-9d9c-9c6a6a39569f",   "Tag": "",   "Type": "Attendance" } 

Executions

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

ClassroomTraining

string

readonly default expandable

Available filter operations: EQUALS,PATH_TO_ROOT,SUB_TREE,MEMBER_OF

ID of a ClassroomTraining

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Description

string

readonly default

Formatting allowed

Filter not supported

ExecutionStatus

enum

readonly default

Allowed values: Prepare, Definite, Cancelled, Invisible

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

string

readonly always

Unique

Available filter operations: EQUALS

Language

string

readonly default

ISO language code

Filter not supported

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Sessions

array of strings

readonly request expandable

IDs of Entities

Filter not supported

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

The execution object
1234567891011121314
{   "ClassID": "",   "ClassName": "",   "ClassroomTraining": "G_f31bf980-2076-4214-a150-88447ec0900b",   "CreateDate": "2026-06-06T10:38:47.9507106",   "Description": null,   "ExecutionStatus": "Definite",   "ID": "G_a0fd44cd-4f70-4223-a08f-04d8a7d127e6",   "Language": "en",   "ModifiedDate": "2026-06-06T10:38:47.9507106",   "Sessions": ["G_00ea82bc-2083-454f-ae1d-354edb588dfb"],   "Tag": "",   "Type": "Executions" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/executions

Returns a list of executions.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of execution objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/executions \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
1234567891011121314151617
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "ClassroomTraining": "G_f31bf980-2076-4214-a150-88447ec0900b",       "Description": null,       "ExecutionStatus": "Definite",       "ID": "G_a0fd44cd-4f70-4223-a08f-04d8a7d127e6",       "Language": "en",       "Tag": "",       "Type": "Executions"     }   ]   "Date": "2026-06-06T10:38:48.0132222", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/executions/{execution_id}

Retrieves an execution.

Path parameters

execution_id

string

required

ID of the execution to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The execution object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/executions/g_a0fd44cd-4f70-4223-a08f-04d8a7d127e6 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456789
{   "ClassroomTraining": "G_f31bf980-2076-4214-a150-88447ec0900b",   "Description": null,   "ExecutionStatus": "Definite",   "ID": "G_a0fd44cd-4f70-4223-a08f-04d8a7d127e6",   "Language": "en",   "Tag": "",   "Type": "Executions" } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/executions/{execution_id}/.subscribe

Path parameters

execution_id

string

required

ID of the execution on which the call is applied.

Request body

Person

string

required

ID of a person

Returns

Result of the call of type: string

Example request
1234567
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/executions/g_a0fd44cd-4f70-4223-a08f-04d8a7d127e6/.subscribe \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "Person": "G_bb8cb79e-804f-4517-abab-065c58d1b457" }' 

Example response
1
null 

ExecutionSessions

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

EndTime

date

readonly default

ISO date format

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

Execution

string

readonly default expandable

Available filter operations: EQUALS

string

readonly always

Unique

Available filter operations: EQUALS

Location

string

readonly default expandable

Available filter operations: EQUALS,PATH_TO_ROOT,SUB_TREE,MEMBER_OF

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

StartTime

date

readonly default

ISO date format

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

SubLocation

string

readonly default expandable

Available filter operations: EQUALS,PATH_TO_ROOT,SUB_TREE,MEMBER_OF

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Teachers

array of strings

readonly request expandable

IDs of Entities

Filter not supported

Type

string

readonly default

Filter not supported

The execution session object
123456789101112131415
{   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9507106",   "EndTime": null,   "Execution": "G_4bee2447-f95f-459c-87ea-de147f4f2a04",   "ID": "G_cbeced62-221a-4ab7-bb81-b1da365106fa",   "Location": "G_0e9bc916-e425-4f6b-866f-e845a2a9bf75",   "ModifiedDate": "2026-06-06T10:38:47.9507106",   "StartTime": null,   "SubLocation": "G_d7367366-7ebe-452d-8040-4eda7a9b2b90",   "Tag": "",   "Teachers": ["G_ba5cde5b-7946-4056-826e-006f072fa954"],   "Type": "ExecutionSessions" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/executionsessions

Returns a list of execution sessions.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of execution session objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/executionsessions \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456789101112131415161718
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "EndTime": null,       "Execution": "G_4bee2447-f95f-459c-87ea-de147f4f2a04",       "ID": "G_cbeced62-221a-4ab7-bb81-b1da365106fa",       "Location": "G_0e9bc916-e425-4f6b-866f-e845a2a9bf75",       "StartTime": null,       "SubLocation": "G_d7367366-7ebe-452d-8040-4eda7a9b2b90",       "Tag": "",       "Type": "ExecutionSessions"     }   ]   "Date": "2026-06-06T10:38:48.0132222", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/executionsessions/{executionsession_id}

Retrieves an execution session.

Path parameters

executionsession_id

string

required

ID of the execution session to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The execution session object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/executionsessions/g_cbeced62-221a-4ab7-bb81-b1da365106fa \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
12345678910
{   "EndTime": null,   "Execution": "G_4bee2447-f95f-459c-87ea-de147f4f2a04",   "ID": "G_cbeced62-221a-4ab7-bb81-b1da365106fa",   "Location": "G_0e9bc916-e425-4f6b-866f-e845a2a9bf75",   "StartTime": null,   "SubLocation": "G_d7367366-7ebe-452d-8040-4eda7a9b2b90",   "Tag": "",   "Type": "ExecutionSessions" } 

ExecutionSessionTeachers

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Deleted

bool

readwrite default

Available filter operations: EQUALS

ExecutionSession

string

readonly default expandable

Available filter operations: EQUALS

ID of an ExecutionSession

string

readonly always

Unique

Available filter operations: EQUALS

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Person

string

readonly default expandable

Available filter operations: EQUALS

ID of a Person

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

The execution session teacher object
123456789101112
{   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9507106",   "Deleted": false,   "ExecutionSession": "G_05e515d7-7d68-4c40-8abb-54cec42a675a",   "ID": "G_0704de0f-5e3b-4623-b00f-ec7abd3f6cf2",   "ModifiedDate": "2026-06-06T10:38:47.9507106",   "Person": "G_553c44b5-eeaa-4044-ad2e-dfe984dd4c37",   "Tag": "",   "Type": "ExecutionSessionTeachers" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/executionsessionteachers

Returns a list of execution session teachers.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of execution session teacher objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/executionsessionteachers \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
12345678910111213141516
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "Deleted": false,       "ExecutionSession": "G_05e515d7-7d68-4c40-8abb-54cec42a675a",       "ID": "G_0704de0f-5e3b-4623-b00f-ec7abd3f6cf2",       "Person": "G_553c44b5-eeaa-4044-ad2e-dfe984dd4c37",       "Tag": "",       "Type": "ExecutionSessionTeachers"     }   ]   "Date": "2026-06-06T10:38:48.0132222", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/executionsessionteachers/{executionsessionteacher_id}

Retrieves an execution session teacher.

Path parameters

executionsessionteacher_id

string

required

ID of the execution session teacher to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The execution session teacher object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/executionsessionteachers/g_0704de0f-5e3b-4623-b00f-ec7abd3f6cf2 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
12345678
{   "Deleted": false,   "ExecutionSession": "G_05e515d7-7d68-4c40-8abb-54cec42a675a",   "ID": "G_0704de0f-5e3b-4623-b00f-ec7abd3f6cf2",   "Person": "G_553c44b5-eeaa-4044-ad2e-dfe984dd4c37",   "Tag": "",   "Type": "ExecutionSessionTeachers" } 

Locations

Address

string

readonly default

Max 255 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Available

bool

readonly default

Available filter operations: EQUALS,NOT_EQUALS

City

string

readonly default

Max 255 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

Country

string

readonly default

Max 255 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Description

string

readonly default

Formatting allowed

Filter not supported

string

readonly always

Unique

Available filter operations: EQUALS

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Name

string

readonly default

Max 255 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Phone

string

readonly default

Max 255 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

ZipCode

string

readonly default

Formatting allowed

Filter not supported

The location object
1234567891011121314151617
{   "Address": null,   "Available": null,   "City": null,   "ClassID": "",   "ClassName": "",   "Country": null,   "CreateDate": "2026-06-06T10:38:47.9507106",   "Description": null,   "ID": "G_f21a4cbd-60fa-4014-949a-940b610a5dac",   "ModifiedDate": "2026-06-06T10:38:47.9507106",   "Name": null,   "Phone": null,   "Tag": "",   "Type": "Locations",   "ZipCode": null } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/locations

Returns a list of locations.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of location objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/locations \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456789101112131415161718192021
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "Address": null,       "Available": null,       "City": null,       "Country": null,       "Description": null,       "ID": "G_f21a4cbd-60fa-4014-949a-940b610a5dac",       "Name": null,       "Phone": null,       "Tag": "",       "Type": "Locations",       "ZipCode": null     }   ]   "Date": "2026-06-06T10:38:48.0132222", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/locations/{location_id}

Retrieves a location.

Path parameters

location_id

string

required

ID of the location to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The location object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/locations/g_f21a4cbd-60fa-4014-949a-940b610a5dac \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
12345678910111213
{   "Address": null,   "Available": null,   "City": null,   "Country": null,   "Description": null,   "ID": "G_f21a4cbd-60fa-4014-949a-940b610a5dac",   "Name": null,   "Phone": null,   "Tag": "",   "Type": "Locations",   "ZipCode": null } 

SubLocations

Available

bool

readonly default

Available filter operations: EQUALS,NOT_EQUALS

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Description

string

readonly default

Formatting allowed

Filter not supported

string

readonly always

Unique

Available filter operations: EQUALS

MaxPlaces

integer

readonly default

Filter not supported

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

The sub location object
123456789101112
{   "Available": null,   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9663409",   "Description": null,   "ID": "G_3b11b5cd-720c-4109-bf5d-f3d5fd542fc7",   "MaxPlaces": null,   "ModifiedDate": "2026-06-06T10:38:47.9663409",   "Tag": "",   "Type": "SubLocations" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/sublocations

Returns a list of sub locations.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of sub location objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/sublocations \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
12345678910111213141516
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "Available": null,       "Description": null,       "ID": "G_3b11b5cd-720c-4109-bf5d-f3d5fd542fc7",       "MaxPlaces": null,       "Tag": "",       "Type": "SubLocations"     }   ]   "Date": "2026-06-06T10:38:48.0132222", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/sublocations/{sublocation_id}

Retrieves a sub location.

Path parameters

sublocation_id

string

required

ID of the sub location to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The sub location object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/sublocations/g_3b11b5cd-720c-4109-bf5d-f3d5fd542fc7 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
12345678
{   "Available": null,   "Description": null,   "ID": "G_3b11b5cd-720c-4109-bf5d-f3d5fd542fc7",   "MaxPlaces": null,   "Tag": "",   "Type": "SubLocations" } 

Subscriptions

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Deleted

bool

readwrite default

Available filter operations: EQUALS

Execution

string

readonly default expandable

Available filter operations: EQUALS

ID of an Execution

string

readonly always

Unique

Available filter operations: EQUALS

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Result

string

readonly default

Available filter operations: EQUALS

ID of an ActivityResult

SubscriptionStatus

enum

readonly default

Allowed values: NotApproved, Approved, Declined

Available filter operations: GREATER,SMALLER,GREATER_EQUAL,SMALLER_EQUAL,EQUALS,NOT_EQUALS

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

The subscription object
12345678910111213
{   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9663409",   "Deleted": false,   "Execution": "G_9c9393cf-4129-4fea-b1e8-90bde80958ff",   "ID": "G_9ed3c36b-f377-41c2-a42f-42b108a12d9f",   "ModifiedDate": "2026-06-06T10:38:47.9663409",   "Result": "E_67d0d3a3-f94f-42e4-a959-eba33b7439b9",   "SubscriptionStatus": null,   "Tag": "",   "Type": "Subscriptions" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/subscriptions

Returns a list of subscriptions.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of subscription objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/subscriptions \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
1234567891011121314151617
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "Deleted": false,       "Execution": "G_9c9393cf-4129-4fea-b1e8-90bde80958ff",       "ID": "G_9ed3c36b-f377-41c2-a42f-42b108a12d9f",       "Result": "E_67d0d3a3-f94f-42e4-a959-eba33b7439b9",       "SubscriptionStatus": null,       "Tag": "",       "Type": "Subscriptions"     }   ]   "Date": "2026-06-06T10:38:48.0132222", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/subscriptions/{subscription_id}

Retrieves a subscription.

Path parameters

subscription_id

string

required

ID of the subscription to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The subscription object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/subscriptions/g_9ed3c36b-f377-41c2-a42f-42b108a12d9f \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456789
{   "Deleted": false,   "Execution": "G_9c9393cf-4129-4fea-b1e8-90bde80958ff",   "ID": "G_9ed3c36b-f377-41c2-a42f-42b108a12d9f",   "Result": "E_67d0d3a3-f94f-42e4-a959-eba33b7439b9",   "SubscriptionStatus": null,   "Tag": "",   "Type": "Subscriptions" } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/subscriptions/{subscription_id}/.unsubscribe

Path parameters

subscription_id

string

required

ID of the subscription on which the call is applied.

Request body

Returns

Result of the call of type: string

Example request
123456
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/subscriptions/g_9ed3c36b-f377-41c2-a42f-42b108a12d9f/.unsubscribe \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{ }' 

Example response
1
null 

TagCategories

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

string

readonly always

Unique

Available filter operations: EQUALS

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Name

string

readwrite default

Max 255 chars

Filter not supported

Owner

string

readonly default expandable

Available filter operations: EQUALS

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

The tag category object
1234567891011
{   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9663409",   "ID": "G_0d66d648-2ee3-491d-8c36-6a194c76ce71",   "ModifiedDate": "2026-06-06T10:38:47.9663409",   "Name": null,   "Owner": "G_753ad6be-f6e0-4ac4-b407-c36413db427a",   "Tag": "",   "Type": "TagCategories" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/tagcategories

Returns a list of tag categories.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of tag category objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/tagcategories \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456789101112131415
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "ID": "G_0d66d648-2ee3-491d-8c36-6a194c76ce71",       "Name": null,       "Owner": "G_753ad6be-f6e0-4ac4-b407-c36413db427a",       "Tag": "",       "Type": "TagCategories"     }   ]   "Date": "2026-06-06T10:38:48.0132222", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/tagcategories/{tagcategory_id}

Retrieves a tag category.

Path parameters

tagcategory_id

string

required

ID of the tag category to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The tag category object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/tagcategories/g_0d66d648-2ee3-491d-8c36-6a194c76ce71 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
1234567
{   "ID": "G_0d66d648-2ee3-491d-8c36-6a194c76ce71",   "Name": null,   "Owner": "G_753ad6be-f6e0-4ac4-b407-c36413db427a",   "Tag": "",   "Type": "TagCategories" } 

TagCollections

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

string

readonly always

Unique

Available filter operations: EQUALS

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Owner

string

readonly default expandable

Available filter operations: EQUALS

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Type

string

readonly default

Filter not supported

The tag collection object
12345678910
{   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9663409",   "ID": "G_e23cd7bd-9253-4cf2-b0f2-86a705c41b42",   "ModifiedDate": "2026-06-06T10:38:47.9663409",   "Owner": "G_4aa75f98-6399-492b-8fd9-deba9c97d6d2",   "Tag": "",   "Type": "TagCollections" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/tagcollections

Returns a list of tag collections.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of tag collection objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/tagcollections \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
1234567891011121314
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "ID": "G_e23cd7bd-9253-4cf2-b0f2-86a705c41b42",       "Owner": "G_4aa75f98-6399-492b-8fd9-deba9c97d6d2",       "Tag": "",       "Type": "TagCollections"     }   ]   "Date": "2026-06-06T10:38:48.0132222", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/tagcollections/{tagcollection_id}

Retrieves a tag collection.

Path parameters

tagcollection_id

string

required

ID of the tag collection to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The tag collection object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/tagcollections/g_e23cd7bd-9253-4cf2-b0f2-86a705c41b42 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456
{   "ID": "G_e23cd7bd-9253-4cf2-b0f2-86a705c41b42",   "Owner": "G_4aa75f98-6399-492b-8fd9-deba9c97d6d2",   "Tag": "",   "Type": "TagCollections" } 

TagLinks

ClassID

integer

readonly request

Available filter operations: EQUALS

ClassName

string

readonly request

Available filter operations: EQUALS

CreateDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

string

readonly always

Unique

Available filter operations: EQUALS

ModifiedDate

date

readonly request

ISO date format

Available filter operations: GREATER_EQUAL,SMALLER

Owner

string

readonly default expandable

Available filter operations: EQUALS

Tag

string

readwrite default

Max 100 chars

Available filter operations: EQUALS,CONTAINS,STARTS_WITH,ENDS_WITH

Tagged

string

readonly default expandable

Available filter operations: EQUALS

Type

string

readonly default

Filter not supported

The tag link object
1234567891011
{   "ClassID": "",   "ClassName": "",   "CreateDate": "2026-06-06T10:38:47.9663409",   "ID": "G_47291d7d-af5f-4fc9-9170-d5ec6723f232",   "ModifiedDate": "2026-06-06T10:38:47.9663409",   "Owner": "G_ce009e44-b530-467f-86da-b428eaf91230",   "Tag": "",   "Tagged": "G_c5fd8b0f-f706-4b4f-a904-475ed159a579",   "Type": "TagLinks" } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/taglinks

Returns a list of tag links.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of tag link objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/taglinks \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456789101112131415
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "ID": "G_47291d7d-af5f-4fc9-9170-d5ec6723f232",       "Owner": "G_ce009e44-b530-467f-86da-b428eaf91230",       "Tag": "",       "Tagged": "G_c5fd8b0f-f706-4b4f-a904-475ed159a579",       "Type": "TagLinks"     }   ]   "Date": "2026-06-06T10:38:48.0132222", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/taglinks/{taglink_id}

Retrieves a tag link.

Path parameters

taglink_id

string

required

ID of the tag link to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The tag link object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/taglinks/g_47291d7d-af5f-4fc9-9170-d5ec6723f232 \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
1234567
{   "ID": "G_47291d7d-af5f-4fc9-9170-d5ec6723f232",   "Owner": "G_ce009e44-b530-467f-86da-b428eaf91230",   "Tag": "",   "Tagged": "G_c5fd8b0f-f706-4b4f-a904-475ed159a579",   "Type": "TagLinks" } 

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

filter

comma separated list of property filters

optional

Filter the result set

expand

comma separated list of property names

optional

Expand specified properties

offset

number

optional

Index of first result

limit

number

optional

Maximum number of results returned (1-1000)

stream

boolean

optional

Stream results using Server-Sent Events (offset, limit parameters are ignored)

Returns

A list of scriptlet objects.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/scriptlets \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
123456789101112131415
{   "Offset": 0,   "Count": 1,   "HasMore": false,   "Items": [     {       "Description": null,       "ID": "G_6af32a71-c3e2-4f21-b2f3-e09d4ff2776f",       "Owner": "G_0a244cf0-6c3a-4295-aeab-c947ec5c897b",       "Tag": "",       "Type": "Scriptlets"     }   ]   "Date": "2026-06-06T10:38:48.0132222", } 

GET https://genapiv1.growsparks.com/rest/genapiv1/v1/scriptlets/{scriptlet_id}

Retrieves a scriptlet.

Path parameters

scriptlet_id

string

required

ID of the scriptlet to retrieve.

Query parameters

includedProperties

comma separated list of property names

optional

Add request properties to the default result set

excludedProperties

comma separated list of property names

optional

Remove default properties from the result set

specificProperties

comma separated list of property names

optional

Specify properties for the result set

expand

comma separated list of property names

optional

Expand specified properties

Returns

The scriptlet object with the specified id.

Example request
123
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/scriptlets/g_6af32a71-c3e2-4f21-b2f3-e09d4ff2776f \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" 

Response
1234567
{   "Description": null,   "ID": "G_6af32a71-c3e2-4f21-b2f3-e09d4ff2776f",   "Owner": "G_0a244cf0-6c3a-4295-aeab-c947ec5c897b",   "Tag": "",   "Type": "Scriptlets" } 

POST https://genapiv1.growsparks.com/rest/genapiv1/v1/scriptlets/{scriptlet_id}/.execute

Path parameters

scriptlet_id

string

required

ID of the scriptlet on which the call is applied.

Request body

Parameters

object

required

Returns

Result of the call of type: ExecuteScriptletResponse

Example request
1234567
curl https://genapiv1.growsparks.com/rest/genapiv1/v1/scriptlets/g_6af32a71-c3e2-4f21-b2f3-e09d4ff2776f/.execute \   -H "Content-Type: application/json" \   -H "Authorization: Bearer $FLOWSPARKS_API_KEY" \   -X POST \   -d '{   "Parameters": null }' 

Example response
1
null 