> ## 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 agreements of a visit type

> The active agreements a visitor of that visit type has to sign.



## OpenAPI

````yaml https://vizito.eu/openapi.yaml get /companies/{company_id}/visittypes/{visit_type_id}/agreements
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}/visittypes/{visit_type_id}/agreements:
    get:
      tags:
        - Agreements
      summary: Listing agreements of a visit type
      description: The active agreements a visitor of that visit type has to sign.
      operationId: listAgreementsOfVisitType
      parameters:
        - $ref: '#/components/parameters/companyId'
        - name: visit_type_id
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/ObjectId'
        - name: group_only
          in: query
          required: false
          description: >-
            `true` also returns agreements shown only to the person signing in a
            group.
          schema:
            type: boolean
        - $ref: '#/components/parameters/languageId'
      responses:
        '200':
          description: The agreements.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Agreement'
        '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'
    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
    Agreement:
      type: object
      additionalProperties: true
      properties:
        _id:
          $ref: '#/components/schemas/ObjectId'
        name:
          type: string
        active:
          type: boolean
        type:
          type: string
          enum:
            - text
            - pdf
            - video
        agreement_text:
          type: object
          description: The text, keyed by language code.
          additionalProperties:
            type: string
        visit_types:
          type: array
          items:
            $ref: '#/components/schemas/ObjectId'
        version:
          type: integer
          description: Bumped when the content changes.
        index:
          type: integer
        expiry_days:
          type: integer
          description: How long a signature stays valid.
        group_only:
          type: boolean
    Message:
      type: object
      properties:
        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
    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

- [Listing visit types](/api-reference/visit-types/listing-visit-types.md)
- [Listing visit types of a device](/api-reference/devices/listing-visit-types-of-a-device.md)
- [Listing agreements](/api-reference/agreements/listing-agreements.md)
- [Listing visitors](/api-reference/visitors/listing-visitors.md)
- [Listing recent visits](/api-reference/visitors/listing-recent-visits.md)