Get Client Workers

Endpoint

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

Description

Fetches workers data of a specific Listo instance's client.

Request

Path Parameters:

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

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/lglsocli_uZzu8GpG1f0qGKAyY/workers \
  -H "x-api-key: your-api-key"

Response

Success (200 OK):

Returns an array of workers objects.

[
  {
    "id": "lglsowpr_uZzCmZmYXq9PoAGDC",
    "firstName": "Worker",
    "lastName": "Name",
    "fullName": "Worker Name",
    "email": "[email protected]",
    "jobTitles": ["Software developer"],
    "phone": "+19193334444",
    "location": {
      "address1": "Address line one",
      "address2": "Address line two",
      "city": "Worker's city",
      "isoCountryCode": "USA",
      "postalCode": "12345",
      "zoneCode": "CA"
    }
  }
]

Response Fields:

Field	Type	Description
`id`	Public ID	The unique identifier for the worker
`firstName`	String	Worker's first name
`lastName`	String	Worker's last name
`fullName`	String	Worker's full name
`email`	String	Worker's email address
`jobTitles`	String[]	Worker's registered job titles
`phone`	String \| null	Worker's phone number
`location`	Object	Location details of the worker
`location.address1`	String \| null	Worker's address line one
`location.address2`	String \| null	Worker's address line two
`location.city`	String \| null	Worker's address city
`location.isoCountryCode`	String \| null	Worker's country ISO code
`location.postalCode`	String \| null	Worker's location postal code
`location.zoneCode`	String \| null	Worker's state or province code

Errors:

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