Data can be extracted from your project using the Firebird API.  Before data can be extracted, you will need to authenticate and obtain an Access Token. See Authenticating with the API for more details.


Once you have an Access Token, you can use it to fetch data from your project:


NOTE: Currently, only published data can be extracted from your Firebird project. See Understanding Published Data for more details.


The Firebird API has a number of URL endpoints that can be used for fetching this data:


URL
Description
https://flame.firebird.systems/api/published/project
Project details
https://flame.firebird.systems/api/published/submissions
Submissions, Papers, Abstracts, Symposia, Applications or any other type of submission.
https://flame.firebird.systems/api/published/contributors
Authors or any other type of contributor to a submission.
https://flame.firebird.systems/api/published/submissionContributors
Details of which authors/contributors are linked to which submissions.
https://flame.firebird.systems/api/published/attendees
Delegates and other attendees of your event.
https://flame.firebird.systems/api/published/programme
(Depreciated) The programme/diary/schedule for your event.
https://flame.firebird.systems/api/published/programmes
The programmes that have been published for your event.
https://flame.firebird.systems/api/published/entries
The individual entries in your programme.
https://flame.firebird.systems/api/published/entryLinkedObjects
Details of submissions, presenters etc linked to your programme entries
https://flame.firebird.systems/api/published/locations
The locations in your programme
https://flame.firebird.systems/api/published/participants
The participants in your programme e.g. Chairs, Key Speakers, Moderators, Co-Chairs etc
https://flame.firebird.systems/api/published/affiliations
Details of the organisations linked to by contributors
https://flame.firebird.systems/api/published/organisations
Details of the organisations
https://flame.firebird.systems/api/published/files/{id}
Fetch individual files by passing the Id of the file to the end point.


NOTE: The following example uses PostMan but you can use any suitable client.  

NOTE: The following example fetches submission data but you can use any of the URL endpoints listed above.


Create a new GET request with the following:




Request URL
https://flame.firebird.systems/api/published/submissions
Authorization
Bearer <Access Token>


Replace <Access Token> with your Access Token e.g.


Bearer abwx86zGt7AfMJBVh0wpDtRuiIZ_ngLxmpCzSTJbTpnid5r1hatgD4dcikiFU-J1RNfOLLTPrdgiD_3mYUjIZ732AXeT0Rbv9ef-w21Ohorfa3spcogNxMfSbPYzQnukyFcf5gsQ6GiyuherfVVKwbYxvmJljLcmNkedBGpv9Q35qbpS2Tkl2ZAbKfUkCnWj1rOcKnzkUnILfg45SIcxeCWjYMtmhqB7B9zTC0oFWSp7lHXQBrIjAIjurJBcGjTOLqFNeSgP4frtgAOxWLPDQGi8mCndjbAi-XugQC18yfA


Make sure the Authorization token is in the Header of the request and that the Body of the request is empty.

Click Send to fetch your data.


The Firebird API will return the requested data as JSON in a format similar to that displayed here:



All returned data includes Version information as follows:


DataVersion the current version number of the Publish Version that is currently available.  


SoftwareVersion is the current version of the API Software that is in use.  This is used to determine the structure of the JSON data.  The Software Version rarely changes but if it does change then the supplied JSON is likely to have a changed structure and you may need to update your client.


Both DataVersion and SoftwareVersion is available in the response header and the API Client can request just headers by using a HEAD request instead of a GET.  In this case, just the headers are returned which is useful when determining if the client has already got the latest version of the data. (See Checking for new Data)