GET
/
projects
/
{projectId}
Specifying a project Id when querying the projects endpoint will return a single project.
curl --request GET \
  --url http://stage-api.neurapulse.com/projects/{projectId} \
  --header 'x-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "dateCreated": "2023-11-07T05:31:56Z",
  "lastModified": "2023-11-07T05:31:56Z",
  "fitForDutyResponse": "<string>",
  "state": "Draft"
}

Authorizations

​
x-api-key
string
header
required

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

Path Parameters

​
projectId
string<uuid>
required

The Id of the project to retrieve

Response

OK

​
id
string<uuid>
​
name
string
Maximum length: 50
​
dateCreated
string<date-time>
​
lastModified
string<date-time>
​
fitForDutyResponse
string | null
Maximum length: 1000
​
state
enum<string>
Available options:
Draft,
Active,
Inactive,
Deleted,
ActiveExpired