This article is for software developers and IT admins who want to integrate the Heydoc Public API into their own systems. Our updated API reference can be found here.

Before you attempt to perform a query or mutation, make sure you have signed into the Heydoc API.

From this article, you can go directly to our updated list of types, or see below for information about types:


About types

Every GraphQL (GQL) service defines a set of types which describe the set of possible data that you can query on that service. This set of definitions is called the schema. The most basic components of a GQL schema are object types, which represent a kind of object that you can fetch from the service, and what fields it has.

Here is an example of an object type:

  • Patient : The GQL Object

  • name and insurance : Are fields in the Patient type. These are therefore the only fields that can appear in any part of a GQL query that operates on the Character type

  • String! : Showing that the name field will return a text based response. The exclamation mark after it means that it is required and therefore the GQL service will always give back a value when you query this field

  • [Insurance!]! : Represents an array of Insurance objects. Again the exclamation mark after it means that it is required and therefore the GQL service will always give back a value when you query this field

Similar to queries and mutations, an object type can have any number of arguments to customise the returned data.

To learn more about types, you can visit the official GQL website here.


Tips for using types

Some things to remember when using types with the Heydoc API:

  • Check whether any of the fields are required or not. Required fields are marked with an exclamation mark after them

  • Check your opening and closing brackets when entering a type. GraphQL uses a variety of bracket types.

Did this answer your question?