# Espaço de trabalho

> Verifique em qual workspace uma chave pertence, e leia sua moeda, fuso horário, país e termos de imposto.

## Obtenha o workspace

**GET** `/api/v1/workspace`

Retorna o workspace ao qual a chave pertence, mais o nome e o escopo da própria chave. Chame uma vez quando sua integração iniciar, para verificar a chave e coletar a moeda.

Nenhum parâmetro.

```bash
curl https://tradecatalog.app/api/v1/workspace \
  -H "Authorization: Bearer $TRADECATALOG_API_KEY"
```

```js
const res = await fetch('https://tradecatalog.app/api/v1/workspace', {
  headers: { Authorization: `Bearer ${process.env.TRADECATALOG_API_KEY}` },
})
const { data: workspace } = await res.json()
```

```json
{
  "data": {
    "id": "0b6c1f5e-6f7a-4a57-9a0c-2f4d4c1e8a11",
    "slug": "northgate",
    "name": "Northgate Fixings",
    "currency": "GBP",
    "timezone": "Europe/London",
    "country": "GB",
    "taxLabel": "ex VAT",
    "key": { "name": "Sage stock sync", "scope": "write" }
  }
}
```

| Campo       | Tipo   | Descrição                                                                                         |
| ----------- | ------ | ------------------------------------------------------------------------------------------------- |
| `id`        | string | O id do workspace.                                                                                |
| `slug`      | string | O endereço do workspace. O portal comercial está em `https://tradecatalog.app/p/{slug}`.          |
| `name`      | string | O nome pelo qual os clientes conhecem o negócio.                                                  |
| `currency`  | string | Código ISO 4217. Todos os preços estão em unidades menores dessa moeda.                           |
| `timezone`  | string | Fuso horário IANA, por exemplo `Europe/London`. As datas na API são em UTC.                       |
| `country`   | string | Código de país ISO 3166, por exemplo `GB`. Como o fornecedor escreve preços e datas.              |
| `taxLabel`  | string | Exibido ao lado dos preços: “ex VAT” (antes do imposto), “inc GST” (incluindo imposto), ou vazio. |
| `key.name`  | string | O nome que o proprietário deu a essa chave.                                                       |
| `key.scope` | string | `read` ou `write`.                                                                                |
