List Subscriptions

Endpoint

GET https://api.parcelengineering.com/api/v1/workspace/signal-subscriptions

Returns all signal types the workspace is currently subscribed to, along with each subscription’s priority, channels, recipients, cadence, and a live count of new (untriaged) signals in the queue for that type.

List subscriptions costs 0 credits.

Caution

The Workspace API requires the Pro plan. A request from a non-Pro workspace receives 403 forbidden.

Query parameters

Parameter	Type	Required	Description
workspace_id	string (UUID)	No	Override the workspace resolved from your API key. Useful for admin tooling.

Example

cURL

List signal subscriptions

curl https://api.parcelengineering.com/api/v1/workspace/signal-subscriptions \
  -H "Authorization: Bearer pcl_your_api_key"

JavaScript

List signal subscriptions

const response = await fetch(
  'https://api.parcelengineering.com/api/v1/workspace/signal-subscriptions',
  {
    headers: {
      'Authorization': 'Bearer pcl_your_api_key',
    },
  }
);

const { data, metadata } = await response.json();

Response

Response

{
  "data": {
    "subscriptions": [
      {
        "id": "7c3f1a2b-0001-4e8d-bf6a-000000000001",
        "signal_type": "permit_issued",
        "priority": "high",
        "channels": ["email"],
        "notify_all_members": false,
        "recipient_user_ids": ["d1e2f3a4-0001-4b7c-9e5d-000000000001"],
        "cadence": "immediate",
        "new_count": 14,
        "created_at": "2025-06-01T12:00:00.000Z",
        "updated_at": "2025-06-01T12:00:00.000Z"
      }
    ],
    "filed_floor_days": 90
  },
  "metadata": { "credits": 0 }
}

Response fields

Field	Type	Description
data.subscriptions	array	One object per subscribed signal type.
data.subscriptions[].id	string (UUID)	Row ID. Use this to delete the subscription.
data.subscriptions[].signal_type	string	The signal type. See Upsert Subscription for valid values.
data.subscriptions[].priority	string	Queue priority: high, medium, or low.
data.subscriptions[].channels	string[]	Delivery channels configured: email, teams, or slack. Email is live today; Teams and Slack are coming soon.
data.subscriptions[].notify_all_members	boolean	When true, email alerts go to every workspace member (including future members). Takes precedence over recipient_user_ids.
data.subscriptions[].recipient_user_ids	string[]	UUIDs of specific workspace members who receive alerts when notify_all_members is false.
data.subscriptions[].cadence	string	Delivery cadence: immediate (send as signals arrive) or daily_digest (batched once per day).
data.subscriptions[].new_count	integer	Count of signals of this type that are new (not yet triaged) in the workspace queue, within the plan’s recency window.
data.subscriptions[].created_at	string (ISO 8601)	When the subscription was created.
data.subscriptions[].updated_at	string (ISO 8601)	When the subscription was last modified.
data.filed_floor_days	integer	The recency window (in days) used to compute new_count. 90 on Pro.
metadata.credits	integer	Always 0.