Getting Started

We recommend the following 4 steps for getting started with the Unearth platform, however you're welcome to skip around and dive straight into the code in steps 3 & 4.

1. Get an Unearth account

To get a user account, go to Unearth's login screen and click the Start your trial button.

You'll likely also want a service account, which you can get by emailing support. But in the meantime the user account will get you going.

For more information on Authentication, read the How To Guides: Authentication and Service Delegation.

2. Familiarize yourself with Unearth

Unearth is a set of APIs but also has a web application and native mobile iOS and Android applications built on top of the APIs. These are available for customization and whitelabeling but they also serve as a great way to test the API capabilities and your own code.

For more information on how Unearth works, read the Unearth Overview and corresponding Concepts.

3. Dive into code samples

Using the Recipes section of the Developer Hub, you can see common use cases and corresponding code to enable your scenarios. Something you wish you saw? Just request it via Discussions and we'll get it posted for you in no time.

4. Start writing code using GraphiQL, GraphQL's user interface

Using your user credentials from step 1, you can go to GraphiQL and start exploring the APIs, make requests and see responses in real-time. You can learn more about using GraphiQL here

💬 We're here to help!

In the event you find yourself with additional questions or if you get stuck, you can use the Discussions section to leave a question or shoot us an email.

We're excited you're here!