Intro

We are delighted to introduce you to the Ballpark Developer Platform. Our GraphQL API provides a robust, flexible, and efficient way to build applications and integrations on top of the Ballpark design ecosystem. With it, you can automate workflows, extend platform capabilities, and integrate Ballpark into your existing tools—all without relying exclusively on ballparkhq.com.

The Ballpark API exposes a broad range of functionality, including the ability to create prototypes, manage designs, organise users, and interact with platform resources programmatically. Whether you are building internal dashboards, productivity bots, third-party integrations, or entirely new applications, the API is designed to support your requirements at scale.

Why GraphQL?

Ballpark’s API is built on GraphQL, a query language for APIs that provides clients with precise control over the data returned by the server. Unlike traditional REST endpoints, GraphQL allows you to request exactly the fields you need, improving performance and reducing over-fetching.

GraphQL operations fall into two categories:

• Queries — read-only operations that return data without side effects.

• Mutations — operations that modify data on the server and also return a result.

For example, the following query retrieves the current user’s email address:

query {
  user {
    email
  }
}

Here, the query starts at the root node (query) and requests the email field from the user node. You could just as easily request additional fields, such as associated projects or teams, depending on your requirements.

For a comprehensive introduction to GraphQL, refer to the official documentation at graphql.org/learn.

Account Requirements

To access the Ballpark API, you will need a valid Ballpark account. You can sign up for a free account to get started immediately.

Certain advanced features—such as creating teams or managing multiple projects—require a Pro, Team, or Company plan. Free accounts are limited to two projects.

Getting Started

The best way to begin is with the Get Started guide or by following our step-by-step tutorials. Once you are familiar with the basics, you can explore the full schema reference or experiment interactively using our web-based IDE.

Examples

Looking for inspiration? Explore the following open-source projects:

• BotBot — a Slack bot built in Swift, demonstrating programmatic interaction with the API.

• Dashboard — a simple interface for monitoring your design team’s activity in real time.

These examples illustrate how easily you can extend Ballpark’s capabilities to fit your workflow.