GraphQL API

Endpoint

POST https://{your-company}-api.builda.io/graphql

Requires Authorization: Bearer {token} header.

Schema Exploration

Use a GraphQL playground (like GraphQL Playground or Insomnia) pointed at your endpoint to explore the full schema.

Example Queries

Get Products

{
  products(first: 10) {
    data {
      id
      name
      sku
      steps {
        id
        name
        order
      }
    }
    paginatorInfo {
      currentPage
      lastPage
      total
    }
  }
}

Get Product with Customisations

{
  product(id: 1) {
    id
    name
    steps {
      id
      name
      components {
        id
        name
        customisations {
          id
          name
          type
          price
        }
      }
    }
  }
}

Mutations

Content needed: Document available mutations for creating/updating products, components, etc.

Authentication

All GraphQL requests require the same Bearer token as the REST API. See Authentication.

Pagination

GraphQL uses cursor-based pagination via Lighthouse:

{
  products(first: 10, after: "cursor_string") {
    data { ... }
    paginatorInfo {
      hasMorePages
      endCursor
    }
  }
}