> ## 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 Associates Diary Info > Fetch appointment info for given associates NsApiSlow threshold: 2000 ms. ## OpenAPI ````yaml /openapi/agent/openapi-v3-AppointmentAgent.json post /api/v1/Agents/Appointment/GetAssociatesDiaryInfo 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/GetAssociatesDiaryInfo: post: tags: - Appointment_Agent summary: Get Associates Diary Info description: |- Fetch appointment info for given associates NsApiSlow threshold: 2000 ms. operationId: v1AppointmentAgent_GetAssociatesDiaryInfo 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.GetAssociatesDiaryInfoRequest text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetAssociatesDiaryInfoRequest application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetAssociatesDiaryInfoRequest text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetAssociatesDiaryInfoRequest application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetAssociatesDiaryInfoRequest application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetAssociatesDiaryInfoRequest application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetAssociatesDiaryInfoRequest description: AssociateIds, StartTime, EndTime required: true responses: '200': description: OK content: application/json: schema: type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.AppointmentInfo text/json: schema: type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.AppointmentInfo application/xml: schema: type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.AppointmentInfo text/xml: schema: type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.AppointmentInfo application/json-patch+json: schema: type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.AppointmentInfo application/merge-patch+json: schema: type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.AppointmentInfo security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.AppointmentCarriers.GetAssociatesDiaryInfoRequest: description: 'GetAssociatesDiaryInfo: Fetch appointment info for given associates' type: object properties: AssociateIds: type: array items: format: int32 type: integer StartTime: format: date-time type: string EndTime: format: date-time type: string SuperOffice.CRM.Services.AppointmentInfo: description: "Info about an appointment\r\n\r\nCarrier object for AppointmentInfo.\r\nServices for the AppointmentInfo Carrier is available from the Appointment Agent." type: object properties: AppointmentId: format: int32 description: The id of the appointment type: integer AssociateId: format: int32 description: The id of the associate this appointment belongs to type: integer MotherId: format: int32 description: The id of the mother appointment (participants point to this one) type: integer StartDate: format: date-time description: The start of the appointment type: string EndDate: format: date-time description: The end of the appointment type: string ColorIndex: description: The color index of the appointment (task) enum: - LightBlue - DarkBlue - LightGray - DarkGray - LightGreen - DarkGreen - LightYellow - DarkYellow - LightRed - DarkRed - BlueAlt1 - BlueAlt2 - BlueAlt3 - GrayAlt1 - GrayAlt2 - GrayAlt3 - GreenAlt1 - GreenAlt2 - GreenAlt3 - YellowAlt1 - YellowAlt2 - YellowAlt3 - RedAlt1 - RedAlt2 - RedAlt3 type: string TaskName: description: The name of the appointment task type type: string ContactName: description: The name of the appointment contact. type: string ProjectName: description: The name of the appointment project type: string Title: description: The appointment title (first line of appointment description) type: string Agenda: description: The appointment agenda (the rest of appointment description) type: string IsAllDay: description: True if the appointment is an all day appointment type: boolean IsBusy: description: True if the participant is marked as busy type: boolean IsRecurring: description: True if the appointment is part of a recurring series type: boolean IsVideoMeeting: description: True if the appointment has a video link type: boolean HasAlarm: description: True if the appointment has alarm type: boolean IsCompleted: description: True if the appointment is completed type: boolean IsTentative: description: True if the appointment is tentative type: boolean IsBookingMain: description: True if the appointment is a main booking type: boolean SendEmail: description: True if the appointment record has the email flag set type: boolean AnySendEmail: description: True if any of the appointment records has the email flag set type: boolean IsPrivate: description: True if only visible for the owner type: boolean RecurrenceInfo: $ref: '#/components/schemas/SuperOffice.CRM.Services.RecurrenceInfo' PersonName: description: The name of the appointment person. type: string IsBooking: description: True if the appointment is part of a booking type: boolean OwnedExternally: description: Set if an external system owns this appointment. enum: - None - Other - Outlook - Google type: string MotherAssociateId: format: int32 description: Associate/owner of the mother appointment 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.RecurrenceInfo: description: Class representing the recurrence of an appointment booking type: object properties: RecurrenceId: format: int32 description: The recurrence rule id type: integer StartDate: format: date-time description: Start date of the repetition pattern type: string EndDate: format: date-time description: "End date of the repetition pattern\r\nOnly used when the end is calculated from a end date. {SuperOffice.Data.RecurrenceEndType.EndDate}" type: string RecurrenceCounter: format: int32 description: "Number of recurrences\r\nOnly used when the end is calculated from a number of repetitions. {SuperOffice.Data.RecurrenceEndType.Counter}" type: integer RecurrenceEndType: description: >- Type defining how the end of the recurrence sequence should be calculated enum: - Unknown - EndDate - Counter type: string Pattern: description: The recurrence pattern (Daily, Weekly, Monthly, Yearly, Custom) enum: - Unknown - Daily - Weekly - Monthly - Yearly - Custom type: string DayPattern: $ref: '#/components/schemas/SuperOffice.CRM.Services.RecurrenceDayPattern' WeekPattern: $ref: '#/components/schemas/SuperOffice.CRM.Services.RecurrenceWeekPattern' MonthPattern: $ref: '#/components/schemas/SuperOffice.CRM.Services.RecurrenceMonthPattern' YearPattern: $ref: '#/components/schemas/SuperOffice.CRM.Services.RecurrenceYearPattern' Dates: description: List of all dates where this recurrence occurs type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.RecurrenceDate' IsRecurrence: description: >- Get a or set IsRecurrence, indicating if this is a repeating appointment or not. type: boolean 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.RecurrenceDayPattern: description: Class representing a pattern for daily recurrence type: object properties: Pattern: description: The type of daily recurrence pattern enum: - Unknown - EveryWorkday - EveryWeekday - EveryCyclicDay type: string Cycle: format: int32 description: "The number of days between each recurrence.\r\nOnly used when the cyclic pattern occurs. {SuperOffice.Data.RecurrenceDailyPattern.EveryCyclicDay}" type: integer SuperOffice.CRM.Services.RecurrenceWeekPattern: description: Class representing a pattern for weekly recurrence type: object properties: Weekdays: description: The weekdays the recurrence should occur for enum: - Unknown - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday type: string Cycle: format: int32 description: The number of weeks between each repetition type: integer SuperOffice.CRM.Services.RecurrenceMonthPattern: description: Class representing a pattern for monthly recurrence type: object properties: Pattern: description: The type of monthly recurrence pattern enum: - Unknown - DayOfMonth - WeekdayOfMonth type: string Cycle: format: int32 description: The number of months between each repetition type: integer Day: format: int32 description: "The day of the month when the recurrence occurs\r\nOnly used when the weekday of month pattern occurs. \r\n{SuperOffice.Data.RecurrenceMonthlyPattern.DayOfMonth}{SuperOffice.Data.RecurrenceYearlyPattern.DayOfMonth}" type: integer Weekday: description: "The weekday of the recurring pattern. \r\nOnly used when the weekday of month pattern occurs. \r\n{SuperOffice.Data.RecurrenceMonthlyPattern.WeekdayOfMonth}{SuperOffice.Data.RecurrenceYearlyPattern.WeekdayOfMonth}" enum: - Unknown - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday type: string WeekOfMonth: description: "The week of the month\r\nOnly used when the weekday of month pattern occurs. \r\n{SuperOffice.Data.RecurrenceMonthlyPattern.WeekdayOfMonth}{SuperOffice.Data.RecurrenceYearlyPattern.WeekdayOfMonth}" enum: - Unknown - First - Second - Third - Fourth - Last type: string SuperOffice.CRM.Services.RecurrenceYearPattern: description: Class representing a pattern for yearly recurrence type: object properties: Pattern: description: The type of yearly recurrence pattern enum: - Unknown - DayOfMonth - WeekdayOfMonth type: string Cycle: format: int32 description: >- The month of the year where the recurrence occurs. 1 is January and 12 is December. type: integer Day: format: int32 description: "The day of the month when the recurrence occurs\r\nOnly used when the weekday of month pattern occurs. \r\n{SuperOffice.Data.RecurrenceMonthlyPattern.DayOfMonth}{SuperOffice.Data.RecurrenceYearlyPattern.DayOfMonth}" type: integer Weekday: description: "The weekday of the recurring pattern. \r\nOnly used when the weekday of month pattern occurs. \r\n{SuperOffice.Data.RecurrenceMonthlyPattern.WeekdayOfMonth}{SuperOffice.Data.RecurrenceYearlyPattern.WeekdayOfMonth}" enum: - Unknown - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday type: string WeekOfMonth: description: "The week of the month\r\nOnly used when the weekday of month pattern occurs. \r\n{SuperOffice.Data.RecurrenceMonthlyPattern.WeekdayOfMonth}{SuperOffice.Data.RecurrenceYearlyPattern.WeekdayOfMonth}" enum: - Unknown - First - Second - Third - Fourth - Last type: string SuperOffice.CRM.Services.RecurrenceDate: description: Class representing a Date for recurrence. type: object properties: Date: format: date-time description: Date of the recurrence. type: string IsConflict: description: Is there a conflict for this occurrence. type: boolean Description: description: Conflict or day (e.g. red, blue, etc. letter-day) name. type: string DescriptionStyleHint: description: Style hint for the description (i.e. red for red-letter-days) type: string Tooltip: description: Description of conflict or other things happening this day. type: string 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 GetAssociatesDiaryInfoRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Appointment_GetAssociatesDiaryInfoRequest.md) - [Get Associates Diary](/en/api/reference/restful/agent/appointment_agent/get-associates-diary.md) - [Get Associate Diary](/en/api/reference/restful/agent/appointment_agent/get-associate-diary.md) - [Get Activity Information List By Dates And Associate](/en/api/reference/restful/agent/appointment_agent/get-activity-information-list-by-dates-and-associate.md) - [SuperOffice.WebApi.Data.Appointment GetAssociateDiaryRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Appointment_GetAssociateDiaryRequest.md) - [SuperOffice.WebApi.Data.Appointment GetAssociatesDiaryRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Appointment_GetAssociatesDiaryRequest.md)