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-hereExample 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:
| Field | Type | Description |
|---|---|---|
id | Public ID | Unique identifier for this installation |
applicationInstance | Object | Details about the Listo instance |
applicationInstance.id | Public ID | Unique Instance identifier |
applicationInstance.instanceName | String | Human-readable name of the instance |
createdAt | ISO 8601 | When the installation was created |
updatedAt | ISO 8601 | When the installation was last updated |
Errors:
| Status Code | Error | Solution |
|---|---|---|
400 | Bad Request | Check that your request is properly formatted |
401 | Unauthorized | Verify your API key is correct |
500 | Internal Server Error | Contact Listo support |
Updated about 2 months ago
