Skip to content

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.
  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!