Kintaba Help & Documentation

Kintaba Documentation

Welcome to the Kintaba's documentation hub. You'll find comprehensive guides and documentation to help you start working with Kintaba as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Getting Started with the API

Getting up and running with Kintaba's GraphQL API is easy! Follow this guide to set up a GraphQL playground environment where you can experiment with queries and mutations.

The GraphQL Endpoint

👍

The Kintaba GraphQL endpoint is

https://app.kintaba.com/api/graphql

Connect to GraphQL Playground

GraphQL playground is a great way to get started with the Kintaba API.

Download it here: https://github.com/prisma-labs/graphql-playground

You'll need to configure two http headers and the URL to get started

Header Name

Header Value

x-api-key

YOUR_KEY_ID

x-api-secret

YOUR_KEY_SECRET

Enter the API endpoint: https://app.kintaba.com/api/graphql

Once configured, your graphql playground interface should look something like this:

From this interface, you can write and run queries to experiment with the interface.

Self-Documented API Resources

GraphQL is a self documenting language. The easiest way to explore the API is to access the "Docs" interface of GraphQL.

From here you can browse all the functions and capabilities of the API, including queries, parameters, filters, and mutations.

Running API queries from cURL

GraphQL can be executed against the Kintaba API via cURL by wrapping the query into a json string.

For example, the following query lists all users in a Kintaba instance (NOTE: requires the "can see all users" permission in the API setup).

curl \
  -X POST \
  -H "Content-Type: application/json" \
  -u <YOUR_API_KEY>:<YOUR_API_SECRET>
  --data '{ "query": "{ viewer { company { users { edges { node { name email id } } } } } }" }' \
  https://app.kintaba.com/api/graphql

Running API queries from javascript or other languages

GraphQL queries can be run from any language. Refer to this guide from apollo.io for details: https://www.apollographql.com/blog/4-simple-ways-to-call-a-graphql-api-a6807bcdb355/

Getting Additional Help

Our team is here to help with any custom integration work you may be developing. Contact us at: [email protected] with any questions or via the chat link on all of our pages.

Updated 4 months ago

Getting Started with the API


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.