Skip to content
/Objects

GraphQL Overview

Download GraphQL schema
visibly-api.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

NotificationSubscription

Subscription to real time notifications

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

PageInfo

endCursor
String

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
}
Referenced in
DoctorConnection.pageInfo
ContactProductConnection.pageInfo

Doctor

Doctor information

id
String

Unique ID specific to doctor-practice combination

doctorName
String

Full doctor name

practiceName
String

Practice name

address
String

Practice address

city
String

Practice city

state
String

Practice state

zipCode
String

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"
}
Referenced in
DoctorConnection.nodes
ContactsPrescription.doctor
GlassesPrescription.doctor

DoctorConnection

Doctor information

nodes
[Doctor]

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]

Possible sphere values

diameter
[String]

Possible diameter values

baseCurve
[String]

Possible baseCurve values

axis
[String]

Possible axis values

cylinder
[String]

Possible cylinder values

addition
[String]

Possible addition values

dominance
[String]

Possible dominance values

color
[String]

Possible color values

packageSize
[String]

Number of lenses per package

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"
  ],
  "packageSize": [
    "Example String"
  ]
}
Referenced in
ContactProductConnection.nodes

Interfaces

Overview

Enums

Overview

Inputs

Overview