GetPaid GraphQL API is in alpha build and is subject to change without warning. While the overall schemas will not vary much, the fields could undergo major revision. (see GraphQL Best Practices for Versioning (opens in a new tab))

About Enums

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."


Represents true or false values.


Represents signed double-precision fractional values as specified by IEEE 754.


Represents a unique identifier that is Base64 obfuscated. It is 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 "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.


Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.


Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

Last updated on January 4, 2023