Returns the full visitor record, including browser details, page history, and selected metadata-derived fields.

GET/api/visitors/{id}

Returns the full visitor record, including browser details, page history, and selected metadata-derived fields.

Endpoint requirements

Credentials: Use either Bearer API key or X-API-Key header.
Required scope: visitors:read
Module: Automation & API module (automation_api)
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.

Path Parameters

id*string

Resource identifier.

Response Body

`application/json`

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "orgId": "770e8400-e29b-41d4-a716-446655440000",
  "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",
  "name": "Example name",
  "email": "[email protected]",
  "phone": "+48123456789",
  "tags": [],
  "conversationCount": 0,
  "isActive": true,
  "totalTimeOnSiteSeconds": 0,
  "metadata": {},
  "createdAt": "2026-06-20T08:00:00.000Z",
  "updatedAt": "2026-06-23T08:00:00.000Z",
  "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,
  "pageJourney": [
    {
      "url": "https://customer.example.org/pricing",
      "visitedAt": "2026-06-23T08:00:00.000Z"
    }
  ],
  "userAgent": "Mozilla/5.0",
  "screenResolution": "1440x900",
  "language": "en-US",
  "notes": [],
  "conversationHistory": []
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

Request examples

curl

curl --request GET \
  'https://api.convor.io/api/visitors/550e8400-e29b-41d4-a716-446655440000' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...'

JavaScript

const response = await fetch("https://api.convor.io/api/visitors/550e8400-e29b-41d4-a716-446655440000", {
  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 by ID

Returns the full visitor record, including browser details, page history, and selected metadata-derived fields.

GET/api/visitors/{id}

Returns the full visitor record, including browser details, page history, and selected metadata-derived fields.

Endpoint requirements

Credentials: Use either Bearer API key or X-API-Key header.
Required scope: visitors:read
Module: Automation & API module (automation_api)
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.

Path Parameters

id*string

Resource identifier.

Response Body

`application/json`

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "orgId": "770e8400-e29b-41d4-a716-446655440000",
  "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",
  "name": "Example name",
  "email": "[email protected]",
  "phone": "+48123456789",
  "tags": [],
  "conversationCount": 0,
  "isActive": true,
  "totalTimeOnSiteSeconds": 0,
  "metadata": {},
  "createdAt": "2026-06-20T08:00:00.000Z",
  "updatedAt": "2026-06-23T08:00:00.000Z",
  "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,
  "pageJourney": [
    {
      "url": "https://customer.example.org/pricing",
      "visitedAt": "2026-06-23T08:00:00.000Z"
    }
  ],
  "userAgent": "Mozilla/5.0",
  "screenResolution": "1440x900",
  "language": "en-US",
  "notes": [],
  "conversationHistory": []
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

Request examples

curl

curl --request GET \
  'https://api.convor.io/api/visitors/550e8400-e29b-41d4-a716-446655440000' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...'

JavaScript

const response = await fetch("https://api.convor.io/api/visitors/550e8400-e29b-41d4-a716-446655440000", {
  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 by ID

Endpoint requirements

Path Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Request examples

curl

JavaScript

On this page

Get visitor by ID

Endpoint requirements

Path Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Request examples

curl

JavaScript

On this page

Get visitor by ID

Endpoint requirements

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

On this page

Get visitor by ID

Endpoint requirements

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`