Trio VMS Staff API Docs
Trio Agency APIsTrio Client APIsTrio Staff APIs
Trio Agency APIsTrio Client APIsTrio Staff APIs
  1. Clients
  • 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
      • Get clients by external source reference code.
        GET
      • Get client locations.
        GET
      • Get a specific client location.
        GET
      • Get client contacts.
        GET
      • Get a specific client contact.
        GET
      • Get client contact external identifiers.
        GET
      • Creates an external identifier for a specific client contact and a specific external source.
        POST
      • Updates an external identifier for a specific client contact and a specific external source and a specific property code.
        PUT
      • Deletes an external identifier for a specific client contact and a specific external source and a specific property code.
        DELETE
      • Creates an external identifier for a specific client and a specific external source.
        POST
      • Updates an external identifier for a specific client and a specific external source and a specific property code.
        PUT
      • Deletes an external identifier for a specific client and a specific external source and a specific property code.
        DELETE
      • Get a client's presentation requirements.
        GET
    • 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. Clients

Get clients by external source reference code.

GET
https://api.triowfs.com/trio/api/v3/clients/external-source-lookup
Retrieves a paginated list of clients carrying the supplied external source reference code, together with the external source properties recorded against each.

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Query Params

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/clients/external-source-lookup?referenceCode=undefined&offset=undefined&maxResults=undefined' \
--header 'x-api-key: <api-key>'
Response Response Example
200 - Example 1
{
    "offset": 0,
    "total": 0,
    "maxResults": 0,
    "sort": [
        "string"
    ],
    "links": {
        "first": "http://example.com",
        "last": "http://example.com",
        "next": "http://example.com",
        "prev": "http://example.com"
    },
    "items": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "number": 0,
            "name": "string",
            "type": "string",
            "isActive": true,
            "address": {
                "line1": "string",
                "line2": "string",
                "city": "string",
                "state": "string",
                "zip": "string"
            },
            "parent": {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "name": "string"
            },
            "clientFamily": {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "name": "string"
            },
            "externalSource": {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "name": "string"
            },
            "externalSourceProperties": [
                {
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "name": "string",
                    "referenceCode": "string",
                    "value": "string"
                }
            ]
        }
    ]
}
Modified at 2026-09-17 22:39:27
Previous
Get clients.
Next
Get client locations.
Built with