Workspaces

REST API — Todos os endpoints requerem autenticação via Bearer token. Inclua Authorization: Bearer {token} em cada requisição. Os tokens são gerenciados em Configurações do GitScrum → API. Base URL: https://services.gitscrum.com — Todos os caminhos de requisição nesta documentação são relativos a esta URL base.

Workspaces são o container de nível superior no GitScrum. Todo projeto, membro e recurso pertence a um workspace.

Listar workspaces

GET /companies

Retorna todos os workspaces aos quais o usuário autenticado pertence.

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

Resposta 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"
      }
    }
  ]
}

Obter workspace

GET /companies/{slug}

Retorna os detalhes completos do workspace.

Parâmetros de caminho

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

Resposta 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"
    }
  }
}

Criar workspace

POST /companies

Cria um novo workspace.

Corpo da requisição

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

Atualizar workspace

PUT /companies/{slug}

Atualiza as configurações do workspace.

Parâmetros de caminho

Corpo da requisição

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

Excluir workspace

DELETE /companies/{slug}

Exclui permanentemente um workspace e todos os seus dados. Esta ação não pode ser desfeita.

Parâmetros de caminho

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

Upload de logo

POST /companies/{slug}/logo

Faz upload ou substitui o logo do workspace.

Parâmetros de caminho

Corpo da requisição (multipart/form-data)

Excluir logo

DELETE /companies/{slug}/logo

Remove o logo do workspace.

Parâmetros de caminho

Estatísticas do workspace

GET /companies/stats

Retorna estatísticas no nível do workspace.

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

Resposta 200 OK

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

Meu papel

GET /companies/{slug}/my-role

Retorna o papel do usuário autenticado no workspace.

Parâmetros de caminho

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

Referência de campos