Home›REST API›How to get API information

How to get API information

Retrieve the tenant GUID and API URL your Interact instance needs for REST API requests.

Overview

The Interact API requires certain information that is not available through the application: the TenantGuid that uniquely identifies your site in the Interact infrastructure, and the API URL used to send requests.

Get the information

The simplest way to retrieve this information is to hit the /info endpoint in your browser. For example, navigating to https://{{intranet_url}}/info returns:

{
    "ApiDomain": "eu-trials-lb-api-01.interactgo.com",
    "AuthMode": "saml",
    "TenantGuid": "e822a190-a116-4779-ad0a-87631b51898a",
    "SamlProviderName": "Azure",
    "Name": "developer",
    "MarketApiPath": "/market",
    "EnableEmailAuthentication": true,
    "EnableSmsAuthentication": true,
    "TelemetryApiEndpoint": "https://analytics-cdn.interactgo.com/eu-api/telemetry"
}

Only two of these fields are needed to call the REST API: ApiDomain and TenantGuid. The remaining fields describe your site's configuration — such as the authentication mode and enabled features — and can be ignored here.

Response fields

Field Description
ApiDomain The API URL your requests use as their base.
TenantGuid The unique identifier for your site. Send it in the X-Tenant header on every request.

Tip: Together these give a request everything it needs — the base URL (ApiDomain) and the X-Tenant header value (TenantGuid). See Get a list of all users for both in use.

Section: REST API