How to manage studies and participants from a researcher account through the API

In this article we will provide information about using CogniFit’s API to manage the participants and studies.

It is now possible to have an API account while being a researcher. This allows researchers to use the API to create participants for their studies. Let’s see how to do this:

1. Create a Researcher account.
2. Contact CogniFit by email api-integration@cognifit.com to obtain your API client keys.
3. Set up a study in your Cognifit research platform (Videotutorial resource).
4. Registrate participants as users (API resource).
5. Associate a participant to the study (API resource (not available yet)):

POST /user-programs/study/add
{
“client_id”:”{{clientId}}”: Partner’s client id
“client_secret”:”{{clientSecret}}”: Partner’s client secret
“user_token”:”{{userToken}}“: The user returned in the registration endpoint
“study_id”: {{studyId}}”: You can ask Cognifit’s team for this value or get it using the endpoint explained in the next step
}

6. As a researcher+partner you can obtain all the studies associated with your account through the APIs endpoint:
https://api.cognifit.com/programs/studies?client_id={CLIENT_ID}.
It will return an array with the studies with the following format:
{
“Key“:integer,
“status“:”STARTED or NOT_STARTED”,
“name“:”string”,
“expectedParticipants“:integer,
“availableQuantity“:integer
}