Get Instance Clients

Endpoint

GET /v1/instance-integrations/:instanceIntegrationId/clients

Description

Fetches client data from a specific Listo instance's internal gateway. The installation must be properly configured for this endpoint to succeed.

Request

Path Parameters:

Parameter	Type	Required	Description
`instanceIntegrationId`	Public ID	Yes	The unique identifier of the instance integration

Headers:

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

Example Request:

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

Response

Success (200 OK):

Returns an array of client objects.

[
  {
    "id": "lglsocli_uZzu8GpG1f0qGKAyY",
		"name": "Client Name",
    "location": {
			"address1": "Address line one",
			"address2": "Address line two",
			"city": "Client's city",
			"isoCountryCode": "USA",
      "postalCode": "12345",
			"zoneCode": "CA"
		}
  },
]

Response Fields:

Field	Type	Description
`id`	Public Id	Unique identifier for the client
`name`	String	The name of the client
`location`	Object	Location details of the client
`location.address1`	String \| null	Client's address line one
`location.address2`	String \| null	Client's address line two
`location.city`	String \| null	Client's address city name
`location.postalCode`	String \| null	Client's address postal code
`location.zoneCode`	String \| null	Client's state or province code

Errors:

Status Code	Error	Solution
`400`	Bad Request	Ensure the instance integration ID is a valid public ID
`401`	Unauthorized	Verify your API key is correct
`404`	Not Found	The instance integration doesn't exist or isn't configured
`500`	Internal Server Error	Contact Listo support

Common 404 Error Messages:

"Instance integration not found" - The instance integration ID doesn't exist
"Instance integration not configured" - The instance integration exists but isn't properly set up