Trio Agency API Docs
Trio Agency APIs
Trio Client APIs
Trio Agency APIs
Trio Client APIs
  1. Candidate
  • Trio
    • Home
    • Webhooks
    • Guides
      • Jobs Sync
      • Candidate Submission
    • APIs
      • Candidate
        • Get a list of all active candidates related to your account.
          GET
        • Create or update a candidate.
          POST
        • Gets information for the specified candidate.
          GET
      • Candidates
        • Gets a list of candidates
        • Creates a candidate.
        • Gets a specific candidate
        • Updates a candidate.
      • Client
        • Get a list of all active clients related to your account.
        • Gets information for the specified client.
      • Clients
        • Get client locations.
        • Get clients by external source
        • Get a specific client location.
      • Job
        • Gets a listing of all open jobs.
        • Gets a listing of closed jobs based on the date range.
        • Get information for the specified job.
      • Profession
        • Gets all professions with a list of their specialties.
      • ProviderConfirmation
        • Get a list of provider confirmations related to your account.
        • Get information for the specified provider confirmation.
      • Shifts
        • Gets a list of shifts for the user performing the request
        • Gets a list of available shift statuses
        • Gets a specific shift
        • Attempts to claim the shift for the current user or specified candidate
        • Confirms the assignment of a shift
        • Declines the assignment of a shift
        • Releases a confirmed shift
      • ShiftSubmissions
        • Attempts to submit a shift submission
        • Attempts to accept a shift submission
        • Attempts to reject a shift submission
        • Attempts to withdraw a shift submission
      • Specialty
        • Gets all specialties.
        • Gets information for the specified specialty.
      • StaffingPools
        • Get a collection of candidates with active or inactive clearances to staffing pools
        • Get locations for staffing pools
      • Submission
        • Get a list of all submissions related to your account.
        • Create a new submission.
        • Accepts a submission that was offered.
        • Declines an offered submission.
        • Withdraw a submission.
        • Get a list of reasons for withdrawing a submission.
        • Get information for the specified submission.
        • Update the specified submission.
      • Submissions
        • Get a list of submission documents
        • Get a specified submission document
        • Get a list of submission documents Copy
      • Timecard
        • Get a list of all Timecards related to your account.
        • Get a list of all valid Pay Types the can be used when creating/updating Timecard Lines.
        • Get a specific timecard.
        • Get a list of all documents associated with a timecard.
        • Get the timesheet document associated with a timecard.
        • Get a specific document associated with a timecard.
      • Timecard Copy
        • Get a list of all Timecards related to your account.
        • Get a list of all valid Pay Types the can be used when creating/updating Timecard Lines.
        • Get a specific timecard.
        • Get a list of all documents associated with a timecard.
        • Get the timesheet document associated with a timecard.
        • Get a specific document associated with a timecard.
      • TimecardExpense
        • Get a list of all Timecard Expenses for a Timecard.
      • TimecardLine
        • Get a list of all Timecard Lines for a Timecard.
      • Webhooks
        • Get a list of all webhooks registered for your agency.
        • Subscribes a new webhook to a Trio event.
        • Deletes the webhook registration from Trio.
        • Get the list of available events that can be subscribed to via webhook.
        • Get a webhook by its id.
  1. Candidate

Create or update a candidate.

POST
/Candidate

Request

Authorization
API Key
Add parameter in header
X-API-Key
Example:
X-API-Key: ********************
or
Body Params application/jsonRequired

Examples

Responses

🟢200OK
application/json
The request has succeeded.
Body

🟠400Bad Request
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.triowfs.com/trio/Candidate' \
--header 'X-API-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Number": 183430,
    "FirstName": "Dannie",
    "MiddleName": null,
    "LastName": "Smith",
    "Title": null,
    "AddressLine1": "123 Test",
    "AddressLine2": null,
    "City": null,
    "StateAbbreviation": null,
    "ZipCode": null,
    "PermanentAddressLine1": null,
    "PermanentAddressLine2": null,
    "PermanentCity": null,
    "PermanentStateAbbrevation": "OK",
    "PermanentZipCode": null,
    "PhoneNumber": null,
    "AlternativePhoneNumber": null,
    "EmailAddress": "danniesmith@email.com",
    "AlternativeEmailAddress": null,
    "DriversLicenseNumber": null,
    "Identification": "Expedient Medstaff",
    "BirthDate": "2000-01-01",
    "ExperienceYears": null,
    "TravelExperienceYears": null,
    "ExperienceDescription": null,
    "IsAlcoholFree": false,
    "IsNicotineFree": false,
    "IsConvicted": false,
    "ConvictedDescription": null,
    "IsSuspended": false,
    "SuspendedDescription": null,
    "Description": null,
    "Note": null,
    "Specialties": [],
    "Certifications": [],
    "StateLicenses": [],
}'
Response Response Example
200 - Example 1
{
    "Number": 0,
    "AgencyName": "string",
    "AgencyNumber": 0,
    "Name": "string",
    "FirstName": "string",
    "MiddleName": "string",
    "LastName": "string",
    "Title": "string",
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "State": "string",
    "StateAbbreviation": "string",
    "ZipCode": "string",
    "PermanentAddressLine1": "string",
    "PermanentAddressLine2": "string",
    "PermanentCity": "string",
    "PermanentState": "string",
    "PermanentStateAbbreviation": "string",
    "PermanentZipCode": "string",
    "PhoneNumber": "string",
    "AlternativePhoneNumber": "string",
    "EmailAddress": "string",
    "AlternativeEmailAddress": "string",
    "DriversLicenseNumber": "string",
    "Identification": "string",
    "BirthDate": "2019-08-24",
    "ExperienceYears": 0,
    "TravelExperienceYears": 0,
    "ExperienceDescription": "string",
    "IsAlcoholFree": true,
    "IsNicotineFree": true,
    "IsConvicted": true,
    "ConvictedDescription": "string",
    "IsSuspended": true,
    "SuspendedDescription": "string",
    "Description": "string",
    "Specialties": [
        {
            "Id": "38a5a5bb-dc30-49a2-b175-1de0d1488c43",
            "ProfessionId": "6758a7a0-8526-4030-94c2-e425266d45e5",
            "Name": "string",
            "ProfessionName": "string",
            "Code": 0,
            "Description": "string",
            "Active": true,
            "ExternalIdentifiers": [
                {
                    "sourceCode": "string",
                    "code": "string",
                    "value": "string"
                }
            ],
            "ModifiedDateUtc": "2019-08-24T14:15:22.123Z"
        }
    ],
    "Certifications": [
        {
            "Code": 0,
            "Name": "string",
            "Description": "string",
            "ModifiedDateUtc": "2019-08-24T14:15:22.123Z"
        }
    ],
    "StateLicenses": [
        {
            "State": "string",
            "Abbreviation": "string",
            "IsCompact": true,
            "ExpirationDate": "2019-08-24"
        }
    ],
    "ExternalIdentifiers": [
        {
            "sourceCode": "string",
            "code": "string",
            "value": "string"
        }
    ],
    "SocialSecurityNumber": "string",
    "Note": "string",
    "ModifiedDateUtc": "2019-08-24T14:15:22.123Z"
}
Modified at 2026-03-05 23:05:37
Previous
Get a list of all active candidates related to your account.
Next
Gets information for the specified candidate.
Built with