GraphQL API Reference

GraphQL API Reference

For an automatically generated API Reference, check out our auto-generated GraphQL Docs !

GraphQL Playground

To run queries and mutations against our sandbox environment, we have a GraphQL playground.

The playground includes an "explorer" tab (folder icon on the left) that allows click-through building of GraphQL queries for the enablement services API. Once the schema is loaded, the explorer is an efficient way of exploring data in enablement services API.

To load the schema, include a user or organization session token in the headers:

1. See the Enablement Services Authentication page for instructions on obtaining a token.
2. Click the headers button at the bottom of the explorer. Add the access token you received from the bloom api in the format {"authorization": "bearer YOUR_ACCESS_TOKEN_HERE"}
3. Click the refresh button (circling arrows) at the bottom left of the explorer.
4. To be able to run user-scoped queries & mutations, include a user scoped access token. The same applies for organization scoped access.
   1. See the GraphQL API Reference section to determine authorization scopes for specific operations.

GraphQL API Endpoint

Our GraphQL API is available with the following URLS, based on environment:

All mutations/queries require some form of authentication. See the Enablement Services Authentication page for instructions on how to authenticate.

Creating a user

Once you’ve created a user in your application and completed any necessary KYC checks, the next step is to create a corresponding user in our database. This can be done using the registerUserOrganization mutation. This mutation will return the user object as it’s stored in our system, including a unique user_id. Be sure to save this user_id—it’s required for authenticating and accessing additional queries and mutations in our API.

Importing a Connection

After creating and authenticating your user or organization, the next step is to import the previously established aggregator connection. This allows our system to ingest and categorize transactions linked to that connection. To do this, use the importConnections mutation.

Additional queries can be found in our API References.