---
updatedAt: 2026-05-27T00:39:46.000Z
agentTools:
  projectIndex: https://docs.trybadge.com/llms.txt
---

# Create workspace

An organization API key is required for workspace creation, request one by contacting Badge support.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Badge API",
    "version": "0"
  },
  "servers": [
    {
      "url": "https://api.trybadge.com/v0"
    }
  ],
  "security": [
    {
      "WorkspaceAuth": []
    }
  ],
  "tags": [
    {
      "name": "Organization"
    }
  ],
  "paths": {
    "/workspaces": {
      "post": {
        "operationId": "workspaceCreate",
        "security": [
          {
            "OrganizationAuth": []
          }
        ],
        "tags": [
          "Organization"
        ],
        "summary": "Create workspace",
        "description": "An organization API key is required for workspace creation, request one by contacting Badge support.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "name",
                  "timezone",
                  "companyInfo"
                ],
                "properties": {
                  "name": {
                    "type": "string",
                    "minLength": 5,
                    "description": "The name used to identify the workspace. Should be unique."
                  },
                  "companyInfo": {
                    "$ref": "#/components/schemas/CompanyInfo"
                  },
                  "timezone": {
                    "type": "string",
                    "minLength": 3,
                    "description": "IANA timezone identifier, e.g. 'America/New_York', 'Europe/London', 'Asia/Tokyo'."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "apiKey",
                    "id",
                    "portalUrl"
                  ],
                  "properties": {
                    "apiKey": {
                      "type": "string"
                    },
                    "id": {
                      "type": "string"
                    },
                    "portalUrl": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400ErrorMessage"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "WorkspaceAuth": {
        "type": "http",
        "scheme": "bearer"
      },
      "OrganizationAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "CompanyInfo": {
        "type": "object",
        "description": "Company info is displayed as the issuer details on the back of passes.",
        "required": [
          "name",
          "address",
          "supportEmail"
        ],
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "address": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "minItems": 1,
            "description": "An array of strings, where each string represents a single line of the company's address."
          },
          "supportEmail": {
            "type": "string",
            "format": "email",
            "description": "This will be displayed to users for customer support inquiries."
          }
        }
      }
    },
    "responses": {
      "400ErrorMessage": {
        "description": "Invalid input was received.",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "message"
              ],
              "properties": {
                "message": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
```