Gets a list of candidates

GET

/candidates

Retrieves a paginated list of candidates available to the user. The list can be filtered by passing in an email and/or a modified date that gets all candidates with a modification date after the modifiedSinceDate input.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

API Key

Add parameter in header

X-API-KEY

Example:

X-API-KEY: ********************

Query Params

Responses

🟢200OK

application/json

The request has succeeded.

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.triowfs.com/trio/candidates?offset&maxResults&email&modifiedSinceDate' \
--header 'X-API-KEY: <api-key>'

Response Example

{
    "offset": 0,
    "total": 0,
    "maxResults": 0,
    "sort": [
        "string"
    ],
    "links": {
        "first": "http://example.com",
        "last": "http://example.com",
        "next": "http://example.com",
        "prev": "http://example.com"
    },
    "items": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "number": 0,
            "agency": {
                "id": 0,
                "name": "string"
            },
            "name": "string",
            "firstName": "string",
            "lastName": "string",
            "title": "string",
            "phoneNumber": "string",
            "emailAddress": "string"
        }
    ]
}

Modified at 2025-09-24 17:33:05

Gets information for the specified candidate.

Creates a candidate.