---
title: "candidate.listClientInfo"
method: POST
path: "/candidate.listClientInfo"
tags: ["Candidate"]
---

# candidate.listClientInfo

`POST /candidate.listClientInfo`

Lists client information records (IP, user agent) collected for a candidate.

**Requires the [`candidatesRead`](authentication#permissions-candidatelistclientinfo) permission.**

## Request body

- CandidateListClientInfoRequest
  - `candidateId` string, uuid, required — The id of the candidate to fetch client info for
  - `cursor` string, nullable — Opaque cursor indicating which page of results to fetch
  - `syncToken` string, nullable — An opaque token representing the last time the data was successfully synced from the API. A new, updated one is returned after successfully fetching the last page of data.
  - `limit` number, nullable — The maximum number of items to return. The maximum and default value is 100.

## Response `200`

Responses from the candidate.listClientInfo endpoint

- union
  - CandidateListClientInfoSuccessResponse
    - `success` true, required
    - `results` ClientInfo[], required
      - `id` string, uuid, required — The ID of this client information record
      - `ipAddress` string, nullable — The IP address (v4 or v6) that the client used to interact with the system
      - `userAgent` string, nullable — The user agent that was received from the client when it interacted with the system
      - `relatedEntityType` 'application' | 'blocked_application_submission' | 'meeting_availability_request', required — The type of the entity that the client interacted with
      - `relatedEntityId` string, uuid, required — The ID of the entity that was related to the client interaction
      - `candidateId` string, uuid, required — The ID of the candidate that interacted with the system
      - `createdAt` string, nullable — When this client info record was created
    - `nextCursor` string — Cursor for the next page of results, if available
    - `moreDataAvailable` boolean — Whether more data is available beyond this page
    - `syncToken` string — Sync token to use for future incremental syncs. Only present on the last page.
  - ErrorResponse
    - `success` false, required
    - `errors` ErrorDetail[], required
      - `message` string, required
      - `parameter` string

---

[API](https://skmtc.net/ashbyhq/apis/ashby-api.md) · [All operations](https://skmtc.net/ashbyhq/apis/ashby-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ashbyhq/ashby-api/revisions/778b919dc743/schema)