> ## 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. # Get site settings > The institute, where its course pages live, and the languages, formats, currency and price visibility of its catalogue. Use it to build filters. Scope: `catalog:read`. Cacheable for 60 s. ## OpenAPI ````yaml /api-reference/openapi.json get /site 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: /site: get: tags: - Site summary: Get site settings description: >- The institute, where its course pages live, and the languages, formats, currency and price visibility of its catalogue. Use it to build filters. Scope: `catalog:read`. Cacheable for 60 s. operationId: getSite responses: '200': description: The site. headers: X-Request-Id: $ref: '#/components/headers/RequestId' Cache-Control: $ref: '#/components/headers/CacheControl' content: application/json: schema: $ref: '#/components/schemas/Site' example: institute: id: 2719d8d1-43fd-4f9f-97af-a5b067d770a6 name: Brahm Varchas Shiksha logo_url: https://cdn.example.com/logo.png course_base_url: https://learning.brahmvarchas.org/store languages: - code: en label: English - code: hi label: Hindi formats: - key: elearning label: Interactive, self-paced E-learning - key: ebook label: E-books - key: live label: Live sessions - key: video label: Video - key: animation label: Short film / Animation - key: article label: Articles-essays - key: merch label: Merchandise (in collaboration) - key: audiobook label: Audio Book currency: INR price_visible: true '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: Site: type: object properties: institute: type: object properties: id: type: string name: type: - string - 'null' logo_url: type: - string - 'null' required: - id - name - logo_url course_base_url: type: - string - 'null' description: >- Where course pages live on the hosted site, e.g. `https://learning.brahmvarchas.org/store`. languages: type: array items: $ref: '#/components/schemas/Language' description: Course languages; empty when the site has them off. formats: type: array items: $ref: '#/components/schemas/Format' description: Every format the site defines, in display order. currency: type: - string - 'null' description: The most common currency across courses. price_visible: type: boolean description: False when the institute hides prices on its catalogue. required: - institute - course_base_url - languages - formats - currency - price_visible Language: type: object properties: code: type: string description: Lower-case language code from the site's settings, e.g. `en`, `hi`. label: type: string description: Display name, e.g. `Hindi`. required: - code - label Format: type: object properties: key: type: string description: >- Lower-case format key, e.g. `ebook`. Use it in `GET /courses?format=`. label: type: string description: Display name, e.g. `E-books`. required: - key - label 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.