Getting Started

Authentication

All API requests require an API key. Include it in the request header like this:

x-api-key: your-64-character-api-key-here

Getting an API key: Contact the Listo team to get one for your integration.

Security: Never commit your API key to version control or share it publicly.

Base URL

All API requests go to:

https://gateway.listoglobal.com

Your First Request

Here's how to fetch all installations for your integration:

cURL

curl -X GET https://gateway.listoglobal.com/v1/external-integration/installations \
  -H "x-api-key: your-64-character-api-key-here"

JavaScript

const response = await fetch(
  'https://gateway.listoglobal.com/v1/external-integration/installations',
  {
    method: 'GET',
    headers: {
      'x-api-key': 'your-64-character-api-key-here'
    }
  }
);

const installations = await response.json();
console.log(installations);

Python

import requests

url = 'https://gateway.listoglobal.com/v1/external-integration/installations'
headers = {'x-api-key': 'your-64-character-api-key-here'}

response = requests.get(url, headers=headers)
installations = response.json()

Response Format

All responses are JSON.

Success (200 OK)

[
  {
    "id": "lggtwini_uZzrSgaCCW6mCUrtq",
    "applicationInstance": {
      "id": "lggtwapi_uZzsaKAh8KbixPLq9",
      "instanceName": "Production Instance"
    },
    "createdAt": "2025-01-15T10:30:00.000Z",
    "updatedAt": "2025-01-15T10:30:00.000Z",
  }
]

Error Response

{
  "statusCode": 401,
  "message": "Invalid API key"
}

HTTP Status Codes

Code	Meaning	Description
`200`	OK	Request successful
`400`	Bad Request	Invalid parameters (check UUID format, etc.)
`401`	Unauthorized	Missing or invalid API key
`404`	Not Found	Resource doesn't exist
`500`	Internal Server Error	Server error - contact support

Support

Need help? Contact the Listo team for support.