The FLOW API uses REST and returns JSON objects that can be parsed for the requested information unless otherwise noted.
This set of API endpoints will allow you to,
- Get information on all events
- Get information on registrants for specified events
- Get CSV reports on a specified past event
- Create a new barebones event
How to Use
All API requests will need to have an authentication header included. This comes in the form of an API secret key.
You can include the API key as part of your request header under the name api-secret, to authorize all requests. See the below section for information on finding your account's unique key.
Authentication (API Key/Secret)
Go to your Dashboard and navigate to the Account page. Click the "Show API Key" button under Account Settings to reveal your account's API key. It may take a brief moment to generate.
Note: As these keys are used to authenticate API requests and grant many privileges, make sure to keep them private. Be careful not to push the key to any public Git repositories or include them in any client code or documentation. Anyone with this API secret key will be able to use the APIs to manage its associated account.
GET Events List
curl -i -H "api-secret:xxxxxx" https://prod.flowapp.com/api/v1/events/sessions?period=current&simple_analytics=1
HEADERS
Name | Type | Description |
| api-secret | String | This is where you will put your secret API key |
PARAMS
Name | Type | Description |
| periodName | String | Can be "current", "past", or "future" depending on which events are desired If none specified, all sessions are returned |
| simple_analytics | set it to 1 |
GET Events Info
HEADERS
Name | Type | Description |
| api-secret | String | This is where you will put your secret API key |
PARAMS
Name | Type | Description |
| sessionToken | String | The unique identifier for the session you are trying to lookup. |
GET Events Info
HEADERS
Name | Type | Description |
| api-secret | String | This is where you will put your secret API key |
PARAMS
Name | Type | Description |
| sessionToken | String | The unique identifier for the session you are trying to lookup. |
RESPONSE PARAMETERS
Name | Type | Description |
| title | String | The event title provided on event creation. |
| description | String | The event description provided on event creation. |
| time | String | The time the event is set to take place. The timezone is stored separately. |
| published | Boolean | Whether the event is published, or still a draft. |
| eventToken | String | A unique identifier for the event. |
| timezone | String | The timezone set for the event. |
| duration | Number | The estimated duration of this event in hours. |
| earlyAccessPeriod | Number | The number of minutes before the scheduled event time where attendees can start joining. |
| creator | Object | An object with information on which user created this event. |
| token | String | A unique identifier for the event session. This is most often used with other APIs, as opposed to the eventToken. |
| date | String | The date the event is to take place. |
| createDate | String | The date this event was created. |
| refSources | Array | An array of reference sources this event uses. |
| operators | Array | A list of operators tied to this event, along with their roles. |
| accessStatus | Number | The status of access for this event. 1 indicates it is too early to access the event; 2 indicates the event is ongoing and open for access; 3 indicates that access is closed because it is a past event. |
| videoRecord | Boolean | Whether or not recording is enabled for this event. |
| privatizeChat | Boolean | Determines whether or not all attendees can view chat messages sent by other attendees. 0 indicates privatization is off; 1 indicates privatization is only on when the event is live; 2 indicates attendee chat messages are always hidden from other attendees. |
| emailMessage | String | An additional message appended to the end of reminder emails sent out to attendees. |
| hasQnA | Boolean | Whether or not this event has Q&A enabled. |
| useAdvancedQna | Boolean | Whether or not this event has advanced Q&A enabled. |
| redirectUrl | String | If present, this is a URL which attendees are redirected to after an event ends. |
| qnaPublicByDefault | Boolean | Whether or not the submitted questions for Q&A are public by default. |
| reminderOne | Number | The number of hours before the event in which the first reminder is sent. |
| reminderTwo | Number | The number of hours before the event in which the second reminder is sent. |
| hasRecording | Boolean | Whether or not the event has a recording logged. |
| questions | Array | Questions to be displayed on the event's registration page. |
POST Registration
CURL EXAMPLE
curl https://prod.flowapp.com/api/v1/registrants -i -X POST -H "Content-Type:application/json" -d '{"email":"jessepinkman@breakingbad.com", "firstName":"Jesse", "lastName":"Pinkman","eventSessionToken":"rGt3dC546xs"}'
REQUEST BODY
Name | Type | Description |
| email | String | The email address of the attendee to register. Please ensure this is correct, as the login information will be sent here. |
| firstName | String | The first name of the attendee to register. |
| lastName | String | The last name of the attendee to register. |
| eventSessionToken | String | The target event's unique identifier. |
| redirect | Boolean | Optional - If true, a redirect request to the login link will be sent. For SSO usage. |
GET Registrant List
curl -i -H "api-secret:xxxxxx" https://prod.flowapp.com/api/v1/reports/events/sessions/registrants/T35tT0K3n
HEADERS
Name | Type | Description |
| api-secret | String | This is where you will put your secret API key |
RESPONSE PARAMETERS
An array with user information.
POST Event Creation
HEADERS
Name | Type | Description |
| api-secret | String | This is where you will put your secret API key |
REQUEST BODY
Name | Type | Description |
| published | Boolean | Optional - Whether to publish an event or save it as a draft |
| creatorID | Number | The ID of the event creator. |
| title | String | The event title. |
| description | String | A description for the event, visible on the registration and access pages. |
| date | Boolean | The date the event will occur. Use YYYY-MM-DD format, as compliant with SQL. |
| time | String | The time the event will occur. Use 24 hour format, HH:MI:SS, as compliant with SQL. |
| timezone | String | A timezone compatible with MomentJS. For more information, see: https://momentjs.com/timezone/ |
| operators | Array | An array of objects representing the operators participating in the event. Required fields are the operator's ID, role (5: presenter, 10: organizer), and booleans for the following: micEnabled, camEnabled, screenSharingEnabled |
| duration | Number | Optional - Estimated duration of the event in hours. |
| earlyAccessPeriod | Boolean | Optional - Number of minutes before the scheduled event time which attendees can begin logging in. |
| videoRecord | Boolean | Optional - Whether or not the event should be recorded. |
| onDemandReplays | Boolean | Optional - Specify whether or not attendees can register to view replays after the event ended. |
| onDemandReplays | Boolean | Boolean |
GET Operator List
HEADERS
Name | Type | Description |
| api-secret | String | This is where you will put your secret API key |
RESPONSE PARAMETERS
Name | Type | Description |
| id | Number | The user ID number used with other API parameters. |
| email | String | The email address tied to the operator. |
| firstName | String | The operator's first name. |
| lastName | String | The operator's last name. |
| permission | Number | The operator's level of admin privileges. 10 denotes an administrator. |
GET Event Session Surveys
curl -i -H "api-secret:xxxxxx" https://prod.flowapp.com/api/v1/reports/events/sessions/surveys/T35tT0K3n
PARAMS
Name | Type | Description |
| sessionToken | String | The unique identifier for the session you are trying to lookup. |
HEADERS
Name | Type | Description |
| api-secret | String | This is where you will put your secret API key |
RESPONSE PARAMETERS
An array of data with survey information, most notably the id used to fetch survey response reports.
GET CSV Reports
Compiled Report
Registrants
Attendee Chat Log
Operator Chat Log
Survey Responses
CURL EXAMPLE
curl -i -H "api-secret:xxxxxx" https://prod.flowapp.com/api/v1/reports/events/sessions/csv/summary/T35tT0K3n
REQUEST PARAMETER
Name | Type | Description |
| sessionToken | String | The unique identifier for the session you are trying to lookup. |
RESPONSE PARAMETERS
Name | Type | Description |
| registrants | String | CSV data for the registrants, as you would get from the registrant CSV API. |
| operatorChat | String | CSV data for the operator chat, as you would get from the operator chat CSV API. |
| attendeeChat | String | CSV data for the attendee chat, as you would get from the attendee chat CSV API. |
| surveys | String | An object with key-value pairs of survey ID and survey responses. This will contain all surveys run in the session. |
Others
CSV Data will be returned with the requested information.
SSO
The SSO API allows for registration and redirection to the login link in one request. For example, it can be incorporated into a page in a login-protected area on your company site. See the registration API notes for the correct parameter to send.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article