Workspaces

REST API — All endpoints require authentication via Bearer token. Include Authorization: Bearer {token} in every request. Tokens are managed in GitScrum Settings → API. Base URL: https://services.gitscrum.com — All request paths in this documentation are relative to this base URL.

Workspaces are the top-level container in GitScrum. Every project, member, and resource belongs to a workspace.

List workspaces

GET /companies

Returns all workspaces the authenticated user belongs to.

curl -X GET https://services.gitscrum.com/companies \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json"

Response 200 OK

{
  "data": [
    {
      "slug": "acme-corp",
      "name": "Acme Corp",
      "logo": "https://cdn.gitscrum.com/logos/acme.png",
      "header_logo": "https://cdn.gitscrum.com/logos/acme-header.png",
      "header_color": "#1a1a2e",
      "favicon": "https://cdn.gitscrum.com/favicons/acme.ico",
      "owner": {
        "name": "Jane Smith",
        "username": "janesmith"
      },
      "settings": {
        "timezone": "America/New_York",
        "language": "en"
      }
    }
  ]
}

Get workspace

GET /companies/{slug}

Returns full workspace details.

Path parameters

curl -X GET https://services.gitscrum.com/companies/acme-corp \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json"

Response 200 OK

{
  "data": {
    "slug": "acme-corp",
    "name": "Acme Corp",
    "logo": "https://cdn.gitscrum.com/logos/acme.png",
    "header_logo": "https://cdn.gitscrum.com/logos/acme-header.png",
    "header_color": "#1a1a2e",
    "favicon": "https://cdn.gitscrum.com/favicons/acme.ico",
    "owner": {
      "name": "Jane Smith",
      "username": "janesmith"
    },
    "settings": {
      "timezone": "America/New_York",
      "language": "en"
    }
  }
}

Create workspace

POST /companies

Creates a new workspace.

Request body

curl -X POST https://services.gitscrum.com/companies \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "New Workspace"
  }'

Update workspace

PUT /companies/{slug}

Updates workspace settings.

Path parameters

Request body

curl -X PUT https://services.gitscrum.com/companies/acme-corp \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Corporation"
  }'

Delete workspace

DELETE /companies/{slug}

Permanently deletes a workspace and all its data. This action cannot be undone.

Path parameters

curl -X DELETE https://services.gitscrum.com/companies/acme-corp \
  -H "Authorization: Bearer {token}"

Upload logo

POST /companies/{slug}/logo

Uploads or replaces the workspace logo.

Path parameters

Request body (multipart/form-data)

Delete logo

DELETE /companies/{slug}/logo

Removes the workspace logo.

Path parameters

Workspace stats

GET /companies/stats

Returns workspace-level statistics.

curl -X GET https://services.gitscrum.com/companies/stats \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json"

Response 200 OK

{
  "data": {
    "projects_count": 12,
    "members_count": 28,
    "tasks_count": 847,
    "completed_tasks_count": 623,
    "active_sprints_count": 3
  }
}

My role

GET /companies/{slug}/my-role

Returns the authenticated user's role in the workspace.

Path parameters

curl -X GET https://services.gitscrum.com/companies/acme-corp/my-role \
  -H "Authorization: Bearer {token}"

Field reference