ackDB

List segments

Returns the saved Segments the caller can see (soft-deleted excluded), most-recently-updated first. ACL-filtered to ones they own, are shared on, plus every legacy (owner-less) and org-default row; each carries the caller's effective access (#284). A service/static-key call sees all.

get/api/v1/ackdb/observe/segments

Request

  • Base URL
    http://localhost:3009
  • Auth
    HTTP bearer

Query parameters

entityKind'company' | 'contact' | 'person'

Filter by entity kind.

limitinteger
offsetinteger

Response

List of segment summaries.

Example response

{
  "data": [
    {
      "id": "01J9Z8Q3K2X7M4N5P6R7S8T9V0",
      "name": "Active paying companies",
      "description": "Companies with a paid Stripe invoice",
      "entityKind": "company",
      "ownerEmail": "rep@acme.com",
      "access": "owner",
      "folderId": "01JA0B1C2D3E4F5G6H7J8K9M0N"
    }
  ],
  "pagination": {
    "total": 150,
    "limit": 50,
    "totalIsLowerBound": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.