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

# Fetching a location

> The full configuration of one location: address, timezone, languages and
the `app_settings` block that drives the kiosk.

For backwards compatibility `app_settings` also carries a copy of the
location's first visit type. Read the settings you need rather than
diffing the whole object.




## OpenAPI

````yaml https://vizito.eu/openapi.yaml get /companies/{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:
  /companies/{company_id}:
    get:
      tags:
        - Locations
      summary: Fetching a location
      description: |
        The full configuration of one location: address, timezone, languages and
        the `app_settings` block that drives the kiosk.

        For backwards compatibility `app_settings` also carries a copy of the
        location's first visit type. Read the settings you need rather than
        diffing the whole object.
      operationId: getLocation
      parameters:
        - $ref: '#/components/parameters/companyId'
      responses:
        '200':
          description: The location.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationDetail'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    companyId:
      name: company_id
      in: path
      required: true
      description: The location.
      schema:
        $ref: '#/components/schemas/ObjectId'
  schemas:
    LocationDetail:
      allOf:
        - $ref: '#/components/schemas/Location'
        - type: object
          properties:
            address:
              type: string
            country:
              type: string
            timezone:
              type: string
              description: IANA timezone. Dates in reporting paths are read in it.
              example: Europe/Brussels
            languages:
              type: array
              items:
                type: string
            app_settings:
              type: object
              description: Kiosk and flow settings.
              additionalProperties: true
    ObjectId:
      type: string
      pattern: ^[0-9a-fA-F]{24}$
      description: A 24-character hexadecimal id.
      example: 5f2a1b9c4d3e2f0011223344
    Location:
      type: object
      properties:
        _id:
          $ref: '#/components/schemas/ObjectId'
        name:
          type: string
          example: Head office
        location_code:
          type: string
          description: Your own short code for the location.
          example: HQ
        tier:
          type: string
          enum:
            - Starter
            - Standard
            - Pro
            - Enterprise
        mod_date:
          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
    NotFound:
      description: No such object, or a location your credential does not cover.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Message'
  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

- [Fetching the webhook](/api-reference/webhooks/fetching-the-webhook.md)
- [Fetching statistics](/api-reference/reporting/fetching-statistics.md)
- [Fetching a device](/api-reference/devices/fetching-a-device.md)
- [Fetching an agreement](/api-reference/agreements/fetching-an-agreement.md)
- [Fetching the dashboard](/api-reference/reporting/fetching-the-dashboard.md)