Clients

REST API — Tous les endpoints nécessitent une authentification par Bearer token. Incluez Authorization: Bearer {token} dans chaque requête. Les tokens sont gérés dans Paramètres GitScrum → API. Base URL: https://services.gitscrum.com — Tous les chemins de requête dans cette documentation sont relatifs à cette URL de base.

Gérez les entreprises clientes au sein de votre workspace. Créez, mettez à jour, listez et récupérez les détails des clients.

URL de base : https://services.gitscrum.com

Tous les endpoints nécessitent l'en-tête Authorization: Bearer {token}.

Lister les clients

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

Retourne tous les clients du workspace.

Réponse

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

Obtenir un client

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

Retourne les détails complets du client.

Paramètres de chemin

Réponse

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

Créer un client

POST /contact-companies

Crée un nouveau client dans le workspace.

Corps de la requête

Exemple

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

Réponse

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

Mettre à jour un client

PUT /contact-companies/{uuid}

Met à jour un client existant.

Paramètres de chemin

Corps de la requête

Exemple

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

Référence des champs