Getting Started with Roadmunk's GraphQL API

Roadmunk's public-facing API is powered by GraphQL. Use Roadmunk's API to build integrations that sync your data seamlessly with the tools your team relies on to get work done.

Authentication

Access to the APIs is controlled through the use of API Access Tokens that are generated and managed directly in the Roadmunk app. Click here for detailed information on Roadmunk's API Access Tokens. To leverage the API, a client must send their token in the Authorization header when making requests (Bearer Authentication Scheme). In the API Playground, this can be entered into your HTTP Headers section.

Important Note: When setting up your token, please remember to include the word "Bearer" before the token itself (as shown in the screenshot above). Not doing so will result in 400: Bad Request errors to appear when you attempt to run your query or mutation.

GraphQL Playground

In addition to these Knowledge Base articles with high-level descriptions of the queries and mutations available, a GraphQL Playground is available which provides detailed technical information related to the GraphQL schema, queries and mutations with all interface, implementation and argument details published therein. The Playground is automatically updated with the latest information as the API evolves. A button to launch the Playground is included on all query and mutation KB pages. However please note that it will launch the Playground on our main App server which services most of our North American customers. To actually test queries and mutations on your account and to integrate with Roadmunk, you should access your specific Playground/gateway. VPC customers will need to access the Playground/gateway for their specific server. If you have any questions in this regard, please contact support@roadmunk.com.

North America (APP):  https://app-gateway.roadmunk.com/

Europe (EU):  https://eu-gateway.roadmunk.com/

Asia-Pacific Region (APAC):  https://apac-gateway.roadmunk.com/

Open Roadmunk GraphQL Playground

 Where necessary, paging has been implemented in the API to assist with managing large data sets. All paging details/parameters are published in the Playground for their respective queries.

API Articles

The API KBs are structured around the datasets supported and broken down across Queries and Mutations:

Roadmapping Queries

Roadmapping Mutations

Feedback & Idea Management Queries

Feedback & Idea Management Mutations

Account Queries

CRUD Summary for Roadmunk Data Types

The tables below summarize the functionality/data currently available (as well as soon to be available) by way of the API.

Summary of CRUD Support for Roadmapping

Summary of CRUD Support for Feedback & Idea Management

Summary of CRUD Support for Accounts

• At the moment, only creating

Reviewer and Collaborator roles is supported.

** At the moment, only inactivating Users is supported.