Sparkwise Account API (1.1.0)
Download OpenAPI specification:
API for user synchronization, session cluster retrieval and participants completions.
Get available session clusters
Retrieves session clusters for the organization. Clusters with self-registration enabled include an iframe embed code for the signup form.
Authorizations:
query Parameters
| from | string <date-time> Example: from=2024-01-01T00:00:00Z Filter clusters created on or after this date, inclusive (ISO 8601 format) |
| to | string <date-time> Example: to=2024-12-31T00:00:00Z Filter clusters created before this date, exclusive (ISO 8601 format). Must be later than 'from' if both are provided. |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "success": true,
- "data": {
- "items": [
- {
- "clusterId": "e4dba565-5a00-450c-a3ea-3552c42f462c",
- "moduleId": "2e1b0aaa-e0e9-4284-babc-b2a8be20a625",
- "moduleName": "Effective Communication",
- "moduleCategory": "Leadership",
- "moduleThumbnailUrl": "string",
- "moduleDescription": "Communicate efficiently by stating the main point up front, followed by structured arguments",
- "duration": 60,
- "iframeCode": "<iframe src=\"...\" width=\"100%\" height=\"100%\"></iframe>"
}
], - "total": 5
}
}Get session completions
Retrieves participants' completion data.
Authorizations:
query Parameters
| from | string <date-time> Example: from=2024-01-01T00:00:00Z Filter completions for sessions that occurred on or after this date, inclusive (ISO 8601 format) |
| to | string <date-time> Example: to=2024-12-31T00:00:00Z Filter completions for sessions that occurred before this date, exclusive (ISO 8601 format). Must be later than 'from' if both are provided. |
Responses
Response samples
- 200
- 400
- 401
- 403
[- {
- "id": "526dc132-a881-4388-96aa-116db3722d31",
- "remoteUserId": "ext-user-123",
- "clusterId": "e4dba565-5a00-450c-a3ea-3552c42f462c",
- "moduleId": "2e1b0aaa-e0e9-4284-babc-b2a8be20a625",
- "moduleName": "Team Collaboration",
- "moduleCategory": "Teamwork",
- "moduleThumbnailUrl": "string",
- "moduleDescription": "Communicate efficiently by stating the main point up front, followed by structured arguments",
- "duration": 60,
- "attended": true,
- "sessionScheduledStartAt": "2024-06-15T14:00:00Z",
- "sessionScheduledEndAt": "2024-06-15T15:00:00Z",
- "participantFirstVisitedAt": "2024-06-15T14:02:00Z",
- "participantLastVisitedAt": "2024-06-15T14:55:00Z",
- "timeInSessionMins": 53,
- "stepsVisited": 8,
- "totalSteps": 10,
- "percentageStepsVisited": 80,
- "hash": "abc123def456"
}
]Get users
Retrieves a paginated list of users in the organization.
Authorizations:
query Parameters
| page | integer >= 0 Default: 0 Example: page=0 Page number (0-indexed) |
| pageSize | integer [ 1 .. 200 ] Default: 200 Example: pageSize=200 Number of users per page |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "success": true,
- "data": {
- "items": [
- {
- "id": "73efc9e34221297a1859a6d1f9e4128f1ea0747093a3777cf6f08b4a679364ce",
- "firstName": "John",
- "lastName": "Doe",
- "active": true,
- "remoteId": "remote-123"
}
], - "page": 0,
- "size": 200,
- "next": null,
- "prev": null,
- "totalPages": 1,
- "total": 5
}, - "error": null
}Batch upsert users
Creates or updates multiple users in the organization. Users that don't exist will be created, and users that already exist will be updated. Users not using trusted domains (if enabled) will not be created/updated.
Authorizations:
Request Body schema: application/jsonrequired
required | Array of objects (UserTemplate) [ 1 .. 200 ] items |
Responses
Request samples
- Payload
{- "users": [
- {
- "firstName": "John",
- "lastName": "Doe",
- "active": true,
- "remoteId": "remote-123"
}
]
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "success": true,
- "data": {
- "success": [
- {
- "id": "73efc9e34221297a1859a6d1f9e4128f1ea0747093a3777cf6f08b4a679364ce",
- "firstName": "John",
- "lastName": "Doe",
- "active": true,
- "remoteId": "remote-123"
}
], - "failed": [
- {
- "user": {
- "id": "73efc9e34221297a1859a6d1f9e4128f1ea0747093a3777cf6f08b4a679364ce",
- "firstName": "John",
- "lastName": "Doe",
- "active": true,
- "remoteId": "remote-123"
}, - "error": "This user cannot be processed"
}
]
}, - "error": null
}Batch deactivate users
Deactivates multiple users from the organization.
Authorizations:
Request Body schema: application/jsonrequired
required | Array of objects (UserRef) [ 1 .. 200 ] items |
Responses
Request samples
- Payload
{
}Response samples
- 400
- 401
- 403
- 500
{- "success": false,
- "error": {
- "message": "Error message",
- "metadata": { }
}, - "data": null
}