v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Project

project.info

Retrieves a project by its UUID.

Requires the candidatesRead permission.

post/project.info

Request body

projectIdstring uuid required

The id of the project

Example request

{
  "projectId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
}

Response

Responses from the project.info endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "title": "My Project",
    "isArchived": false,
    "authorId": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d",
    "description": "A project for sourcing candidates",
    "confidential": false,
    "customFieldEntries": []
  }
}