Trio Agency API Docs
Trio Agency APIsTrio Client APIs
Trio Agency APIsTrio Client APIs
  1. Trio
  • Trio
    • Home
    • Webhooks
    • Guides
      • Jobs Sync
      • Candidate Submission
    • APIs
      • Candidate
        • Get a list of all active candidates related to your account.
        • Create or update a candidate.
        • Gets information for the specified candidate.
      • 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 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.
      • 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.
Trio Agency APIsTrio Client APIs
Trio Agency APIsTrio Client APIs
  1. Trio

Trio VMS API Documentation

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 is available at different environments:
Production: https://api.triovms.com/{tenant}/api/v3
UAT: https://api-uat.triovms.com/{tenant}/api/v3
Replace {tenant} with your specific MSP's identifier.

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 2025-09-24 15:28:27
Next
Webhooks
Built with