> ## Documentation Index
> Fetch the complete documentation index at: https://developers.vizito.eu/llms.txt
> Use this file to discover all available pages before exploring further.

# Listing registered visitors

> Every registered visitor at a location. Unlike the visitor log this
endpoint also requires `sorting`; without it you get
`400 Please include count, page and sorting query parameters.`




## OpenAPI

````yaml https://vizito.eu/openapi.yaml get /knownvisitors/bycompany/{company_id}
openapi: 3.1.0
info:
  title: Vizito API
  version: 1.0.0
  description: |
    Read and write your Vizito visitor data over HTTPS.

    Every endpoint takes and returns JSON, and is authenticated with an API key
    created by a global admin on the Integrations page of the Backoffice.

    Almost every endpoint names a **location** — `company_id` in the API. Your
    key is pinned to a set of locations; naming one outside that set is refused
    with `403`. Start at `GET /companiesList`, the one endpoint that needs no
    location id.
  contact:
    name: Vizito support
    email: support@vizito.eu
    url: https://vizito.eu
  termsOfService: https://vizito.eu/terms
servers:
  - url: https://api.vizito.eu/api
    description: Production
security:
  - apiKey: []
tags:
  - name: Locations
    description: The locations your credential covers, and their configuration.
  - name: Visitors
    description: The visits themselves — one visitor is one visit, not a person.
  - name: Registered visitors
    description: Expected visitors — pre-register, invite, and sign in on arrival.
  - name: Hosts
    description: The people who can be visited.
  - name: Visit types
    description: The sign-in flows, and the questions they ask.
  - name: Entry points
    description: The doors and desks within a location.
  - name: Agreements
    description: The documents visitors sign, and the signed PDFs that come out.
  - name: Devices
    description: The kiosks at a location.
  - name: Reporting
    description: Counters, graphs and exports.
  - name: Webhooks
    description: The endpoint Vizito calls when something happens.
paths:
  /knownvisitors/bycompany/{company_id}:
    get:
      tags:
        - Registered visitors
      summary: Listing registered visitors
      description: |
        Every registered visitor at a location. Unlike the visitor log this
        endpoint also requires `sorting`; without it you get
        `400 Please include count, page and sorting query parameters.`
      operationId: listRegisteredVisitors
      parameters:
        - $ref: '#/components/parameters/companyId'
        - $ref: '#/components/parameters/count'
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/sorting'
        - $ref: '#/components/parameters/filter'
      responses:
        '200':
          description: One page of registered visitors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                  knownVisitors:
                    type: array
                    items:
                      $ref: '#/components/schemas/RegisteredVisitor'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    companyId:
      name: company_id
      in: path
      required: true
      description: The location.
      schema:
        $ref: '#/components/schemas/ObjectId'
    count:
      name: count
      in: query
      required: true
      description: Rows to return.
      schema:
        type: integer
        minimum: 1
        example: 50
    page:
      name: page
      in: query
      required: true
      description: 1-based page number.
      schema:
        type: integer
        minimum: 1
        example: 1
    sorting:
      name: sorting
      in: query
      required: false
      style: deepObject
      explode: true
      description: |
        Sort per field, as `sorting[signed_in]=desc`. `asc` or `desc`.
      schema:
        type: object
        additionalProperties:
          type: string
          enum:
            - asc
            - desc
    filter:
      name: filter
      in: query
      required: false
      style: deepObject
      explode: true
      description: >
        Filter per field, as `filter[company]=acme`. Values match
        case-insensitively

        on any part of the stored value. A date field takes a range instead:

        `filter[signed_in][startDate]` and `filter[signed_in][endDate]`, both
        ISO 8601.
      schema:
        type: object
        additionalProperties: true
  schemas:
    RegisteredVisitor:
      type: object
      description: |
        An expected visitor. Custom fields defined by the visit type are stored
        here too, under their own `field_name`, and carried onto the visit.
      additionalProperties: true
      properties:
        _id:
          $ref: '#/components/schemas/ObjectId'
        company_id:
          type: array
          items:
            $ref: '#/components/schemas/ObjectId'
        first_name:
          type: string
        last_name:
          type: string
        company:
          type: string
        email:
          type: string
          format: email
        phone:
          type: string
        recipient:
          type: string
        visit_type:
          $ref: '#/components/schemas/ObjectId'
        visiting_on:
          $ref: '#/components/schemas/VisitingOn'
        persistent:
          type: boolean
          description: Kept after the visit; never removed by data retention.
        language:
          type: string
          description: Language of the invitation email.
        pre_registration_by_visitor:
          type: boolean
          description: The visitor filled in their own details through the invitation.
        create_date:
          type: string
          format: date-time
        mod_date:
          type: string
          format: date-time
    ObjectId:
      type: string
      pattern: ^[0-9a-fA-F]{24}$
      description: A 24-character hexadecimal id.
      example: 5f2a1b9c4d3e2f0011223344
    VisitingOn:
      type: object
      description: When a visit is expected. Absent means "any day".
      properties:
        startDate:
          type: string
          format: date-time
        endDate:
          type: string
          format: date-time
    Message:
      type: object
      properties:
        message:
          type: string
  responses:
    BadRequest:
      description: The request was understood but could not be carried out.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Message'
    Unauthorized:
      description: |
        The credential was refused, or the endpoint is off limits to API keys.
        Every refusal answers identically — see the Authentication page.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: Invalid API key
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >
        An API key issued in the Backoffice, sent as `Authorization: Bearer
        vzk_<key id>_<secret>`.

        A Microsoft Entra ID access token obtained with the client credentials

        grant is accepted on the same header. The same value is also accepted in

        an `X-API-Key` header.

````

## Related topics

- [Listing expected visitors](/api-reference/registered-visitors/listing-expected-visitors.md)
- [Listing visitors](/api-reference/visitors/listing-visitors.md)
- [Listing visitors inside](/api-reference/visitors/listing-visitors-inside.md)
- [Listing visitors inside, paged](/api-reference/visitors/listing-visitors-inside-paged.md)
- [Fetching a registered visitor](/api-reference/registered-visitors/fetching-a-registered-visitor.md)
