curl --request GET \
--url https://api.neurapulse.com/projects \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.neurapulse.com/projects', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.neurapulse.com/projects"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.neurapulse.com/projects");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-api-key", "<api-key>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
[
{
"name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dateCreated": "2023-11-07T05:31:56Z",
"lastModified": "2023-11-07T05:31:56Z",
"state": "Draft",
"fitForDutyResponse": "<string>"
}
]{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}List projects
Returns a paginated list of projects for the workspace.
curl --request GET \
--url https://api.neurapulse.com/projects \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.neurapulse.com/projects', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.neurapulse.com/projects"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.neurapulse.com/projects");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-api-key", "<api-key>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
[
{
"name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dateCreated": "2023-11-07T05:31:56Z",
"lastModified": "2023-11-07T05:31:56Z",
"state": "Draft",
"fitForDutyResponse": "<string>"
}
]{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Authorizations
API key generated in the Portal (Workspace Settings → API Keys).
Query Parameters
Page number, starting at 1. Default: 1.
Items per page (1–100). Default: 100.
Sort direction. One of: asc, desc. Default: asc.
Asc, Desc "Asc"
Sort field. One of: name, dateCreated, lastModified, state. Default: name.
Name, DateCreated, LastModified, State "Name"
Filter by project name (substring match).
500Filter by project state.
Draft, Active, Inactive, Deleted, ActiveExpired "Draft"
Bypass the server cache to get the latest data.
Response
OK
The name of the project.
50The unique identifier of the project.
The date the project was created.
The date the project was last modified.
The state of the project.
Draft, Active, Inactive, Deleted, ActiveExpired "Draft"
Define actions for high-risk results. For example, you can write 'Interview the test taker', or enter a URL. Optional: omit or pass null when a fitness-for-duty response is not used; stored and returned as an empty string.
1000