> ## Documentation Index > Fetch the complete documentation index at: https://docs.digitalseaservice.com/llms.txt > Use this file to discover all available pages before exploring further. # Read a vessel's official sea-service calendar ## OpenAPI ````yaml /api-reference/openapi.json get /v1/me/vessels/{vessel_id}/calendar openapi: 3.1.0 info: title: DSS Public API description: >- Public OAuth 2.0 API for Digital Sea Service. See https://docs.digitalseaservice.com for the developer guide. version: 1.0.0 contact: name: DSS Developer Support email: admin@digitalseaservice.com url: https://docs.digitalseaservice.com license: name: Proprietary termsOfService: https://digitalseaservice.com/terms servers: - url: https://api.digitalseaservice.com description: Production - url: https://api.dev.digitalseaservice.com description: Sandbox (dev) security: [] paths: /v1/me/vessels/{vessel_id}/calendar: get: tags: - calendar summary: Read a vessel's official sea-service calendar operationId: get_vessel_calendar_v1_me_vessels__vessel_id__calendar_get parameters: - name: vessel_id in: path required: true schema: type: string title: Vessel Id - name: from in: query required: true schema: type: string description: Range start, YYYY-MM-DD. title: From description: Range start, YYYY-MM-DD. - name: to in: query required: true schema: type: string description: Range end, YYYY-MM-DD. Max 400 days. title: To description: Range end, YYYY-MM-DD. Max 400 days. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/VesselCalendarResponse' '400': description: '`invalid_request` — a query parameter (e.g. cursor) was malformed.' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '401': description: >- `invalid_token` — bearer token missing, malformed, expired, or revoked. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '403': description: '`insufficient_scope` — the token lacks the required scope.' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '422': description: >- `invalid_request` — request validation failed; see the `errors` array. content: application/problem+json: schema: $ref: '#/components/schemas/ValidationProblemDetails' '429': description: '`rate_limit_exceeded` — per-client request budget exhausted.' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '500': description: >- `internal_error` — an unexpected error occurred; reference `instance`. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' security: - oauth2: - calendar:read - bearerAuth: [] components: schemas: VesselCalendarResponse: properties: vessel_id: type: string title: Vessel Id entries: items: $ref: '#/components/schemas/CalendarDay' type: array title: Entries ais_hints: items: $ref: '#/components/schemas/CalendarHint' type: array title: Ais Hints crew: items: $ref: '#/components/schemas/CalendarCrew' type: array title: Crew type: object required: - vessel_id - entries - ais_hints - crew title: VesselCalendarResponse ProblemDetails: type: object description: >- RFC 7807 Problem Details. Returned with the `application/problem+json` content type on every resource (`/v1/*`) error. properties: type: type: string format: uri description: Stable URL identifying the error type; resolves to its docs page. title: type: string description: Short, human-readable summary of the error type. status: type: integer description: HTTP status code. detail: type: string description: Explanation specific to this occurrence. instance: type: string description: Request correlation id; matches the `X-Request-Id` header. required: - type - title - status - detail - instance ValidationProblemDetails: description: Problem Details for a 422, carrying a per-field `errors` array. allOf: - $ref: '#/components/schemas/ProblemDetails' - type: object properties: errors: type: array description: One entry per field that failed validation. items: type: object additionalProperties: true CalendarDay: properties: date: type: string title: Date day_type: type: string title: Day Type notes: type: string title: Notes default: '' source: anyOf: - type: string - type: 'null' title: Source description: >- `ais` when premium tracking filled the day, `manual` when someone set it. ais_day_type: anyOf: - type: string - type: 'null' title: Ais Day Type description: AIS classification for this date when tracking has one. conflict: type: boolean title: Conflict default: false type: object required: - date - day_type title: CalendarDay description: One official vessel-calendar day. example: ais_day_type: Sea conflict: false date: '2026-04-01' day_type: Sea notes: '' source: ais CalendarHint: properties: date: type: string title: Date effective_state: type: string title: Effective State ais_day_type: anyOf: - type: string - type: 'null' title: Ais Day Type type: object required: - date - effective_state title: CalendarHint description: AIS classification for a date that has no saved calendar row yet. CalendarCrew: properties: name: type: string title: Name sign_on: type: string title: Sign On sign_off: anyOf: - type: string - type: 'null' title: Sign Off description: Null while the crew member is still aboard. watchkeeping: type: boolean title: Watchkeeping watchkeeping_start_date: anyOf: - type: string - type: 'null' title: Watchkeeping Start Date type: object required: - name - sign_on - watchkeeping title: CalendarCrew description: Read-only roster context for the vessel calendar. Not editable here. securitySchemes: oauth2: type: oauth2 description: >- OAuth 2.0 Authorization Code flow with PKCE. See the integration guide at docs.digitalseaservice.com for the full step-by-step. flows: authorizationCode: authorizationUrl: https://api.digitalseaservice.com/oauth/authorize tokenUrl: https://api.digitalseaservice.com/oauth/token refreshUrl: https://api.digitalseaservice.com/oauth/token scopes: profile:read: Read the crew member's name, role, country, and photo URL. seatime:read: Read aggregate sea-time totals and the 12-month trend. vessels:read: Read the crew member's vessel history. calendar:read: >- Read a vessel's official sea-service calendar, including AIS days, notes, sign-on, sign-off, and watchkeeping. calendar:write: >- Edit a vessel's official sea-service calendar: day type, notes, and delete. Vessel admin only. bearerAuth: type: http scheme: bearer bearerFormat: Opaque ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.