Introduction

The GIMLabs API lets your own systems read the data you already hold in GIMLabs, without anyone logging in and clicking Export. It is a plain HTTP API returning JSON, so anything that can make a web request can use it: a Python script, Power BI, a GIS pipeline, or a scheduled sync into your data warehouse.

Base URL#

https://api.gimlabs.io/v1

Every endpoint in these docs is relative to that.

What you can do today#

• List your projects and drill into one
• List the locations in a project, with coordinates, ground level and final depth
• Read any table (GEOL, SAMP, ISPT and so on) for a project or a single location

Everything is read-only. There is no way to create, change or delete data through the API, which means an API key can never damage your project.

What it is not#

It is not a replacement for Log or Manage. There is no import endpoint, no export endpoint and no webhooks yet. If you need to get data into GIMLabs, that is still Log, Manage or an AGS import.

Availability#

The API is a Pro feature. Companies on Go do not have access; Pro and legacy licences do. Keys are minted by a Super Admin in Product OS.

Where to go next#

• Quickstart - your first borehole in about a minute
• Authentication - keys, scopes and project limits
• Conventions - envelopes, paging and rate limits
• Endpoints - the full reference
• Errors - every error type and what to do about it