# Trio Agency API Docs ## Docs - Root [Trio VMS API Documentation](https://developer-internal-preview.ahstech.com/agency/trio-vms-api-documentation-1619312m0.md): - Root [Webhooks](https://developer-internal-preview.ahstech.com/agency/webhooks-1619377m0.md): - Root > Guides [Trio Job Sync Integration Guide](https://developer-internal-preview.ahstech.com/agency/trio-job-sync-integration-guide-1619314m0.md): - Root > Guides [Trio Candidate Submission Integration Guide](https://developer-internal-preview.ahstech.com/agency/trio-candidate-submission-integration-guide-1619315m0.md): ## API Docs - Root > APIs > Candidate [Get a list of all active candidates related to your account.](https://developer-internal-preview.ahstech.com/agency/get-a-list-of-all-active-candidates-related-to-your-account-21820595e0.md): - Root > APIs > Candidate [Create or update a candidate.](https://developer-internal-preview.ahstech.com/agency/create-or-update-a-candidate-21820596e0.md): - Root > APIs > Candidate [Gets information for the specified candidate.](https://developer-internal-preview.ahstech.com/agency/gets-information-for-the-specified-candidate-21820597e0.md): - Root > APIs > Candidates [Gets a list of candidates](https://developer-internal-preview.ahstech.com/agency/gets-a-list-of-candidates-21820649e0.md): 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. - Root > APIs > Candidates [Creates a candidate.](https://developer-internal-preview.ahstech.com/agency/creates-a-candidate-21820650e0.md): Creates a candidate with the specified properties. Candidate will be returned in the response. - Root > APIs > Candidates [Gets a specific candidate](https://developer-internal-preview.ahstech.com/agency/gets-a-specific-candidate-21820654e0.md): Retrieves a specific candidate by its ID. The candidate must be visible to the user performing the request. - Root > APIs > Candidates [Updates a candidate.](https://developer-internal-preview.ahstech.com/agency/updates-a-candidate-21820655e0.md): Updates a candidate with the specified properties. Returns no content on success. - Root > APIs > Client [Get a list of all active clients related to your account.](https://developer-internal-preview.ahstech.com/agency/get-a-list-of-all-active-clients-related-to-your-account-21820598e0.md): - Root > APIs > Client [Gets information for the specified client.](https://developer-internal-preview.ahstech.com/agency/gets-information-for-the-specified-client-21820599e0.md): - Root > APIs > Clients [Get client locations.](https://developer-internal-preview.ahstech.com/agency/get-client-locations-21820659e0.md): Gets all client locations based on the user's access and type. - Root > APIs > Clients [Get a specific client location.](https://developer-internal-preview.ahstech.com/agency/get-a-specific-client-location-21820660e0.md): Get a specific client location using the client Id or Number. The user must have access to the location. - Root > APIs > Job [Gets a listing of all open jobs.](https://developer-internal-preview.ahstech.com/agency/gets-a-listing-of-all-open-jobs-21820612e0.md): - Root > APIs > Job [Gets a listing of closed jobs based on the date range.](https://developer-internal-preview.ahstech.com/agency/gets-a-listing-of-closed-jobs-based-on-the-date-range-21820613e0.md): - Root > APIs > Job [Get information for the specified job.](https://developer-internal-preview.ahstech.com/agency/get-information-for-the-specified-job-21820614e0.md): - Root > APIs > Profession [Gets all professions with a list of their specialties.](https://developer-internal-preview.ahstech.com/agency/gets-all-professions-with-a-list-of-their-specialties-21820615e0.md): - Root > APIs > ProviderConfirmation [Get a list of provider confirmations related to your account.](https://developer-internal-preview.ahstech.com/agency/get-a-list-of-provider-confirmations-related-to-your-account-21820616e0.md): - Root > APIs > ProviderConfirmation [Get information for the specified provider confirmation.](https://developer-internal-preview.ahstech.com/agency/get-information-for-the-specified-provider-confirmation-21820617e0.md): - Root > APIs > Shifts [Gets a list of shifts for the user performing the request](https://developer-internal-preview.ahstech.com/agency/gets-a-list-of-shifts-for-the-user-performing-the-request-21820679e0.md): Retrieves a list of shifts available to the user performing the request. The list will include shifts that are open, as well as shifts that have been claimed or assigned to the user or their organization. - Root > APIs > Shifts [Gets a list of available shift statuses](https://developer-internal-preview.ahstech.com/agency/gets-a-list-of-available-shift-statuses-21820680e0.md): Retrieves a list of available shift statuses - Root > APIs > Shifts [Gets a specific shift](https://developer-internal-preview.ahstech.com/agency/gets-a-specific-shift-21820681e0.md): Retrieves a specific shift by its ID. The shift must be visible to the user performing the request. - Root > APIs > Shifts [Attempts to claim the shift for the current user or specified candidate](https://developer-internal-preview.ahstech.com/agency/attempts-to-claim-the-shift-for-the-current-user-or-specified-candidate-21820682e0.md): Claims a shift for the candidate specified in the query or the user performing the request if candidateId is unspecified. The shift must be open and not claimed or assigned to another user or organization. If the shift is claimed successfully, the response will include the shift details. - Root > APIs > Shifts [Confirms the assignment of a shift](https://developer-internal-preview.ahstech.com/agency/confirms-the-assignment-of-a-shift-21820683e0.md): Accepts the assignment of a shift. The shift must be assigned to the user performing the request. If the shift is accepted successfully, the response will include the shift details. - Root > APIs > Shifts [Declines the assignment of a shift](https://developer-internal-preview.ahstech.com/agency/declines-the-assignment-of-a-shift-21820684e0.md): Returns 200 when the declined shift is visible, 204 when it is not - Root > APIs > Shifts [Releases a confirmed shift](https://developer-internal-preview.ahstech.com/agency/releases-a-confirmed-shift-21820685e0.md): Returns 200 when the released shift is visible, 204 when it is not - Root > APIs > ShiftSubmissions [Attempts to submit a shift submission](https://developer-internal-preview.ahstech.com/agency/attempts-to-submit-a-shift-submission-21820686e0.md): Submits the specified shift submission as the provider or as an agency on behalf of the provider. The shift must be open or pending. If pending, the submitting provider must not have an active submission. If an agency is submitting then they must provide a candidateId. If the shift submission is successful the shift details will be returned - Root > APIs > ShiftSubmissions [Attempts to accept a shift submission](https://developer-internal-preview.ahstech.com/agency/attempts-to-accept-a-shift-submission-21820687e0.md): Accepts the specified shift submission as the provider or as an agency on behalf of the provider. The shift must be pending, not approved for another provider, and the submission's provider must not already be booked on an overlapping shift. If the shift submission is successful the shift details will be returned - Root > APIs > ShiftSubmissions [Attempts to reject a shift submission](https://developer-internal-preview.ahstech.com/agency/attempts-to-reject-a-shift-submission-21820688e0.md): Rejects the specified shift submission as the provider or as an agency on behalf of the provider. The shift must be pending. If the shift submission is successful the shift details will be returned - Root > APIs > ShiftSubmissions [Attempts to withdraw a shift submission](https://developer-internal-preview.ahstech.com/agency/attempts-to-withdraw-a-shift-submission-21820689e0.md): Withdraws the specified shift submission as the provider or as an agency on behalf of the provider. The shift must be pending. If the shift submission is successful the shift details will be returned - Root > APIs > Specialty [Gets all specialties.](https://developer-internal-preview.ahstech.com/agency/gets-all-specialties-21820618e0.md): - Root > APIs > Specialty [Gets information for the specified specialty.](https://developer-internal-preview.ahstech.com/agency/gets-information-for-the-specified-specialty-21820619e0.md): - Root > APIs > StaffingPools [Get a collection of candidates with active or inactive clearances to staffing pools](https://developer-internal-preview.ahstech.com/agency/get-a-collection-of-candidates-with-active-or-inactive-clearances-to-staffing-pools-21820690e0.md): Get candidates for staffing pools that are available for the current user. Returns an empty list if no staffing pool relationships are available. - Root > APIs > StaffingPools [Get locations for staffing pools](https://developer-internal-preview.ahstech.com/agency/get-locations-for-staffing-pools-21820691e0.md): Get locations for staffing pools that are available for the current user. Returns an empty list if no locations are available. - Root > APIs > Submission [Get a list of all submissions related to your account.](https://developer-internal-preview.ahstech.com/agency/get-a-list-of-all-submissions-related-to-your-account-21820620e0.md): - Root > APIs > Submission [Create a new submission.](https://developer-internal-preview.ahstech.com/agency/create-a-new-submission-21820621e0.md): - Root > APIs > Submission [Accepts a submission that was offered.](https://developer-internal-preview.ahstech.com/agency/accepts-a-submission-that-was-offered-21820622e0.md): - Root > APIs > Submission [Declines an offered submission.](https://developer-internal-preview.ahstech.com/agency/declines-an-offered-submission-21820623e0.md): - Root > APIs > Submission [Withdraw a submission.](https://developer-internal-preview.ahstech.com/agency/withdraw-a-submission-21820624e0.md): - Root > APIs > Submission [Get a list of reasons for withdrawing a submission.](https://developer-internal-preview.ahstech.com/agency/get-a-list-of-reasons-for-withdrawing-a-submission-21820625e0.md): - Root > APIs > Submission [Get information for the specified submission.](https://developer-internal-preview.ahstech.com/agency/get-information-for-the-specified-submission-21820626e0.md): - Root > APIs > Submission [Update the specified submission.](https://developer-internal-preview.ahstech.com/agency/update-the-specified-submission-21820627e0.md): - Root > APIs > Timecard [Get a list of all Timecards related to your account.](https://developer-internal-preview.ahstech.com/agency/get-a-list-of-all-timecards-related-to-your-account-21820628e0.md): - Root > APIs > Timecard [Get a list of all valid Pay Types the can be used when creating/updating Timecard Lines.](https://developer-internal-preview.ahstech.com/agency/get-a-list-of-all-valid-pay-types-the-can-be-used-when-creatingupdating-timecard-lines-21820629e0.md): - Root > APIs > Timecard [Get a specific timecard.](https://developer-internal-preview.ahstech.com/agency/get-a-specific-timecard-21820631e0.md): - Root > APIs > Timecard [Get a list of all documents associated with a timecard.](https://developer-internal-preview.ahstech.com/agency/get-a-list-of-all-documents-associated-with-a-timecard-21820633e0.md): - Root > APIs > Timecard [Get the timesheet document associated with a timecard.](https://developer-internal-preview.ahstech.com/agency/get-the-timesheet-document-associated-with-a-timecard-21820634e0.md): - Root > APIs > Timecard [Get a specific document associated with a timecard.](https://developer-internal-preview.ahstech.com/agency/get-a-specific-document-associated-with-a-timecard-21820635e0.md): - Root > APIs > Timecard Copy [Get a list of all Timecards related to your account.](https://developer-internal-preview.ahstech.com/agency/get-a-list-of-all-timecards-related-to-your-account-24968181e0.md): - Root > APIs > Timecard Copy [Get a list of all valid Pay Types the can be used when creating/updating Timecard Lines.](https://developer-internal-preview.ahstech.com/agency/get-a-list-of-all-valid-pay-types-the-can-be-used-when-creatingupdating-timecard-lines-24968182e0.md): - Root > APIs > Timecard Copy [Get a specific timecard.](https://developer-internal-preview.ahstech.com/agency/get-a-specific-timecard-24968184e0.md): - Root > APIs > Timecard Copy [Get a list of all documents associated with a timecard.](https://developer-internal-preview.ahstech.com/agency/get-a-list-of-all-documents-associated-with-a-timecard-24968186e0.md): - Root > APIs > Timecard Copy [Get the timesheet document associated with a timecard.](https://developer-internal-preview.ahstech.com/agency/get-the-timesheet-document-associated-with-a-timecard-24968187e0.md): - Root > APIs > Timecard Copy [Get a specific document associated with a timecard.](https://developer-internal-preview.ahstech.com/agency/get-a-specific-document-associated-with-a-timecard-24968188e0.md): - Root > APIs > TimecardExpense [Get a list of all Timecard Expenses for a Timecard.](https://developer-internal-preview.ahstech.com/agency/get-a-list-of-all-timecard-expenses-for-a-timecard-21820637e0.md): - Root > APIs > TimecardLine [Get a list of all Timecard Lines for a Timecard.](https://developer-internal-preview.ahstech.com/agency/get-a-list-of-all-timecard-lines-for-a-timecard-21820638e0.md): - Root > APIs > Webhooks [Get a list of all webhooks registered for your agency.](https://developer-internal-preview.ahstech.com/agency/get-a-list-of-all-webhooks-registered-for-your-agency-21820639e0.md): - Root > APIs > Webhooks [Subscribes a new webhook to a Trio event.](https://developer-internal-preview.ahstech.com/agency/subscribes-a-new-webhook-to-a-trio-event-21820640e0.md): - Root > APIs > Webhooks [Deletes the webhook registration from Trio.](https://developer-internal-preview.ahstech.com/agency/deletes-the-webhook-registration-from-trio-21820641e0.md): - Root > APIs > Webhooks [Get the list of available events that can be subscribed to via webhook.](https://developer-internal-preview.ahstech.com/agency/get-the-list-of-available-events-that-can-be-subscribed-to-via-webhook-21820642e0.md): - Root > APIs > Webhooks [Get a webhook by its id.](https://developer-internal-preview.ahstech.com/agency/get-a-webhook-by-its-id-21820643e0.md):