Quickstart

From zero to your first valid response in four steps.

1. Prepare credentials

The API uses HTTP Basic Authentication. The username is the pair user|company (your IntelliTracer login, pipe, company code). The password is your IntelliTracer password. For a production integration, create a dedicated service user inside IntelliTracer and use those credentials, not your personal account.

Don't have the credential string yet? The credential formatter encodes user|company:password client-side into the header you need below. Nothing leaves your browser.

In the examples below we use the placeholder YWxpY2V8YWNtZTpodW50ZXIy. Replace it with your own value.

2. First request

Fetch the list of resource groups. This endpoint returns a small payload quickly and is a good sanity check.

curl https://api.geodynamics.dev/api/v1/resourcegroups \
  -H "Authorization: Basic YWxpY2V8YWNtZTpodW50ZXIy" \
  -H "Accept: application/json"

The same in Node with fetch:

const res = await fetch(
  "https://api.geodynamics.dev/api/v1/resourcegroups",
  {
    headers: {
      Authorization: "Basic YWxpY2V8YWNtZTpodW50ZXIy",
      Accept: "application/json",
    },
  },
);

if (!res.ok) {
  throw new Error(`${res.status} ${res.statusText}`);
}

const groups = await res.json();
console.log(groups);

And in Python with requests:

import requests

res = requests.get(
    "https://api.geodynamics.dev/api/v1/resourcegroups",
    headers={
        "Authorization": "Basic YWxpY2V8YWNtZTpodW50ZXIy",
        "Accept": "application/json",
    },
    timeout=10,
)
res.raise_for_status()

groups = res.json()
print(groups)

3. Verify the response

A successful call returns HTTP 200 and a JSON array of resource groups. Each object carries a stable Id, a Name, and optionally a Code.

[
  {
    "Id": "a7c1f3b0-0e7c-4f1a-9d51-2b6f0a1e83cf",
    "Name": "Site crews",
    "Code": "WERF"
  },
  {
    "Id": "5d2a98e1-71a3-43b8-95ae-1f0c1c6e2d44",
    "Name": "Warehouse",
    "Code": "MAG"
  }
]

Got a different status code back? See Errors & retries. The most common ones:

• 401: credentials are wrong. Check that you have user|company:password (pipe, not a colon, between user and company).
• 403: credentials work, but your user is missing the Api: Resource read privilege. Ask an IntelliTracer admin to grant it.
• 429: too many requests. Wait the number of seconds in the Retry-After header.

4. Build further

• Read Authentication for the OAuth 2.1 + PKCE flow if you want end users signed in to your app.
• Open the REST API reference for the full endpoint catalogue.
• Check Rate limits for your request budget per identity.