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

# Get workspace GST settings

GET `/partners/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 + Bearer access token

[Try this request](https://developers.getcount.com/tools/try-it?method=GET&path=%2Fpartners%2Fworkspace%2Fgst-settings)

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

#### Responses

`200` The workspace’s GST settings.

`401` Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token. [Troubleshoot](https://developers.getcount.com/getting-started/errors#error-401)

`403` The credential does not have access to this workspace or resource. [Troubleshoot](https://developers.getcount.com/getting-started/errors#error-403)

`429` Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header. [Troubleshoot](https://developers.getcount.com/getting-started/errors#error-429)

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

GET `https://api.getcount.com/partners/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 ACCESS_TOKEN = process.env.COUNT_ACCESS_TOKEN;

const method = 'GET';
const signingPath = '/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}/partners/workspace/gst-settings`, {
  method,
  headers: {
    'x-client-id': CLIENT_ID,
    'x-timestamp': timestamp,
    'x-signature': signature,
    Authorization: `Bearer ${ACCESS_TOKEN}`,
  },
});

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
    }
  }
}
```