Skip to main content
GET
Get project

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.

Response

OK

name
string
required

The name of the project.

Maximum string length: 50
fitForDutyResponse
string
required

Define actions for high-risk results. For example, you can write 'Interview the test taker', or enter a URL.

Maximum string length: 1000
id
string<uuid>

The unique identifier of the project.

dateCreated
string<date-time>

The date the project was created.

lastModified
string<date-time>

The date the project was last modified.

state
enum<string>

The state of the project.

Available options:
Draft,
Active,
Inactive,
Deleted,
ActiveExpired
Example:

"Draft"