Get Instance Integrations

Retrieve all instances associated with your external integration.


Endpoint

GET /v1/instance-integrations

Description

An instance integration represents a connection between your integration and a specific Listo instance. Use this endpoint to discover which Listo instances your integration has access to.

Request

Headers:

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

Example Request:

curl -X GET https://gateway.listoglobal.com/v1/instance-integrations \
  -H "x-api-key: your-api-key"

Response

Success (200 OK):

Returns an array of installation objects.

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

Response Fields:

Array of instance integrations:

FieldTypeDescription
idPublic IDUnique identifier for this installation
applicationInstanceObjectDetails about the Listo instance
applicationInstance.idPublic IDUnique Instance identifier
applicationInstance.instanceNameStringHuman-readable name of the instance
createdAtISO 8601When the installation was created
updatedAtISO 8601When the installation was last updated

Errors:

Status CodeErrorSolution
400Bad RequestCheck that your request is properly formatted
401UnauthorizedVerify your API key is correct
500Internal Server ErrorContact Listo support