Scalars

Scalars are primitive values Int, Float, String, Boolean, or ID.

About scalars

Scalars are primitive values: Int, Float, String, Boolean, or ID.

When calling the GraphQL API, you must specify nested subfields until you return only scalars.

For more information, see Introduction to GraphQL.

Boolean

The Boolean scalar type represents true or false.

Cursor

A cursor for use in pagination.

Email

A valid email address.

Float

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Html

An HTML string

Content of this type is deemed safe by the server for raw output given the origin and the context of its usage. The HTML can still contain scripts or style tags where the creating user had permission to input these.

ID

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Language

PhoneNumber

A phone number.

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Timestamp

A UNIX timestamp.

The number of seconds since the Unix Epoch on January 1st, 1970 at UTC.

TimeZone

Url

A valid URL

UserRole

An access role for a user

Roles are used to assign groups of permissions to users on the platform.

UUIDv4

A valid version 4 UUID

Violation

A violation indicates an error in the GraphQL query or other incorrect circumstances such as missing permissions.