Skip to main content
GET
/
api
/
public
/
candidates
List all candidates
curl --request GET \
  --url https://api.ropes.ai/api/public/candidates \
  --header 'x-api-key: <api-key>'
{
  "candidates": [
    {
      "name": "<string>",
      "email": "[email protected]",
      "createdAt": "2023-11-07T05:31:56Z",
      "identifier": "<string>",
      "notes": "<string>",
      "status": "Not Assigned",
      "integrationSource": "<string>",
      "externalId": "<string>"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
integrationSource
string

Filter by integration source (e.g., "loxo"). Must be provided with externalId.

​
externalId
string

Filter by external ID from the ATS integration. Must be provided with integrationSource.

Response

Successfully retrieved candidates

​
candidates
object[]
required

List of candidates