Humanitarian Action GraphQL API Playground

Humanitarian Action GraphQL API playground.

This portal allows approved users to run a small number of example GraphQL queries and view the resulting JSON data. It is intended for learning, validation and occasional testing.

This portal is not the supported connection route for applications, ETLs, scheduled jobs, large downloads or regular data extraction.

What is the GraphQL API?

The Humanitarian Action GraphQL API provides read-only access to reference data, plans, projects, emergencies, sectors, coordination entities, requirements and organizations.

With GraphQL, you specify exactly which fields you want returned. Related data can also be requested within the same query.

GraphQL and REST

REST normally provides multiple URLs for different resources. For example, a REST service might provide separate URLs for plans, projects and emergencies. The server determines the standard structure returned by each URL.

GraphQL normally uses one endpoint. The request body contains a query that identifies:

  • The data to retrieve

  • The fields to return

  • Filters to apply

  • Related data to include

  • Paging instructions

The JSON response follows the structure of the GraphQL query.

How to try a query

  1. Sign in to the developer portal and confirm your registration.

  2. An administrator will grant you the required API permissions. You do not need to subscribe to a product.

  3. Open the Sample Queries page.

  4. Select an example and copy its GraphQL query and variables.

  5. Open the APIs page.

  6. Select api-hpc-prod - v1.

  7. Select Try this operation to open the test console.

  8. Paste the sample query into the query field.

  9. Paste the accompanying JSON into the variables field.

  10. Change the filter values in the variables if needed.

  11. Send the request and review the returned JSON response.

Testing only

Use this portal for small, occasional tests.

Do not use it for:

  • Production applications

  • Scheduled jobs or ETLs

  • Large data downloads

  • High-volume requests

  • Long-running or highly nested queries

  • Multiple large concurrent requests

Start with 100 records and use GraphQL pagination when more data is required.

Documentation

Documentation is available under the Documentation link on the site and will be updated on an ongoing basis. Please feel free to reach out with any specific questions or if assistance is needed with a query.

Need direct access?

For regular use from Python, C#, Node.js, Postman, Excel, an ETL or another application, request direct access to the Fabric GraphQL API.

Contact: SPPB-Tools team

Technical documentation

Detailed documentation, schemas, reusable queries and client examples are maintained in the private GitHub repository:

https://github.com/UN-OCHA/hpc-fabric-graphql-api-docs

If you need technical documentation, email SPPB-Tools team and ask to be added to the repository.