Clients

Manage client companies. Create, update, list, and retrieve client details.

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.

Manage client companies within your workspace. Create, update, list, and retrieve client details.

List clients

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

Returns all clients in the workspace.

Response

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

Get client

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

Returns full client details.

Path parameters

Parameter	Type	Description
`uuid`	string	Client UUID

Response

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

Create client

POST /contact-companies

Creates a new client in the workspace.

Request body

Field	Type	Required	Description
`name`	string	Yes	Client company name
`company_slug`	string	Yes	Workspace identifier
`email`	string	No	Contact email
`phone`	string	No	Phone number
`website`	string	No	Website URL
`address`	string	No	Street address
`notes`	string	No	Internal notes

Example

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

Response

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

Update client

PUT /contact-companies/{uuid}

Updates an existing client.

Path parameters

Parameter	Type	Description
`uuid`	string	Client UUID

Request body

Field	Type	Required	Description
`company_slug`	string	Yes	Workspace identifier
`name`	string	No	Client company name
`email`	string	No	Contact email
`phone`	string	No	Phone number
`website`	string	No	Website URL
`address`	string	No	Street address
`notes`	string	No	Internal notes

Example

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

Field reference

Field	Type	Description
`uuid`	string	Client unique identifier
`name`	string	Company name
`email`	string	Contact email
`phone`	string	Phone number
`website`	string	Website URL
`address`	string	Street address
`notes`	string	Internal notes
`projects_count`	integer	Number of associated projects
`invoices_total`	number	Total invoiced amount
`created_at`	datetime	Record creation timestamp