> ## 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 My Sync Appointments > Method that returns a specified number of appointments within a time range. The appointments belong to the currently logged on user. NsApiSlow threshold: 5000 ms. ## OpenAPI ````yaml /openapi/agent/openapi-v3-AppointmentAgent.json post /api/v1/Agents/Appointment/GetMySyncAppointments 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/GetMySyncAppointments: post: tags: - Appointment_Agent summary: Get My Sync Appointments description: "Method that returns a specified number of appointments within a time range.\n\nThe appointments belong to the currently logged on user.\r\nNsApiSlow threshold: 5000 ms." operationId: v1AppointmentAgent_GetMySyncAppointments 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.GetMySyncAppointmentsRequest text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetMySyncAppointmentsRequest application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetMySyncAppointmentsRequest text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetMySyncAppointmentsRequest application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetMySyncAppointmentsRequest application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetMySyncAppointmentsRequest application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetMySyncAppointmentsRequest description: StartTime, EndTime required: true responses: '200': description: OK content: application/json: schema: type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.AppointmentSyncData text/json: schema: type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.AppointmentSyncData application/xml: schema: type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.AppointmentSyncData text/xml: schema: type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.AppointmentSyncData application/json-patch+json: schema: type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.AppointmentSyncData application/merge-patch+json: schema: type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.AppointmentSyncData security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetMySyncAppointmentsRequest: description: >- GetMySyncAppointments: Method that returns a specified number of appointments within a time range. The appointments belong to the currently logged on user. type: object properties: StartTime: format: date-time type: string EndTime: format: date-time type: string SuperOffice.CRM.Services.AppointmentSyncData: description: "Carrier object for AppointmentSyncData.\r\nServices for the AppointmentSyncData Carrier is available from the Appointment Agent." type: object properties: AlarmTime: format: date-time description: Date and time at which to show alarm type: string AppointmentId: format: int32 description: Primary key type: integer AppointmentText: description: >- The appointment's textbox; holds a descriptive text about the appointment. Filled out by the user. type: string ContactDepartment: description: The department of the contact connected to the appointment type: string ContactFullName: description: The entire name of the contact, including department name type: string ContactName: description: The contact associated with the appointment. type: string ContactId: format: int32 description: The contacts identifier type: integer EndDate: format: date-time description: Date + end time planned type: string HasAlarm: description: Does this appointment have an alarm type: boolean IsAllDay: description: '' type: boolean IsAssignment: description: '' type: boolean IsBusy: description: '' type: boolean IsCompleted: description: '' type: boolean IsInvitation: description: '' type: boolean IsTentative: description: '' type: boolean 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 Participants: description: '' type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.ParticipantSyncData' PersonFormalName: description: '' type: string PersonFullName: description: The full name of the person this appointment belongs to. type: string PersonId: format: int32 description: Person ID of person the appointment is with, may be 0 type: integer ProjectId: format: int32 description: ID of project referred to, may be 0 type: integer ProjectName: description: Project name type: string SaleId: format: int32 description: Owning sale, if any (may be 0) type: integer SaleName: description: Sale heading (short description?) type: string StartDate: format: date-time description: date + start time planned type: string TaskName: 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.Services.ParticipantSyncData: description: "Carrier object for ParticipantSyncData.\r\nServices for the ParticipantSyncData Carrier is available from the Appointment Agent." type: object properties: PersonId: format: int32 description: Person ID of person the appointment is with, may be 0 type: integer PersonFirstName: description: First name type: string PersonMiddleName: description: Middle name or 'van' etc. type: string PersonLastname: description: Last name type: string PersonMrmrs: description: e.g. Mrs sex_title type: string PersonTitle: description: Title type: string PersonPosition: description: >- The position. This is a predefined SuperOffice value, different from Title type: string PersonAcademicTitle: description: >- Academic title, populated from Salutation list but can be overwritten with anything at all type: string PersonFormalName: description: >- Get formal name for a person, as used in labels. (Full name + person title + academic title) type: string PersonFullName: description: >- The person's full name localized to the current culture/country. (internal name used in clients for employees) type: string ContactId: format: int32 description: Contact ID of owning contact, may be 0 type: integer ContactName: description: Contact name type: string ContactDepartment: description: Department type: string ContactBusiness: description: >- The business that the contact is associated with. The GUI forces the user to enter a business type. type: string ContactCountry: description: '' type: string ContactCategory: description: >- The category that is set on the company. The GUI forces the user to enter a category type type: string ContactFullName: description: '' type: string EMail: description: '' type: array items: type: string PhonePrivate: description: >- Returns a collection of phone numbers that belong to the contact person. type: array items: type: string PhoneFax: description: >- Returns a collection of fax numbers that belong to the contact person. type: array items: type: string PhoneMobile: description: >- Returns a collection of mobile phone numbers that belong to the contact person. type: array items: type: string PhoneDirect: description: '' type: array items: type: string PhoneContact: description: >- Returns a collection of office phone numbers that belong to the contact person. type: array items: type: string Messenger: description: '' type: array items: type: string Voip: description: '' type: array items: type: string ContactUrl: description: The contact's internet adresses type: array items: type: string Url: description: The urls related to this person. type: array items: type: string StreetAddress: $ref: '#/components/schemas/SuperOffice.CRM.Services.AddressSyncData' PostalAddress: $ref: '#/components/schemas/SuperOffice.CRM.Services.AddressSyncData' Country: description: >- The country this contact is located in. The country a contact is saved with, affects the phone number format, and the address layout. type: string PersonAddress: $ref: '#/components/schemas/SuperOffice.CRM.Services.AddressSyncData' PersonCountry: description: The country this contact person is located in. type: string ParticipantStatus: description: The appointment status for this participant. enum: - UnknownOrPostIt - NotStarted - Started - Completed - Hidden - Booking - BookingMoved - BookingSeen - BookingMovedSeen - BookingDeclined - BookingDeleted - Assignment - AssignmentSeen - AssignmentDeclined 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.Services.AddressSyncData: description: "Carrier object for AddressSyncData.\r\nServices for the AddressSyncData Carrier is available from the Appointment Agent." type: object properties: AddressId: format: int32 description: Primary key type: integer AddressType: description: '' enum: - Unknown - ContactPostalAddress - ContactStreetAddress - PersonPrivateAddress - QuoteBillingAddress - QuoteShippingAddress type: string Address1: description: '' type: string Address2: description: '' type: string Address3: description: '' type: string City: description: '' type: string County: description: '' type: string ZipCode: description: '' type: string State: description: '' type: string Latitude: format: double description: '' type: number Longitude: format: double description: '' type: number FormattedAddress: 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.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 - [SuperOffice.WebApi.Data.Appointment GetMySyncAppointmentsRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Appointment_GetMySyncAppointmentsRequest.md) - [NSAppointmentAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSAppointmentAgent.md) - [SuperOffice.WebApi.Agents.AppointmentAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.AppointmentAgent.md) - [SuperOffice.WebApi.Agents.IAppointmentAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IAppointmentAgent.md) - [Get My Appointments](/en/api/reference/restful/agent/appointment_agent/get-my-appointments.md) - [Get My Published Appointments](/en/api/reference/restful/agent/appointment_agent/get-my-published-appointments.md)