---
title: "Return API build/version metadata"
method: GET
path: "/api/v1/version"
tags: ["Me"]
---

# Return API build/version metadata

`GET /api/v1/version`

## Request

- Base URL: `https://api.hub-equity.com`
- URL: `https://api.hub-equity.com/api/v1/version`
- Auth: HTTP bearer

Answers without a key so that client SDKs can check version compatibility before calling the API. `git_commit` helps support diagnose build-specific behaviour. An admin caller also receives `config`, the behaviour configuration resolved by this process.

## Response `200`

Successful Response

- ApiResponseVersionResponse
  - `success` boolean, required
  - `data` VersionResponse: API build / version metadata.
    - `version` string, required: API version, e.g. '1.0'
    - `api_prefix` string, required: API path prefix, e.g. '/api/v1'
    - `git_commit` string, nullable: Short commit SHA of the running build, when known.
    - `served_at` string, date-time: Server-side timestamp at the moment of the call.
    - `config` object, nullable: Behaviour configuration as this API process resolves it. Admin callers only: null for anonymous and for ordinary authenticated callers.
  - `error` ApiError: API error details.
    - `code` string, required
    - `message` string, required
    - `details` object, nullable
  - `meta` ApiMeta: API response metadata. Pagination fields (``page`` / ``per_page`` / ``total``) are populated on collection endpoints only. They are omitted from the payload on single-resource endpoints.
    - `timestamp` string, date-time
    - `request_id` string, nullable
    - `page` integer, nullable
    - `per_page` integer, nullable
    - `total` integer, nullable
  - `links` ApiLinks: HATEOAS-style pagination cursors. Host-relative path + query links for a collection page. Present on collection endpoints, ``null`` fields where a page doesn't exist (``next`` on the last page, ``prev`` on the first). The whole ``links`` object is omitted from single-resource responses (see ``ApiResponse`` serializer).
    - `self` string, nullable
    - `first` string, nullable
    - `prev` string, nullable
    - `next` string, nullable
    - `last` string, nullable

---

[API](https://skmtc.dev/hub-equity/apis/hub-equity-api.md) · [All operations](https://skmtc.dev/hub-equity/apis/hub-equity-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hub-equity/apis/hub-equity-api/revisions/e8eeda5dc13e?raw)