Oniva GraphQL API

What is the GraphQL API?

The Oniva GraphQL API enables programmatic access to event data – without using the user interface. It is based on GraphQL, a flexible query language that lets you define precisely which data you need.

The GraphQL API is particularly well suited to more complex integrations where greater flexibility in querying data is required. For simpler, client-facing integrations, we recommend the REST API – it has a more purpose-built structure and is quicker to work with.

💡 Tip: Not sure which API is right for you? The comparison table at the end of this article will help you decide.

‍

What can you do with the GraphQL API?

Typical use cases for the GraphQL API include:

Event import: Retrieve event details to display upcoming events on other platforms.

Attendee access: Retrieve a guest list and check-in statuses – e.g. for on-site event management.

Custom integration: Develop tailored solutions for specific requirements that go beyond standard features.

‍

Accessing the GraphQL API

Endpoint URL

The base URL for accessing the API is:

/api/graphql

Authentication

An app token key is required to access the API:

• The app token key can be provided by Oniva support or created via the admin interface
• An app token always applies to all events within a workspace
• Event tokens and other authentication methods are available for user-specific integrations

‍

How it works

GraphQL requests fall into two types:

Queries: Retrieve data – e.g. event details or attendee information.

Mutations: Modify or create data – e.g. generating authentication tokens.

New to GraphQL? Learn GraphQL is a good place to start.

‍

Recommended tools

The following tools are well suited for exploring and testing the API:

GraphQL IDEsTools such as GraphiQL Online allow easy exploration of the API directly in your browser.

HTTP clientsRequests can also be sent using tools such as cURL or Postman.

Accessing the API documentation

The full technical documentation – including guides, examples, and explanations for developers – can be found in the Oniva GraphQL API documentation repository on GitHub:

Oniva GraphQL API Documentation