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

# Get Alarms

> NsApiSlow threshold: 2000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-AppointmentAgent.json post /api/v1/Agents/Appointment/GetAlarms
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - AppointmentAgent
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Agents/Appointment/GetAlarms:
    post:
      tags:
        - Appointment_Agent
      summary: Get Alarms
      description: 'NsApiSlow threshold: 2000 ms.'
      operationId: v1AppointmentAgent_GetAlarms
      parameters:
        - name: $select
          in: query
          description: >-
            Optional comma separated list of properties to include in the
            result. Other fields are then nulled out to reduce payload size:
            "Name,department,category". Default = show all fields.
          required: false
          schema:
            type: string
        - name: Accept-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code.
          required: false
          schema:
            type: string
        - name: SO-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code. Overrides Accept-Language value.
          required: false
          schema:
            type: string
        - name: SO-Culture
          in: header
          description: >-
            Number, date formatting in a specified culture (iso2 language) code.
            Partially overrides SO-Language/Accept-Language value. Ignored if no
            Language set.
          required: false
          schema:
            type: string
        - name: SO-TimeZone
          in: header
          description: >-
            Specify the timezone code that you would like date/time responses
            converted to.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetAlarmsRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetAlarmsRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetAlarmsRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetAlarmsRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetAlarmsRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetAlarmsRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetAlarmsRequest
        description: >-
          IncludeInvitations, IncludeAllAppointments,
          DefaultAlarmLeadTimeInMinutes
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.MultiAlarmData'
            text/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.MultiAlarmData'
            application/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.MultiAlarmData'
            text/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.MultiAlarmData'
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.MultiAlarmData'
            application/merge-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.MultiAlarmData'
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetAlarmsRequest:
      description: 'GetAlarms:'
      type: object
      properties:
        IncludeInvitations:
          type: boolean
        IncludeAllAppointments:
          type: boolean
        DefaultAlarmLeadTimeInMinutes:
          format: int32
          type: integer
    SuperOffice.CRM.Services.MultiAlarmData:
      description: "Carrier object for MultiAlarmData.\r\nServices for the MultiAlarmData Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IAppointmentAgent\">Appointment Agent</see>."
      type: object
      properties:
        Alarms:
          description: ''
          type: array
          items:
            $ref: '#/components/schemas/SuperOffice.CRM.Services.AlarmData'
        PollingInterval:
          format: int32
          description: ''
          type: integer
        SilentAfter:
          format: int32
          description: ''
          type: integer
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.AlarmData:
      description: "Carrier object for AlarmData.\r\nServices for the AlarmData Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IAppointmentAgent\">Appointment Agent</see>."
      type: object
      properties:
        AppointmentId:
          format: int32
          description: Primary key
          type: integer
        StartTime:
          format: date-time
          description: date + start time planned
          type: string
        EndDate:
          format: date-time
          description: Date + end time planned
          type: string
        AlarmTime:
          format: date-time
          description: ''
          type: string
        PersonId:
          format: int32
          description: Person ID of person the appointment is with, may be 0
          type: integer
        PersonFullName:
          description: >-
            The associate's culture formatted fullname (firstname, middleName
            and lastname)
          type: string
        ContactName:
          description: Contact name
          type: string
        ProjectId:
          format: int32
          description: ID of project referred to, may be 0
          type: integer
        ProjectName:
          description: Project name
          type: string
        AppointmentText:
          description: >-
            The actual text, max 2047 significant characters even though it is
            stored as a larger data type on some databases
          type: string
        SaleId:
          format: int32
          description: Owning sale, if any (may be 0)
          type: integer
        SaleName:
          description: ''
          type: string
        Location:
          description: >-
            Location for appointment, defaulted from invited resource of type
            place and other rules, but you can write anything you want here
          type: string
        AppointmentType:
          description: where=no start time,note,docin, docout
          enum:
            - Unknown
            - inDiary
            - inChecklist
            - Note
            - Document
            - SavedReport
            - BookingForDiary
            - BookingForChecklist
            - MergeDraft
            - MergeFinal
          type: string
        ContactId:
          format: int32
          description: Contact ID of owning contact, may be 0
          type: integer
        AssignmentStatus:
          description: >-
            Status if this appointment is in the process of being assigned to
            someone else
          enum:
            - Unknown
            - None
            - Assigning
            - Seen
            - Declined
          type: string
        InvitationStatus:
          description: Status if this appointment represents an invitation
          enum:
            - Unknown
            - None
            - Accepted
            - Hidden
            - Invitation
            - Moved
            - Seen
            - MovedSeen
            - Declined
            - Cancelled
          type: string
        BookingType:
          description: The type of booking the appointment represents
          enum:
            - Unknown
            - None
            - Owner
            - Participant
          type: string
        FormalName:
          description: >-
            The associate's culture formatted formalname (firstname, middleName
            and lastname, title, mrmrs)
          type: string
        TaskName:
          description: ''
          type: string
        ContactDepartment:
          description: Department
          type: string
        ContactFullName:
          description: ''
          type: string
        JoinVideomeetUrl:
          description: ''
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Security.TableRight:
      description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string
    SuperOffice.CRM.Security.FieldProperty:
      description: >-
        Class holding properties like field length, field type about a field in
        the carrier.
      type: object
      properties:
        FieldRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight'
        FieldType:
          type: string
        FieldLength:
          format: int32
          description: ''
          type: integer
    SuperOffice.CRM.Security.FieldRight:
      description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string

````

## Related topics

- [NSAlarmData](/en/automation/crmscript/reference/CRMScript.NetServer.NSAlarmData.md)
- [NSMultiAlarmData](/en/automation/crmscript/reference/CRMScript.NetServer.NSMultiAlarmData.md)
- [SuperOffice.WebApi.Data.Appointment GetAlarmsRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Appointment_GetAlarmsRequest.md)
- [NSAppointment](/en/automation/crmscript/reference/CRMScript.NetServer.NSAppointment.md)
- [NSAppointmentEntity](/en/automation/crmscript/reference/CRMScript.NetServer.NSAppointmentEntity.md)
- [NSAppointmentSyncData](/en/automation/crmscript/reference/CRMScript.NetServer.NSAppointmentSyncData.md)