Skip to content
Convor
Convor Docs
API ReferenceVisitors

List visitors

Lists visitors for the current organization with pagination and optional filters for search, status, tags, blocked state, visit counts, and last-seen range.

GET/api/visitors

Lists visitors for the current organization with pagination and optional filters for search, status, tags, blocked state, visit counts, and last-seen range. When both page and offset are sent, page takes precedence. Use the returned pagination metadata rather than inferring another page from the item count. Filters and search are evaluated only against visitors in the authenticated organization.

Endpoint requirements

Credentials
Use either Bearer API key or X-API-Key header.
Required scope
visitors:read
Module
Automation & API module (api_access)
Organization and site scope
Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
Retry behavior
Safe read: You can safely retry this read-only request after a transport failure. It does not change resource state.

Query Parameters

limit?integer

Maximum number of resources to return.

Range1 <= value <= 100
Default20
page?integer

One-based page number.

Range1 <= value <= 9007199254740991
offset?integer

Zero-based number of resources to skip.

Range0 <= value <= 9007199254740991
Default0
search?string

Query parameter. Search text.

Lengthlength <= 200
status?string

Query parameter. Status. Allowed values: online, offline.

Value in

  • "online"
  • "offline"
tags?array<>

Query parameter. Tags assigned to this resource.

blocked?string

Query parameter. Value of blocked.

minVisits?integer

Query parameter. Value of minVisits.

Range0 <= value <= 9007199254740991
maxVisits?integer

Query parameter. Value of maxVisits.

Range0 <= value <= 9007199254740991
lastSeenFrom?string

Query parameter. ISO 8601 date and time for lastSeenFrom.

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
Formatdate-time
lastSeenTo?string

Query parameter. ISO 8601 date and time for lastSeenTo.

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
Formatdate-time
sortBy?string

Query parameter. Sort by. Allowed values: visitor, location, pages, timeOnSite, lastSeen, conversations, browserOs, tags.

Value in

  • "visitor"
  • "location"
  • "pages"
  • "timeOnSite"
  • "lastSeen"
  • "conversations"
  • "browserOs"
  • "tags"
sortDirection?string

Query parameter. Sort direction. Allowed values: asc, desc.

Value in

  • "asc"
  • "desc"
scope?"all"

DA-4035: alternative to X-Project-Id: all for the all-sites aggregate scope on read-only aggregate routes. Only all is accepted; any other value returns PROJECT_SCOPE_NOT_SUPPORTED (400).

Value in

  • "all"

Header Parameters

X-Project-Id?|

DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

{  "data": [    {      "id": "550e8400-e29b-41d4-a716-446655440000",      "orgId": "770e8400-e29b-41d4-a716-446655440000",      "projectId": "11111111-1111-4111-8111-111111111111",      "projectName": "Example name",      "identifier": "[email protected]",      "publicCode": "example",      "identitySource": "anonymous",      "identityVerifiedAt": "2026-08-04T10:00:00.000Z",      "fingerprint": "fp_123",      "firstSeenAt": "2026-06-20T08:00:00.000Z",      "lastSeenAt": "2026-06-23T08:00:00.000Z",      "totalSessions": 5,      "geoCountry": "US",      "geoCity": "New York",      "metadata": {},      "browser": {        "name": "Chrome",        "version": "126.0",        "userAgent": "example",        "isMobile": true,        "isTablet": true,        "isDesktop": true,        "os": "macOS",        "osVersion": "example"      },      "lastPage": "https://customer.example.org/pricing",      "isReturning": true,      "name": "Example name",      "email": "[email protected]",      "phone": "+48123456789",      "tags": [],      "blocked": false,      "conversationCount": 0,      "isActive": true,      "totalTimeOnSiteSeconds": 0,      "pageViewCount": 0    }  ],  "pagination": {    "totalItems": 1,    "page": 1,    "pageSize": 20,    "hasNextPage": false,    "hasPrevPage": false  }}

Request examples

curl

curl --request GET \
  'https://api.convor.io/api/visitors' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...'

JavaScript

const response = await fetch("https://api.convor.io/api/visitors", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer convor_sk_..."
  },
});

const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
  ? null
  : contentType.includes("json")
    ? await response.json()
    : contentType.startsWith("text/")
      ? await response.text()
      : await response.blob();

if (!response.ok) {
  const message = typeof data === "object" && data !== null
    && "error" in data && typeof data.error === "object"
    && data.error !== null && "message" in data.error
      ? String(data.error.message)
      : "Convor API request failed (" + response.status + ")";
  throw new Error(message);
}

console.log(data);

Was this page helpful?

Get visitor statistics

Returns visitor totals, online visitor count, new-versus-returning counts, and top countries for the requested period.

Merge duplicate visitor profiles

Atomically reassigns conversations, visitor messages, surveys, CSAT responses, and pending outbox records from one or more source visitors to the target.

On this page

Request examplescurlJavaScript