Skip to main content
GET
/
projects
/
{projectId}
/
testtakers
List test takers
curl --request GET \
  --url https://stage-api.neurapulse.com/projects/{projectId}/testtakers \
  --header 'x-api-key: <api-key>'
[
  {
    "id": 123,
    "email": "<string>",
    "referenceId": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "fullName": "<string>",
    "yearOfBirth": 123,
    "dateCompleted": "2023-11-07T05:31:56Z",
    "lastTestSentUtc": "2023-11-07T05:31:56Z"
  }
]

Documentation Index

Fetch the complete documentation index at: https://stage-help.neurapulse.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API key generated in the Portal (Workspace Settings → API Keys).

Path Parameters

​
projectId
string<uuid>
required

Project Id. Obtain via GET /projects or from the project URL.

Query Parameters

​
page
integer<int32>
default:1

Page number, starting at 1. Default: 1.

​
pageSize
integer<int32>
default:100

Items per page (1–100). Default: 100.

​
order
enum<string>
default:Desc

Sort direction. One of: asc, desc. Default: asc.

Available options:
Asc,
Desc
​
orderBy
enum<string>
default:Priority

Sort field. One of: priority, performance, fullName, lastTestSent. Default: priority.

Available options:
Priority,
Performance,
FullName,
LastTestSent
​
filter
string
default:""

Substring match across referenceId, fullName, and email.

Maximum string length: 500
​
completedOnly
boolean

Filter by completed results only. true = completed only, false = all.

​
hasReferenceId
boolean

Filter by presence of referenceId. true = has ID, false = no ID, null = all.

​
referenceId
string

Exact match for referenceId.

Maximum string length: 500
​
hasLastTestSent
boolean

Filter by presence of LastTestSentUtc. true = has value, false = no value, null = all.

​
lastTestSentFromUtc
string<date-time>

Lower bound (inclusive) for LastTestSentUtc. ISO 8601.

​
lastTestSentToUtc
string<date-time>

Upper bound (inclusive) for LastTestSentUtc. ISO 8601.

Response

OK

​
id
integer<int32>
required
​
email
string
required
​
referenceId
string | null
​
firstName
string | null
​
lastName
string | null
​
fullName
string
​
yearOfBirth
integer<int32> | null
​
result
any | null
Available options:
Started,
Completed,
CouldNotCompleteConnectionIssues,
CouldNotCompleteNpServerIssues,
CouldNotCompleteTimedOut,
CouldNotCompleteUnsupportedDevice,
Confirming,
HighRisk,
InProgress,
NotStarted,
Incomplete,
Fatigued,
Distressed,
ReasonableCause,
Escalated,
Emergency,
null
​
dateCompleted
string<date-time> | null
​
lastTestSentUtc
string<date-time> | null