> ## 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 fields

> Every question asked at a location, merged across its visit types. This
is what tells you which keys a visitor or registered visitor accepts.

A custom field's value is stored under its `field_name`, so two visit
types defining the same name share one key on the visit.
`split_by_visit_type=true` gives each its own column instead.




## OpenAPI

````yaml https://vizito.eu/openapi.yaml get /companies/{company_id}/fields
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:
  /companies/{company_id}/fields:
    get:
      tags:
        - Visit types
      summary: Listing fields
      description: |
        Every question asked at a location, merged across its visit types. This
        is what tells you which keys a visitor or registered visitor accepts.

        A custom field's value is stored under its `field_name`, so two visit
        types defining the same name share one key on the visit.
        `split_by_visit_type=true` gives each its own column instead.
      operationId: listFields
      parameters:
        - $ref: '#/components/parameters/companyId'
        - name: visit_types
          in: query
          required: false
          description: Restrict to one or more visit type ids.
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ObjectId'
        - $ref: '#/components/parameters/languageId'
        - name: split_by_visit_type
          in: query
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: The fields.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Field'
        '403':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    companyId:
      name: company_id
      in: path
      required: true
      description: The location.
      schema:
        $ref: '#/components/schemas/ObjectId'
    languageId:
      name: language_id
      in: query
      required: false
      description: Language for configured text, e.g. `nl`. Falls back to English.
      schema:
        type: string
        example: en
  schemas:
    ObjectId:
      type: string
      pattern: ^[0-9a-fA-F]{24}$
      description: A 24-character hexadecimal id.
      example: 5f2a1b9c4d3e2f0011223344
    Field:
      type: object
      properties:
        field_name:
          type: string
          description: The key you send and read.
          example: badgenumber
        field_description:
          type: string
          description: The label as the visitor sees it.
        column_title:
          type: string
          description: The label as the Backoffice column is headed.
        field_content_type:
          type: string
          enum:
            - text
            - number
            - list
            - check
            - yes_no
            - datetime
        field_status:
          type: string
          enum:
            - required
            - optional
            - hidden
            - disabled
          description: Enforced in the front office, not by this API.
        visit_type_id:
          $ref: '#/components/schemas/ObjectId'
        list_values:
          type: array
          items:
            type: object
            properties:
              value_name:
                type: string
                description: What you send.
              value_description:
                type: string
                description: What the visitor reads.
              is_default:
                type: boolean
        field_validation:
          type: object
          properties:
            regex:
              type: string
            message:
              type: string
  responses:
    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 visitors](/api-reference/visitors/listing-visitors.md)
- [Listing registered visitors](/api-reference/registered-visitors/listing-registered-visitors.md)
- [Listing hosts, paged](/api-reference/hosts/listing-hosts-paged.md)
- [Listing visitors inside, paged](/api-reference/visitors/listing-visitors-inside-paged.md)
- [Listing expected visitors](/api-reference/registered-visitors/listing-expected-visitors.md)