List test takers - Neurapulse Help Center

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

default:1

Page number, starting at 1. Default: 1.

pageSize

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

Example:

"Asc"

orderBy

enum<string>

default:Priority

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

Available options:

Priority,

Performance,

FullName,

LastTestSent

Example:

"Priority"

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

required

Numeric identifier of the test taker within the project.

string

required

The test taker's email address.

referenceId

null | string

Your own identifier for this test taker, echoed back if one was supplied on creation. Null if none was set.

firstName

null | string

The test taker's first name. Null if not provided.

lastName

null | string

The test taker's last name. Null if not provided.

fullName

string

The test taker's full name (first and last combined). Empty string if no name is on file.

yearOfBirth

The test taker's year of birth. Null if not provided.

result

null | enum<string>

Latest assessment status for this test taker. Null if they have not started a test yet.

Available options:

Started,

Completed,

CouldNotCompleteConnectionIssues,

CouldNotCompleteNpServerIssues,

CouldNotCompleteTimedOut,

CouldNotCompleteUnsupportedDevice,

Confirming,

HighRisk,

InProgress,

NotStarted,

Incomplete,

Fatigued,

Distressed,

ReasonableCause,

Escalated,

Emergency,

null

Example:

"Started"

dateCompleted

null | string<date-time>

When the test taker's most recent assessment was completed (ISO-8601, UTC). Null if no assessment has been completed.

lastTestSentUtc

null | string<date-time>

When the most recent test invitation was sent to this test taker (ISO-8601, UTC). Null if a test has never been sent.

topPerformer

boolean

Whether this test taker is flagged as a top performer for the project. A derived categorical indicator, not a score or ranking.