Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

NotificationSubscription

Subscription to real time notifications

id
String!,non-null
endpoint
String!,non-null
Sample
{ "type": "HTTPS", "id": "Example String", "endpoint": "Example String" }

PageInfo

endCursor

Cursor to use when paginating forwards

hasNextPage
Boolean!,non-null

Specifies if there are more items when paginating forwards

Sample
{ "endCursor": "Example String", "hasNextPage": true }

Doctor

Doctor information

Unique ID specific to doctor-practice combination

doctorName

Full doctor name

practiceName

Practice name

address

Practice address

city

Practice city

state

Practice state

zipCode

Practice zip code

Sample
{ "id": "Example String", "doctorName": "Example String", "practiceName": "Example String", "address": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String" }

DoctorConnection

Doctor information

Nodes for this page

pageInfo
PageInfo!,non-null

Details to enable pagination

totalCount
Int!,non-null

Total item count for this query or subquery

Sample
{ "nodes": [ { "id": "Example String", "doctorName": "Example String", "practiceName": "Example String", "address": "Example String", "city": "Example String", "state": "Example String", "zipCode": "Example String" } ], "pageInfo": { "endCursor": "Example String", "hasNextPage": true }, "totalCount": 40 }

ContactProduct

Product information

productId
String!,non-null

ID that uniquely maps to a manufacturer, brand, and model combination

manufacturer
String!,non-null

Manufacturer name

brand
String!,non-null

Brand name

sphere
[String]!,non-null

Possible sphere values

diameter
[String]!,non-null

Possible diameter values

baseCurve
[String]!,non-null

Possible baseCurve values

Possible axis values

cylinder

Possible cylinder values

addition

Possible addition values

dominance

Possible dominance values

Possible color values

Sample
{ "productId": "Example String", "manufacturer": "Example String", "brand": "Example String", "sphere": [ "Example String" ], "diameter": [ "Example String" ], "baseCurve": [ "Example String" ], "axis": [ "Example String" ], "cylinder": [ "Example String" ], "addition": [ "Example String" ], "dominance": [ "Example String" ], "color": [ "Example String" ] }

ContactPrescription

Information about a contacts prescription.

productId

ID that uniquely maps to a manufacturer, brand, and model combination

manufacturer

The name of the contact lens manufacturer (e.g., Johnson & Johnson)

brand

The name of the contact lens product (e.g., Acuvue Oasys)

eye

Indication of left (OS) or right (OD) eye

sphere

The amount of lens power measured in diopters (D), minus sign (–) for nearsighted, plus sign (+) for farsighted

diameter

The width of the contact lens from edge to edge measured by millimeters

baseCurve

Indication of the curvature of the inside of the lens

axis

The lens meridian with no cylinder power, indicated by a value between 1 and 180 degrees

cylinder

The amount of lens power for astigmatism measured in diopters (D), minus sign (–) for nearsighted, plus sign (+) for farsighted

addition

The additional magnifying power that applies to the bottom portion of multifocal lenses to fix presbyopia

dominance

Indication of dominant or non-dominant eye

color

Color of the lens

packageSize

Number of lenses per package

Sample
{ "productId": "Example String", "manufacturer": "Example String", "brand": "Example String", "eye": "RIGHT", "sphere": "Example String", "diameter": "Example String", "baseCurve": "Example String", "axis": "Example String", "cylinder": "Example String", "addition": "Example String", "dominance": "Example String", "color": "Example String", "packageSize": 40 }

ContactProductConnection

Product information

Nodes for this page

pageInfo
PageInfo!,non-null

Details to enable pagination

totalCount
Int!,non-null

Total item count for this query or subquery

Sample
{ "nodes": [ { "productId": "Example String", "manufacturer": "Example String", "brand": "Example String", "sphere": [ "Example String" ], "diameter": [ "Example String" ], "baseCurve": [ "Example String" ], "axis": [ "Example String" ], "cylinder": [ "Example String" ], "addition": [ "Example String" ], "dominance": [ "Example String" ], "color": [ "Example String" ] } ], "pageInfo": { "endCursor": "Example String", "hasNextPage": true }, "totalCount": 40 }

FileUpload

Attributes of the file to be uploaded

id
String!,non-null

Unique File ID

name
String!,non-null

Full file name provided by the user

type
FileType!,non-null

File type corresponds directly with the MIME type (and often the file extension)

uploadUrl
String!,non-null

Signed URL enabling file upload via HTTP PUT with 15-minute expiration

Sample
{ "id": "Example String", "name": "Example String", "type": "BMP", "uploadUrl": "Example String" }

ContactPrescriptionVerificationRequest

Contact prescription verification request information

id
String!,non-null

Unique ID for this request

Current request status

expirationDate

Prescription expiration date if it is available

comments

Comments entered by Doctor and/or Visibly

updatedAt
String!,non-null

Last date and time this request was updated

Sample
{ "id": "Example String", "status": "NEW", "expirationDate": "Example String", "comments": "Example String", "updatedAt": "Example String" }

ContactPrescriptionVerificationJob

Contact prescription verification request information

jobId

Unique ID for this job

status

Current job status

reason

Current job reason, if applicable

notes

Notes entered by Doctor and/or Visibly

issueDate

Prescription issue date, if available

expirationDate

Prescription expiration date, if available

Prescriptions pertinent to the ordered products (inclusive of changes required)

tags

List of tags used to correlate this workflow with other systems

updatedAt
String!,non-null

Last date and time this job was updated

Sample
{ "jobId": "Example String", "status": "Example String", "reason": "Example String", "notes": "Example String", "issueDate": "Example String", "expirationDate": "Example String", "prescriptions": [ { "__typename": "ContactPrescription" } ], "tags": [ { "__typename": "Tag" } ], "updatedAt": "Example String" }

GlassesPrescriptionVerificationJob

Glasses prescription verification job details

jobId

Unique ID for this job

status

Current job status

reason

Current job reason, if applicable

notes

Notes entered by Doctor and/or Visibly

issueDate

Prescription issue date, if available

expirationDate

Prescription expiration date, if available

tags

List of tags used to correlate this workflow with other systems

updatedAt
String!,non-null

Last date and time this job was updated

Sample
{ "jobId": "Example String", "status": "Example String", "reason": "Example String", "notes": "Example String", "issueDate": "Example String", "expirationDate": "Example String", "tags": [ { "__typename": "Tag" } ], "updatedAt": "Example String" }

Interfaces

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview