---
title: "Get workspace GST settings · Workspace · Practice Manager API · COUNT Partner API"
description: "Returns the workspace’s GST configuration, normalized. GET /firm-partners/workspace/workspace/gst-settings"
canonical: "https://developers.getcount.com/practice-manager/reference/workspace/get-workspace-gst-settings"
source: "https://developers.getcount.com/practice-manager/reference/workspace/get-workspace-gst-settings"
---
[Workspace](https://developers.getcount.com/practice-manager/reference/workspace) / Get workspace GST settings

# Get workspace GST settings

GET `/firm-partners/workspace/workspace/gst-settings`

Returns the workspace’s GST configuration, normalized.

Values are normalized on the way out, so you always get a concrete `filingFrequency` and `accountingBasis` even when the workspace has never saved them — the defaults reported here (`monthly`, `invoice`) are the ones the GST engine actually applies. `taxRegime` is `NZ_GST` for New Zealand workspaces and null elsewhere.

HMAC signature only

[Opening Balance](https://developers.getcount.com/practice-manager/reference/opening-balance) [Workspace Stats](https://developers.getcount.com/practice-manager/reference/workspace-stats)

#### Headers

`count-workspace-id` uuid required

UUID of the client workspace to act on. It must be one of your firm's client workspaces (or the firm's own workspace) and within the API key's client workspaces.

#### Responses

`200` The workspace’s GST settings.

`400` The `count-workspace-id` header is missing.

`401` Missing signing headers, an invalid HMAC signature, or a timestamp more than 5 minutes off. [Troubleshoot](https://developers.getcount.com/practice-manager/authentication#errors)

`403` The key is inactive or its scope does not allow this request, the workspace is not managed by your firm or is outside the key's client workspaces, the workspace has no active subscription, or it is portal-only and the route needs bookkeeping. [Troubleshoot](https://developers.getcount.com/practice-manager/authentication#errors)

`404` No workspace exists with the `count-workspace-id` UUID.

`429` Rate limit exceeded (100 requests per minute per firm user of each app, or 10,000 per minute per app). [Troubleshoot](https://developers.getcount.com/practice-manager/authentication#errors)

[Previous PATCH Update workspace](https://developers.getcount.com/practice-manager/reference/workspace/update-workspace) [Next PATCH Update workspace GST settings](https://developers.getcount.com/practice-manager/reference/workspace/update-workspace-gst-settings)

GET `https://api.getcount.com/firm-partners/workspace/workspace/gst-settings`

Request

```javascript
import crypto from 'node:crypto';

const BASE_URL = 'https://api.getcount.com';
const CLIENT_ID = process.env.COUNT_CLIENT_ID;
const CLIENT_SECRET = process.env.COUNT_CLIENT_SECRET;

const method = 'GET';
const signingPath = '/workspace/workspace/gst-settings';
const timestamp = Math.floor(Date.now() / 1000).toString();
const bodyString = '';

const bodyHash = '';
const baseString = `${method}:${signingPath}:${timestamp}:${bodyHash}`;
const signature = crypto.createHmac('sha256', CLIENT_SECRET).update(baseString).digest('hex');

const response = await fetch(`${BASE_URL}/firm-partners/workspace/workspace/gst-settings`, {
  method,
  headers: {
    'x-client-id': CLIENT_ID,
    'x-timestamp': timestamp,
    'x-signature': signature,
    'count-workspace-id': '5e4d3c2b-1a09-4f8e-8d7c-6b5a49382716',
  },
});

console.log(await response.json());
```

Response · 200

```json
{
  "status": "success",
  "message": "Success on retrieving workspace GST settings",
  "data": {
    "gstSettings": {
      "enabled": true,
      "irdNumber": "123-456-789",
      "filingFrequency": "2-monthly",
      "accountingBasis": "invoice",
      "taxRegime": "NZ_GST",
      "accountingBasisLocked": false
    }
  }
}
```
