Clientes

Gerencie empresas clientes. Crie, atualize, liste e recupere detalhes de clientes.

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.

Gerencie empresas clientes dentro do seu workspace. Crie, atualize, liste e recupere detalhes de clientes.

URL Base: https://services.gitscrum.com

Todos os endpoints requerem o header Authorization: Bearer {token}.

Listar clientes

GET /contact-companies/clients?company_slug={slug}

Retorna todos os clientes do workspace.

Resposta

{
  "data": [
    {
      "uuid": "client-abc-123",
      "name": "Acme Corp",
      "email": "billing@acme.co",
      "phone": "+1-555-0100",
      "website": "https://acme.co",
      "address": "123 Main St, San Francisco, CA",
      "notes": "Enterprise client since 2024",
      "projects_count": 5,
      "invoices_total": 125000,
      "created_at": "2025-06-15T10:00:00Z"
    }
  ]
}

Obter cliente

GET /contact-companies/{uuid}?company_slug={slug}

Retorna detalhes completos do cliente.

Parâmetros de caminho

Parâmetro	Tipo	Descrição
`uuid`	string	UUID do cliente

Resposta

{
  "data": {
    "uuid": "client-abc-123",
    "name": "Acme Corp",
    "email": "billing@acme.co",
    "phone": "+1-555-0100",
    "website": "https://acme.co",
    "address": "123 Main St, San Francisco, CA",
    "notes": "Enterprise client since 2024",
    "projects_count": 5,
    "invoices_total": 125000,
    "created_at": "2025-06-15T10:00:00Z"
  }
}

Criar cliente

POST /contact-companies

Cria um novo cliente no workspace.

Corpo da requisição

Campo	Tipo	Obrigatório	Descrição
`name`	string	Sim	Nome da empresa cliente
`company_slug`	string	Sim	Identificador do workspace
`email`	string	Não	Email de contato
`phone`	string	Não	Número de telefone
`website`	string	Não	URL do website
`address`	string	Não	Endereço
`notes`	string	Não	Notas internas

Exemplo

curl -X POST https://services.gitscrum.com/contact-companies \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "company_slug": "acme",
    "name": "Globex Corporation",
    "email": "contact@globex.com",
    "phone": "+1-555-0200",
    "website": "https://globex.com"
  }'

Resposta

{
  "data": {
    "uuid": "client-def-456",
    "name": "Globex Corporation",
    "email": "contact@globex.com",
    "phone": "+1-555-0200",
    "website": "https://globex.com",
    "address": null,
    "notes": null,
    "projects_count": 0,
    "invoices_total": 0,
    "created_at": "2026-02-07T12:00:00Z"
  }
}

Atualizar cliente

PUT /contact-companies/{uuid}

Atualiza um cliente existente.

Parâmetros de caminho

Parâmetro	Tipo	Descrição
`uuid`	string	UUID do cliente

Corpo da requisição

Campo	Tipo	Obrigatório	Descrição
`company_slug`	string	Sim	Identificador do workspace
`name`	string	Não	Nome da empresa cliente
`email`	string	Não	Email de contato
`phone`	string	Não	Número de telefone
`website`	string	Não	URL do website
`address`	string	Não	Endereço
`notes`	string	Não	Notas internas

Exemplo

curl -X PUT https://services.gitscrum.com/contact-companies/client-def-456 \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "company_slug": "acme",
    "notes": "Renewed contract for 2026"
  }'

Referência de campos

Campo	Tipo	Descrição
`uuid`	string	Identificador único do cliente
`name`	string	Nome da empresa
`email`	string	Email de contato
`phone`	string	Número de telefone
`website`	string	URL do website
`address`	string	Endereço
`notes`	string	Notas internas
`projects_count`	integer	Número de projetos associados
`invoices_total`	number	Valor total faturado
`created_at`	datetime	Timestamp de criação do registro