> ## Documentation Index > Fetch the complete documentation index at: https://docs.vacademy.io/llms.txt > Use this file to discover all available pages before exploring further. # List course pages for a sitemap > Every published course with its hosted page and a `lastmod`. Courses without a page address are left out. Scope: `catalog:read`. Cacheable for 60 s. ## OpenAPI ````yaml /api-reference/openapi.json get /sitemap openapi: 3.1.0 info: title: Vacademy Catalogue API version: 1.0.0 description: >- Read an institute's published courses, streams and learning paths for its own website, and send enquiries into its CRM. servers: - url: https://api.vacademy.ai/catalog/v1 security: - ApiKey: [] - Bearer: [] tags: - name: Site - name: Courses - name: Streams - name: Learning paths - name: Enquiries paths: /sitemap: get: tags: - Site summary: List course pages for a sitemap description: >- Every published course with its hosted page and a `lastmod`. Courses without a page address are left out. Scope: `catalog:read`. Cacheable for 60 s. operationId: getSitemap responses: '200': description: Every course page. headers: X-Request-Id: $ref: '#/components/headers/RequestId' Cache-Control: $ref: '#/components/headers/CacheControl' content: application/json: schema: $ref: '#/components/schemas/Sitemap' example: data: - url: >- https://learning.brahmvarchas.org/store/1750f895-5219-4b51-903e-93d271694653 type: course id: 1750f895-5219-4b51-903e-93d271694653 lastmod: '2026-10-14T20:40:51.277Z' - url: >- https://learning.brahmvarchas.org/store/1817b0b2-5096-4f05-a3f8-04b8a0abe2d0 type: course id: 1817b0b2-5096-4f05-a3f8-04b8a0abe2d0 lastmod: '2026-10-14T15:18:05.001Z' - url: >- https://learning.brahmvarchas.org/store/1e00c806-2eee-42bc-b8be-4070cb133c60 type: course id: 1e00c806-2eee-42bc-b8be-4070cb133c60 lastmod: '2026-10-14T10:43:00.738Z' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/RateLimited' '503': $ref: '#/components/responses/AuthUnavailable' components: headers: RequestId: schema: type: string description: Unique id of this request. Quote it to support. CacheControl: schema: type: string description: '`public, max-age=60` on reads; `no-store` on errors and `POST /leads`.' RetryAfter: schema: type: integer description: Seconds to wait before retrying. schemas: Sitemap: type: object properties: data: type: array items: $ref: '#/components/schemas/SitemapEntry' required: - data SitemapEntry: type: object properties: url: type: string description: Hosted course page (with the version query string). type: type: string enum: - course id: type: string description: Course id. lastmod: type: - string - 'null' format: date-time description: ISO-8601 UTC; the newest version's creation time. required: - url - type - id - lastmod Error: type: object properties: error: type: object properties: code: type: string example: not_found enum: - missing_api_key - invalid_api_key - product_not_enabled - insufficient_scope - origin_not_allowed - rate_limited - not_found - method_not_allowed - invalid_request - auth_unavailable - internal_error description: >- Stable machine-readable code. Branch on this, never on `message`. message: type: string description: A sentence for logs. Wording may change. request_id: type: string description: Also in the `X-Request-Id` header. Quote it to support. details: type: object additionalProperties: true description: >- Present only when there is more to say: `param` (invalid_request), `required_scope` (insufficient_scope), `origin` (origin_not_allowed), `limit_per_minute` (rate_limited). required: - code - message - request_id required: - error responses: Unauthorized: description: No key, or the key is not valid. headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/Error' examples: missing_api_key: value: error: code: missing_api_key message: >- Send your publishable key in the X-API-Key header (or Authorization: Bearer). request_id: req_3f2a9c1d7e5b4a608f1e2d3c4b5a6978 invalid_api_key: value: error: code: invalid_api_key message: This API key is invalid, revoked or expired. request_id: req_3f2a9c1d7e5b4a608f1e2d3c4b5a6978 Forbidden: description: >- The key may not make this request, or the browser origin is not one of the institute's verified websites. headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/Error' examples: origin_not_allowed: value: error: code: origin_not_allowed message: >- Add and verify preview-abc.vercel.app in Settings → Integrations → Catalogue API & websites to call this API from it. request_id: req_3f2a9c1d7e5b4a608f1e2d3c4b5a6978 details: origin: preview-abc.vercel.app insufficient_scope: value: error: code: insufficient_scope message: This API key does not have the leads:write scope. request_id: req_3f2a9c1d7e5b4a608f1e2d3c4b5a6978 details: required_scope: leads:write product_not_enabled: value: error: code: product_not_enabled message: This API key is not a Catalogue API key. request_id: req_3f2a9c1d7e5b4a608f1e2d3c4b5a6978 RateLimited: description: Too many requests for this key (or, on `POST /leads`, this visitor). headers: X-Request-Id: $ref: '#/components/headers/RequestId' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/Error' examples: rate_limited: value: error: code: rate_limited message: Too many requests for this API key (limit 1200 per minute). request_id: req_3f2a9c1d7e5b4a608f1e2d3c4b5a6978 details: limit_per_minute: 1200 AuthUnavailable: description: >- Keys could not be checked for a moment. Retry after `Retry-After` seconds. headers: X-Request-Id: $ref: '#/components/headers/RequestId' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/Error' examples: auth_unavailable: value: error: code: auth_unavailable message: Could not verify the API key right now. Retry shortly. request_id: req_3f2a9c1d7e5b4a608f1e2d3c4b5a6978 securitySchemes: ApiKey: type: apiKey in: header name: X-API-Key description: Your publishable Catalogue API key (`vak_pub_…`). Bearer: type: http scheme: bearer description: 'The same key as `Authorization: Bearer vak_pub_…`.' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.