v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Project

project.search

Search for projects by title.

Responses are limited to 100 results. Consider refining your search or using /project.list to paginate through all projects, if you approach this limit. This API is for use cases where you intend to operate on a final small set of projects, like building a project autocomplete.

Requires the candidatesRead permission.

post/project.search

Request body

titlestring required

The project's title

Response

Responses from the project.search 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": []
    }
  ]
}