Trio VMS Agency API Docs
Trio Agency APIs
Trio Client APIsTrio Staff APIs
Trio Agency APIs
Trio Client APIsTrio Staff APIs
  1. Candidate
  • Home
  • Webhooks
  • Guides
    • Jobs Sync
    • Candidate Submission
  • v3
    • AssignmentConfirmations
      • Get information for the specified assignment confirmation version.
    • 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.
      • Gets candidate's state licenses
      • Change a candidate's state license
    • Client
      • Get a list of all active clients related to your account.
      • Gets information for the specified client.
    • Clients
      • Get client locations.
      • Get a specific client location.
      • Get a client's presentation requirements.
    • Invoice
      • Get a list of invoices.
      • Get an invoice by number
      • Get a list of timecards for the specified invoice.
    • 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.
    • Notifications
      • Gets a list of available notification types
    • 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
      • Get the reasons that may accompany a shift status change.
      • 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.
    • 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.
    • SubmissionDocuments
      • Get the documents attached to a submission.
      • Attach a document to a submission.
      • Download a specific submission document.
      • Remove a document from a submission.
    • Submissions
      • Get submissions across every segment group.
      • Get a specific submission.
    • StaffingPools
      • Get a collection of candidates with active or inactive clearances to staffing pools
      • Get locations for staffing pools
    • Tenants
      • Get tenant info
    • 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 list of all valid status reasons.
      • 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
https://api.triowfs.com/trio/api/v3/Candidate
Agency users only. Supplying a Number updates that candidate; omitting it creates a new one under the calling agency.

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Body Params multipart/form-dataRequired

Responses

🟢200OK
application/json
A successful OK response (HTTP 200) with a typed body.
Bodyapplication/json

🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.triowfs.com/trio/api/v3/Candidate' \
--header 'x-api-key: <api-key>' \
--form 'Number="";type=text/plain' \
--form 'FirstName=""' \
--form 'MiddleName=""' \
--form 'LastName=""' \
--form 'Title=""' \
--form 'AddressLine1=""' \
--form 'AddressLine2=""' \
--form 'City=""' \
--form 'StateAbbreviation=""' \
--form 'ZipCode=""' \
--form 'PermanentAddressLine1=""' \
--form 'PermanentAddressLine2=""' \
--form 'PermanentCity=""' \
--form 'PermanentStateAbbreviation=""' \
--form 'PermanentStateAbbrevation=""' \
--form 'PermanentZipCode=""' \
--form 'PhoneNumber=""' \
--form 'AlternativePhoneNumber=""' \
--form 'EmailAddress=""' \
--form 'AlternativeEmailAddress=""' \
--form 'DriversLicenseNumber=""' \
--form 'Identification=""' \
--form 'BirthDate=""' \
--form 'ExperienceYears=""' \
--form 'TravelExperienceYears=""' \
--form 'ExperienceDescription=""' \
--form 'IsAlcoholFree="";type=text/plain' \
--form 'IsNicotineFree="";type=text/plain' \
--form 'IsConvicted="";type=text/plain' \
--form 'ConvictedDescription=""' \
--form 'ConvictedDocumentation="";type=*/*' \
--form 'IsSuspended="";type=text/plain' \
--form 'SuspendedDescription=""' \
--form 'SuspendedDocumentation="";type=*/*' \
--form 'Description=""' \
--form 'CertificationCodes="";type=application/json' \
--form 'Specialties="";type=application/json' \
--form 'StateLicenses="";type=application/json'
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",
    "PermanentStateAbbrevation": "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
        }
    ],
    "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"
        }
    ],
    "Note": "string",
    "ModifiedDateUtc": "2019-08-24T14:15:22.123Z"
}
Modified at 2026-09-17 22:39:27
Previous
Get a list of all active candidates related to your account.
Next
Gets information for the specified candidate.
Built with