---
updatedAt: 2025-10-12T20:27:51.000Z
agentTools:
  projectIndex: https://docs.checkhq.com/llms.txt
---

# Get a workplace

Returns the specified workplace.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "check-api",
    "version": "2025-01-01"
  },
  "servers": [
    {
      "url": "https://sandbox.checkhq.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "x-bearer-format": "bearer",
        "x-default": "YOUR_API_KEY"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/workplaces/{workplace}": {
      "get": {
        "summary": "Get a workplace",
        "description": "Returns the specified workplace.",
        "operationId": "get-a-workplace",
        "parameters": [
          {
            "name": "workplace",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": {
                      "id": "wrk_Cjy24FaEY59iyC7MM6Yg",
                      "name": "Office",
                      "address": {
                        "line1": "36 E 30th St",
                        "line2": null,
                        "city": "New York",
                        "state": "NY",
                        "postal_code": "10016",
                        "country": "US"
                      },
                      "company": "com_GlAxMQVO1ZJ0BNbO6pss",
                      "active": true,
                      "metadata": {}
                    }
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "example": "wrk_Cjy24FaEY59iyC7MM6Yg"
                    },
                    "name": {
                      "type": "string",
                      "example": "Office"
                    },
                    "address": {
                      "type": "object",
                      "properties": {
                        "line1": {
                          "type": "string",
                          "example": "36 E 30th St"
                        },
                        "line2": {
                          "type": "string"
                        },
                        "city": {
                          "type": "string",
                          "example": "New York"
                        },
                        "state": {
                          "type": "string",
                          "example": "NY"
                        },
                        "postal_code": {
                          "type": "string",
                          "example": "10016"
                        },
                        "country": {
                          "type": "string",
                          "example": "US"
                        }
                      }
                    },
                    "company": {
                      "type": "string",
                      "example": "com_GlAxMQVO1ZJ0BNbO6pss"
                    },
                    "active": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    },
                    "metadata": {
                      "type": "object",
                      "properties": {}
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```