---
title: Approvals
description: The 3 operations under approvals, as typed calls on the generated REST client.
---

{/* GENERATED by scripts/sdk-reference/generate.mjs from scripts/api-reference/openapi-snapshot.json. Do not edit: run `npm run docs:sdk:generate`. */}

# Approvals

Available from `@codespar/sdk` 0.12.0; the version on npm is 0.12.0. Every example on this page is compiled against the installed package when these docs build: a call that does not type-check fails the build.

Every call below is `cs.api` reaching one operation of the OpenAPI document this page was generated from; the [REST client overview](/docs/api/sdk/rest-client) explains `request`, `response`, the option bag and the errors. The values are placeholders shaped by the document.

```ts twoslash
import { CodeSpar } from "@codespar/sdk";

const cs = new CodeSpar({ apiKey: process.env.CODESPAR_API_KEY });
```

### GET `/v1/approvals/health`

<Endpoint method="GET" path="/v1/approvals/health" />

Approval queue health

```ts twoslash
import { CodeSpar } from "@codespar/sdk";
const cs = new CodeSpar({ apiKey: "csk_test_0000" });
// ---cut---
const result = await cs.api.get("/v1/approvals/health");
```

Parameters, body and every documented response: [GET /v1/approvals/health in the HTTP reference](/docs/api/reference/approvals#get-v1approvalshealth).

### GET `/v1/approvals/{id}`

<Endpoint method="GET" path="/v1/approvals/{id}" />

Read one approval

```ts twoslash
import { CodeSpar } from "@codespar/sdk";
const cs = new CodeSpar({ apiKey: "csk_test_0000" });
// ---cut---
const result = await cs.api.get("/v1/approvals/{id}", {
  path: {
    id: "approval_0000000000000000"
  }
});
```

Parameters, body and every documented response: [GET /v1/approvals/\{id\} in the HTTP reference](/docs/api/reference/approvals#get-v1approvalsid).

### GET `/v1/approvals/{id}/status`

<Endpoint method="GET" path="/v1/approvals/{id}/status" />

Poll a held call for its outcome

```ts twoslash
import { CodeSpar } from "@codespar/sdk";
const cs = new CodeSpar({ apiKey: "csk_test_0000" });
// ---cut---
const result = await cs.api.get("/v1/approvals/{id}/status", {
  path: {
    id: "approval_0000000000000000"
  }
});
```

Parameters, body and every documented response: [GET /v1/approvals/\{id\}/status in the HTTP reference](/docs/api/reference/approvals#get-v1approvalsidstatus).