Skip to main content

Authentication

Acquiring an API Key​

Visit the Getting Started with Gomu page for more information on how to obtain your API key, once you have your API key, you are ready to start using the API.

Using your API key​

By using and server-side programming language, you can make requests to either the Gomu REST or Gomu GraphQL endpoints. Requests should target the domain https://api.gomu.co/ followed by the type of API endpoint that you are interested in e.g. https://api.gomu.co/rest or https://api.gomu.co/graphql.

For both the REST and GraphQL API you should supply your API key in a custom header named gomu-api-key with the value being the provided key.

Example

gomu-api-key: {API_KEY}

Note on API limits​

Your API limits will be pre-configured during your onboarding process, should you need to adjust those limits, please reply that email or let us know through our combined slack.