Skip to main content
POST
Get Workspace
Use this API to retrieve details of an existing Velt workspace.
This endpoint uses workspace-level auth: pass x-velt-workspace-id and x-velt-workspace-auth-token (from the Create Workspace response) as headers.

Endpoint

POST https://api.velt.dev/v2/workspace/get

Headers

x-velt-workspace-id
string
required
Your workspace ID.
x-velt-workspace-auth-token
string
required
Your workspace Auth Token. The legacy x-velt-auth-token header is still accepted as a fallback.

Body

Params

data
object
required
Empty data object.

Example Request

Example Response

Success Response

apiKeyList is a keyed object (not an array). Each key is the API key ID. To extract the first API key, use Object.keys(result.data.apiKeyList)[0] in JavaScript or iterate over the object keys.

Failure Response

If workspace not found