The GetPaid GraphQL API offers Partner systems and applications a means of gaining Earned Wage Access capabilities.
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 the GraphQL API
The GraphQL API allows you to be flexible and specific in the data that you retrieve.
Some key features about the GraphQL (opens in a new tab) data query language:
A Query language. GraphQL is a query language built specifically for APIs.
Is strongly typed. Provides a strongly typed schema that defines an API's complex object relationships.
Get only what you need. Send a GraphQL query and get exactly what you need, nothing more and nothing less.
Many resources in a single request. While typical REST APIs require loading from multiple URLs, GraphQL APIs get all the data your app needs in a single request.
GraphQL Schema Reference
The GraphQL schema reference is a set of rules and guidelines for constructing calls to the API. All calls are validated against this schema.
The reference section details what operations and data you can call:
- Allowed operations: queries and mutations.
- Schema-defined types: scalars, objects, enums, and input objects.
For more details on the GraphQL schema, check out the GraphQL Schemas and Types (opens in a new tab).