> For the complete documentation index, see [llms.txt](https://developers.bloomcredit.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.bloomcredit.io/reference/data-access/graphql/graphql-api.md).

# GraphQL API

Will fetch credit data stored on Bloom's servers via the provided GQL query. Queries that read credit\_data\_order\_by\_pk and attribute fields together reference ORDER\_ID (uuid!) and order\_id (String!) in the query body. Declare each variable you reference, or declare only one — dagql injects the missing declaration and coalesces variable values when only ORDER\_ID or order\_id is supplied (same UUID).

```json
{"openapi":"3.1.0","info":{"title":"Data Access","version":"2.0"},"tags":[{"name":"GraphQL","description":"You may query a completed credit data order made through Bloom using Bloom's GraphQL API. This section enumerates the objects in Bloom's GraphQL schema and provides instructions and examples for retrieving information from an order."}],"servers":[{"description":"Furnishment sandbox server, for testing purposes (v2)","url":"https://sandbox.bloom.dev"},{"description":"Furnishment server","url":"https://api.bloomcredit.io"},{"description":"Production Consumer Permissioned Data server","url":"https://api.bloomplus.com"},{"description":"Development Consumer Permissioned Data server","url":"https://api.bloomplus.dev"}],"security":[{"Oauth2ClientCredentials":["data-access:all"]}],"components":{"securitySchemes":{"Oauth2ClientCredentials":{"flows":{"clientCredentials":{"scopes":{"furnishment:all":"Manage accounts."},"tokenUrl":"https://authn.bloomcredit.dev/oauth2/token"}},"type":"oauth2"}}},"paths":{"/v2/data-access/graphql":{"post":{"operationId":"data-access.post-graphql","summary":"GraphQL API","description":"Will fetch credit data stored on Bloom's servers via the provided GQL query. Queries that read credit_data_order_by_pk and attribute fields together reference ORDER_ID (uuid!) and order_id (String!) in the query body. Declare each variable you reference, or declare only one — dagql injects the missing declaration and coalesces variable values when only ORDER_ID or order_id is supplied (same UUID).","requestBody":{"description":"post request to add the documentation of GraphQL","content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"object","description":"GraphQL query structure","properties":{"credit_data_order_by_pk":{"type":"object","properties":{"consumer_id":{"type":"string"},"credit_scores":{"type":"array","items":{"type":"object","properties":{"model":{"type":"string"},"value":{"type":"string"}}}},"order_id":{"type":"string"},"order_date":{"type":"string"},"tradelines":{"type":"array","items":{"type":"object","properties":{"account":{"type":"object","properties":{"account_number":{"type":"string"},"type_description":{"type":"string"},"type":{"type":"string"},"date_opened":{"type":"string"},"date_closed":{"type":"string"}}}}}}}}}},"variables":{"type":"object","properties":{"ORDER_ID":{"type":"string","format":"uuid","description":"Order UUID for credit_data_order_by_pk (uuid!). Supply this or order_id; dagql coalesces the other when omitted."},"order_id":{"type":"string","description":"Order ID for get_*_attributes_by_order_id (String!). Supply this or ORDER_ID; dagql coalesces the other when omitted."}},"description":"Supply ORDER_ID or order_id (same UUID). dagql injects the missing GraphQL declaration and variable value when only one is provided. If both are sent they must match."}},"required":["query"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"credit_data_order_by_pk":{"type":"object","properties":{"consumer_id":{"type":"string"},"credit_scores":{"type":"array","items":{"type":"object","properties":{"model":{"type":"string"},"value":{"type":"string"}}}},"order_id":{"type":"string"},"order_date":{"type":"string"},"tradelines":{"type":"array","items":{"type":"object","properties":{"account":{"type":"object","properties":{"account_number":{"type":"string"},"type_description":{"type":"string"},"type":{"type":"string"},"date_opened":{"type":"string"},"date_closed":{"type":"string"}}}}}}}}}}}}}}},"400":{"description":"Bad Request Error"},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}},"tags":["GraphQL"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developers.bloomcredit.io/reference/data-access/graphql/graphql-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.