How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Vital orders API

The orders API from Vital — 1 operation(s) for orders.

Vital orders API is one of 18 APIs that Vital publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 7 JSON Schema definitions.

Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 7 JSON Schemas.

This API exposes 1 operation across 1 path, and defines 45 schemas. It is described by OpenAPI 3.1.0, at version 0.4.497.

Requests are made against 4 base URLs: https://api.us.junction.com, https://api.eu.junction.com, https://api.sandbox.us.junction.com, https://api.sandbox.eu.junction.com.

1 operations 1 paths 45 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.4.497
Base URL
https://api.us.junction.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Vital orders API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-vital-api-key (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — Vital Team API Key

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

orders 1
GET
/v3/orders
Get Orders
get_orders_v3_orders_get 19 params → 200422

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are ClientFacingOrder (31 properties), ClientFacingLabTest (16 properties), ClientFacingMarker (14 properties), ClientFacingPatientDetailsCompatible (11 properties). Each schema is shown below with its type and property counts.

OrderOrigin
string
ℹ️ This enum is non-exhaustive.
Interpretation
string
ℹ️ This enum is non-exhaustive.
ClientFacingAtHomePhlebotomyOrderDetails
object
2 properties 1 required
Question
object
9 properties 7 required
GuarantorDetails
object
7 properties 4 required
OrderActivationType
string
ℹ️ This enum is non-exhaustive.
ClientFacingAtHomePhlebotomyOrder
object
Schema for a at-home-phlebotomy test order in the client facing API. To be used as part of a ClientFacingOrder.
4 properties 3 required
ClientFacingWalkInOrderDetails
object
2 properties 1 required
Address
object
7 properties 5 required
ShippingAddress
object
8 properties 7 required
MarkerType
string
ℹ️ This enum is non-exhaustive.
ClientFacingOnSiteCollectionOrder
object
Schema for an on-site collection order in the client facing API. To be used as part of a ClientFacingOrder.
3 properties 3 required
SexualOrientation
string
ℹ️ This enum is non-exhaustive.
LabTestStatus
string
ℹ️ This enum is non-exhaustive.
PatientAddressCompatible
object
9 properties 5 required
ClientFacingOrderTransaction
object
Order transaction info.
3 properties 3 required
ClientFacingOrderInTransaction
object
Minimal order info for embedding in ordertransaction payload.
7 properties 3 required
Billing
string
ℹ️ This enum is non-exhaustive.
ClientFacingOnSiteCollectionOrderDetails
object
2 properties 1 required
ClientFacingLab
object
8 properties 8 required
OrderLowLevelStatus
string
ℹ️ This enum is non-exhaustive.
GetOrdersResponse
object
4 properties 1 required
OrderStatus
string
Used in combination with OrderStatusDetail to represent the current order state. OrderStatus is driven by a FSM whereas OrderStatusDetail is descriptive only.…
ClientFacingPatientDetailsCompatible
object
11 properties 2 required
Race
string
ℹ️ This enum is non-exhaustive.
Ethnicity
string
ℹ️ This enum is non-exhaustive.
ClientFacingOrderEvent
object
4 properties 3 required
ClientFacingWalkInTestOrder
object
Schema for a walk-in test order in the client facing API. To be used as part of a ClientFacingOrder.
4 properties 3 required
ClientFacingPhysician
object
3 properties 3 required
HTTPValidationError
object
1 property
ClientFacingOrder
object
31 properties 17 required
GenderIdentity
string
ℹ️ This enum is non-exhaustive.
OrderTopLevelStatus
string
ℹ️ This enum is non-exhaustive.
ClientFacingLabTest
object
16 properties 10 required
OrderStatusDetail
string
A descriptive-only additional field to be used in combination with OrderStatus. Exposed in the API. ℹ️ This enum is non-exhaustive.
OrderTransactionStatus
string
ℹ️ This enum is non-exhaustive.
ClientFacingMarker
object
14 properties 3 required
ClientFacingShipment
object
Schema for a Shipment in the client facing API. To be used as part of a ClientFacingTestkitOrder.
8 properties 8 required
LabTestCollectionMethod
string
The method used to perform a lab test. ℹ️ This enum is non-exhaustive.
AoE
object
1 property 1 required
LabTestSampleType
string
The type of sample used to perform a lab test. ℹ️ This enum is non-exhaustive.
Answer
object
3 properties 3 required
ClientFacingTestkitOrder
object
Schema for a testkit order in the client facing API. To be used as part of a ClientFacingOrder.
4 properties 4 required
ClientFacingTestKitOrderDetails
object
2 properties 1 required
QuestionType
string
ℹ️ This enum is non-exhaustive.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vital-io-orders-api-openapi.yml Raw ↑

Other APIs Vital publishes across the network.

Vital Management API
Vital Aggregate API
Vital compendium API
Vital insurance API
Vital introspect API
Vital lab_account API
Vital lab_report API
Vital lab_tests API
Vital link API
Vital order API
Vital order_transaction API
Vital payor API
Where this information came from

This is an independent, third-party profile of Vital orders API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.