# Workplaces

Part of the [Proof API](/api/proof/index.md). Host: `https://api.geodynamics.dev`.

The workplaces in your environment, as Proof knows them. Read-only over the public API: workplaces are created and maintained inside Proof itself.

The `identification` is the handle to use elsewhere. Setting the workplaces on a group takes identifications, not ids.

## GET /proof/v1/workplace/list

`https://api.geodynamics.dev/proof/v1/workplace/list`

Privilege required: `public:scope:workplace:read`

Get workplaces

Returns a paged list of the workplaces in the key's environment, 100 per page.

Use `identification` when you set the workplaces on a group. `internalCode` is your own code for the workplace, if one was set in Proof.

### Query parameters

| Name | Type | Required | Example |
| --- | --- | --- | --- |
| `page` Zero-based page index. Defaults to 0. | integer | optional | `0` |

### Responses

#### 200: OK

| Field | Type |
| --- | --- |
| `items` Workplaces on this page. | array |
| `filter` Paging state for this query. | object |

```json
{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "identification": "WP-0042",
      "name": "Antwerp North site",
      "address": "Noorderlaan 1, 2030 Antwerpen",
      "description": "Main northern construction site",
      "internalCode": "EQ-ANR-N"
    }
  ],
  "filter": {
    "page": 0,
    "pageSize": 100,
    "totalCount": 1,
    "sortAscending": true,
    "sortString": "",
    "searchString": ""
  }
}
```

#### 401: Unauthorized. Missing or invalid service key.

#### 403: Forbidden. The key lacks the required scope.