Skip to main content

Customer Sites API

API endpoints for managing customer sites.

List Customer Sites​

Get all customer sites for a project.

GET /projects/{projectId}/customer-sites

Query Parameters​

  • skip (integer): Number of records to skip
  • size (integer): Number of records per page
  • customerName (string): Filter by customer name
  • country (string): Filter by country
  • siteId (string): Filter by site ID
  • customerType (string): Filter by customer type

Response​

{
  "result": [
    {
      "_id": "site-id",
      "customerName": "Customer Name",
      "country": "USA",
      "siteId": "SITE001",
      "customerType": "Premium"
    }
  ],
  "totalCount": 10
}

Create Customer Site​

Create a new customer site.

POST /projects/{projectId}/customer-sites

Request Body​

{
  "customerName": "Customer Name",
  "country": "USA",
  "siteId": "SITE001",
  "pointOfContact": "John Doe",
  "customerType": "Premium",
  "description": "Customer site description"
}

Get Customer Site​

Get a specific customer site.

GET /projects/{projectId}/customer-sites/{customerSiteId}

Update Customer Site​

Update a customer site.

PATCH /projects/{projectId}/customer-sites/{customerSiteId}

Request Body​

{
  "customerName": "Updated Name",
  "customerType": "Normal"
}

Delete Customer Site​

Delete a customer site.

DELETE /projects/{projectId}/customer-sites/{customerSiteId}