GraphQL API

API Keys

Generate API keys from Settings > API keys in the app. These keys authenticate all requests to the API, and to the tRPC API as well.

GraphQL Endpoint

Production: https://api.rolebase.io/graphql

Local development: http://localhost:8888/graphql

The API is powered by Hasura, so you can refer to the Hasura documentation for advanced query capabilities.

Try queries live in the GraphQL Playground. For backend procedures that go beyond CRUD, see the tRPC API.

Quick Start

Using curl

curl -X POST https://api.rolebase.io/graphql \
  -H "x-api-key: YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{"query": "{ org { id, name } }"}'

Using Apollo Client

import {
  ApolloClient,
  InMemoryCache,
  createHttpLink,
  gql,
} from '@apollo/client'

// Create the client with auth headers
const client = new ApolloClient({
  link: createHttpLink({
    uri: 'https://api.rolebase.io/graphql',
    headers: {
      'x-api-key': 'YOUR_API_KEY_HERE',
    },
  }),
  cache: new InMemoryCache(),
})

// Example query
const { data } = await client.query({
  query: gql`
    query GetOrganization {
      org {
        id
        name
      }
    }
  `,
})

Entities

Each entity supports standard GraphQL operations (query, mutation) depending on your API key permissions.

Organization & Members

• org — Organizations
• member — Organization members
• org_file — Organization files
• org_subscription — Organization subscriptions

Circles & Roles

• circle — Organizational circles
• circle_leader — Circle leadership assignments
• circle_link — Links between circles
• circle_member — Circle memberships
• circle_participant — Circle participants (view)
• role — Roles within circles

Meetings

• meeting — Meetings
• meeting_attendee — Meeting attendees
• meeting_recurring — Recurring meeting configurations
• meeting_step — Meeting steps and agenda items
• meeting_template — Meeting templates