Trio VMS Staff API Docs
Trio Agency APIsTrio Client APIsTrio Staff APIs
Trio Agency APIsTrio Client APIsTrio Staff APIs
  1. Trio Staff APIs
  • Home
  • v3
    • Agencies
      • Creates an external identifier for a specific agency and a specific external source.
      • Updates an external identifier for a specific agency and a specific external source and a specific property code.
      • Deletes an external identifier for a specific agency and a specific external source and a specific property code.
    • Agency
      • Gets a listing of all agencies. Available to Staff Api users only.
      • Get information for the specified agency. Available to Staff Api users only.
    • AssignmentConfirmations
      • Get information for the specified assignment confirmation version.
    • Candidate
      • Get a list of all active candidates related to your account.
      • Gets information for the specified candidate.
    • Candidates
      • Gets a list of candidates
      • Creates an external identifier for a specific candidate and a specific external source.
      • Updates an external identifier for a specific candidate and a specific external source and a specific property code.
      • Deletes an external identifier for a specific candidate and a specific external source and a specific property code.
      • Gets candidate's state licenses
    • Client
      • Get a list of all active clients related to your account.
      • Gets information for the specified client.
    • Clients
      • Get clients.
      • Get clients by external source reference code.
      • Get client locations.
      • Get a specific client location.
      • Get client contacts.
      • Get a specific client contact.
      • Get client contact external identifiers.
      • Creates an external identifier for a specific client contact and a specific external source.
      • Updates an external identifier for a specific client contact and a specific external source and a specific property code.
      • Deletes an external identifier for a specific client contact and a specific external source and a specific property code.
      • Creates an external identifier for a specific client and a specific external source.
      • Updates an external identifier for a specific client and a specific external source and a specific property code.
      • Deletes an external identifier for a specific client and a specific external source and a specific property code.
      • Get a client's presentation requirements.
    • Confirmations
      • Creates an external identifier for a specific confirmation and a specific external source.
      • Updates an external identifier for a specific confirmation and a specific external source and a specific property code.
      • Deletes an external identifier for a specific confirmation and a specific external source and a specific property code.
    • Fees
      • Get the configured fee definitions.
      • Get a specific fee definition.
      • Get the instances configured for a fee.
      • Get a specific fee instance.
    • Invoice
      • Get a list of invoices.
      • Get an invoice by number
      • Sets the status of an invoice to Completed. The invoice must be Approved or Payment Received. Available to Staff API users only.
      • Set the Document Number for an invoice. The invoice must be Approved. Available to Staff API users only.
      • Sets the status of an invoice to Payment Received. The invoice must be Approved. Available to Staff API users only.
      • Get a list of timecards for the specified invoice.
      • Un-approve an Approved invoice. The invoice must be Approved. Available to Staff API users only.
    • Invoices
      • Creates an external identifier for a specific invoice and a specific external source.
      • Updates an external identifier for a specific invoice and a specific external source and a specific property code.
      • Deletes an external identifier for a specific invoice and a specific external source and a specific property code.
    • 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
    • Positions
      • Gets a list of assignments with demographics
    • 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
      • Creates a per-diem shift from an external system
      • Creates a new shift
      • Get candidates with active privileges, or in-flight privilege submissions, within a client family.
      • Updates an existing shift
      • Get the reasons that may accompany a shift status change.
      • Gets a list of available shift statuses
      • Gets a specific shift
      • Cancels a 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
      • Opens a shift
      • Releases a confirmed shift
    • ShiftSubmissions
      • Get the shift statuses a submission may be filtered by.
      • Get the submission statuses a submission may be filtered by.
      • Get the submissions recorded against a shift.
      • Attempts to submit a shift submission
      • Attempts to accept a shift submission
      • Attempts to reject a shift submission
      • Attempts to withdraw a shift submission
    • Specialties
      • Creates an external identifier for a specific specialty and a specific external source.
      • Updates an external identifier for a specific specialty and a specific external source and a specific property code.
      • Deletes an external identifier for a specific specialty and a specific external source and a specific property code.
    • 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.
    • SubmissionEvaluations
      • Record an evaluation against a submission.
      • Update an evaluation recorded against 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
    • Tiers
      • Get all tiers
      • Get a specific tier
    • 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 callback statistics for a specific client.
      • Get a list of all valid status reasons.
      • Get the reviews for a specific timecard.
      • Create a review for a specific timecard.
      • Get a review for a specific timecard.
      • Update a review for a specific timecard.
      • Delete a review for a specific timecard.
      • Get a specific timecard.
      • Approve a timecard.
      • Declines the specified 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.
      • Verify a timecard.
      • Updates the BillRecordNumber for the specified 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 the list of available events that can be subscribed to via webhook.
  1. Trio Staff APIs

Home

Welcome to the Trio VMS API documentation. This guide will help you integrate your applications with the Trio VMS (Vendor Management System) platform, allowing you to access and manage various aspects of the system programmatically.

Overview#

The Trio VMS API is a RESTful API that provides access to various resources and functionalities within the Trio VMS system. It allows you to perform operations related to candidates, jobs, shifts, timecards, and more.

Authentication#

The Trio VMS API uses one primary method of authentication for integrations:
1.
API Key Authentication: Endpoints require an API key, which should be included in the X-API-KEY header.
To obtain the necessary credentials, you can either:
1.
Generate and API key from your User Profile page in the Trio VMS application.
Generate API Key
2.
Request an API key from your MSP contact.

REST Principles#

The Trio VMS API adheres to REST (Representational State Transfer) principles:
Resources: Each endpoint represents a resource (e.g., candidates, jobs, shifts)
HTTP Methods: Use standard HTTP methods for operations (GET, POST, PUT, DELETE)
Stateless: Each request contains all necessary information; no client context is stored on the server
Uniform Interface: Consistent resource identifiers and methods across the API
JSON Responses: Data is typically returned in JSON format

Base URL#

The API can be accessed through a single URL. The API key provided will route each request to the correct environment:
https://api.triowfs.com/trio

Getting Started#

To start using the Trio VMS API:
1.
Obtain authentication credentials from the Trio VMS support team
2.
Choose the appropriate base URL for your environment
3.
Explore the available endpoints in the documentation
4.
Make API requests using your preferred HTTP client or programming language

API Versioning#

The current version of the API is v3. Always check the documentation for the latest updates and changes.

Rate Limiting#

Please be aware that rate limiting may be in place to ensure fair usage of the API. If you encounter rate limit errors, reduce your request frequency.

Support#

If you need assistance or have any questions about the API, please contact the Trio VMS support team.
Happy integrating!
Modified at 2026-09-16 21:35:11
Next
Creates an external identifier for a specific agency and a specific external source.
Built with