List all customers

GET/api/v1/workspaces/{slug}/customers/

List all customers in a workspace with optional search filtering

Path Parameters

slug:requiredstring

Slug.

Scopes

customers:read

List all customers

curl -X GET \
  "https://api.plane.so/api/v1/workspaces/my-workspace/customers/" \
  -H "X-API-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v1/workspaces/my-workspace/customers/",
    headers={"X-API-Key": "your-api-key"}
)
print(response.json())

const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/customers/", {
  method: "GET",
  headers: {
    "X-API-Key": "your-api-key",
  },
});
const data = await response.json();

Response200

{
  "grouped_by": "state",
  "sub_grouped_by": "priority",
  "total_count": 150,
  "next_cursor": "20:1:0",
  "prev_cursor": "20:0:0",
  "next_page_results": true,
  "prev_page_results": false,
  "count": 20,
  "total_pages": 8,
  "total_results": 150,
  "extra_stats": null,
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Example Name",
      "created_at": "2024-01-01T00:00:00Z"
    }
  ]
}