---
canonical_url: "https://docs.composio.dev/toolkits/signa"
markdown_url: "https://docs.composio.dev/toolkits/signa.md"
product: "platform"
version: null
last_updated: null
---

# Signa

Search trademark intelligence and manage trademark portfolios with Signa's native API.

- **Category:** analytics
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 140
- **Triggers:** 0
- **Slug:** `SIGNA`
- **Version:** 00000000_00

## Tools

### Add Trademarks to Portfolio

**Slug:** `SIGNA_ADD_PORTFOLIO_TRADEMARKS`

Add up to 100 trademarks to a portfolio, optionally assigning a unique external docket reference to each membership. Returns counts for additions, existing memberships, and unknown trademarks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | No | One to 100 memberships with a trademark_id and optional external_ref. Duplicate trademark IDs or external references are rejected. Mutually exclusive with trademark_ids. |
| `portfolio_id` | string | Yes | Signa portfolio ID beginning with ptf_. |
| `trademark_ids` | array | No | One to 100 trademark IDs to add without external references. Repeated IDs are deduplicated. Mutually exclusive with items. |
| `idempotency_key` | string | No | Stable retry key. Composio generates one when omitted. Reuse a supplied key only with the identical membership-add request for up to 24 hours. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch lookup trademarks

**Slug:** `SIGNA_BATCH_LOOKUP_TRADEMARKS`

Batch lookup trademarks by IDs or office-native identifiers. Max 100 items. Returns detail tier per trademark + not_found array. Billed per submitted identifier, including the ones returned in not_found.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Array of trademark IDs (tm_...). Max 100. |
| `include` | array | No | Optional detail projections applied to every returned trademark. `office_extensions` includes raw office-specific blobs. |
| `identifiers` | array | No | Array of office-native identifiers. Max 100. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bulk Create Watches

**Slug:** `SIGNA_BULK_CREATE_WATCHES`

Atomically create up to 100 monitoring watches; any invalid item rejects the entire request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `watches` | array | Yes | One to 100 watches, created atomically. |
| `idempotency_key` | string | No | Stable retry key for this atomic bulk creation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cast office votes

**Slug:** `SIGNA_CAST_OFFICE_VOTES`

Vote for trademark offices your organization wants on Signa. One vote per office per organization — re-votes are no-ops, so the call is safely retryable. Returns the stored votes for every requested code (newly cast or pre-existing).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `office_codes` | array | Yes | Office codes to vote for (1–50). ST.3 / ISO country codes, any case (surrounding whitespace is trimmed); legacy internal codes and reserved aliases like UK are canonicalized. Offices Signa already covers are rejected — vote for what you want added. Codes your organization already voted for are no-ops, never double counts. |
| `idempotency_key` | string | Yes | Documented Idempotency-Key parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Screen Listing

**Slug:** `SIGNA_CHECK_LISTING`

Screen marks extracted from a commerce listing with Signa's alpha listing checker. This is not legal advice.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand` | string | No | Brand or seller. |
| `title` | string | Yes | Listing title. |
| `include` | string ("live" | "all") | No | Status population. |
| `offices` | array | No | Office codes. |
| `category` | string | No | Listing category. |
| `keywords` | array | No | Listing keywords. |
| `description` | string | No | Listing description. |
| `sensitivity` | string ("strict" | "standard" | "broad") | No | Screening sensitivity. |
| `nice_classes` | array | No | Nice classes 1-45. |
| `jurisdictions` | array | No | Jurisdictions. |
| `seller_verification` | object | No | Seller trust context. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Compare Trademarks

**Slug:** `SIGNA_COMPARE_TRADEMARKS`

Compare one candidate against selected trademark conflicts using Signa's alpha scorer. This is not legal advice.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `offices` | array | No | Office codes. |
| `candidate` | object | Yes | Candidate trademark or mark/use profile. |
| `conflicts` | array | Yes | Conflicts to compare. |
| `jurisdictions` | array | No | Jurisdictions. |
| `idempotency_key` | string | No | Optional retry key. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Compute Deadlines

**Slug:** `SIGNA_COMPUTE_DEADLINES`

Compute maintenance and optional prosecution deadlines without persisting data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Stored trademark IDs or caller-supplied deadline facts. |
| `as_of_date` | string | No | Calendar date to compute relative to; defaults to today. |
| `horizon_years` | integer | No | Deadline horizon in years; defaults to 5. |
| `include_missed` | boolean | No | Whether to include missed deadlines; defaults to false. |
| `include_optional` | boolean | No | Whether to include optional deadlines; defaults to true. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Compute Opposition Windows

**Slug:** `SIGNA_COMPUTE_OPPOSITIONS`

Compute trademark opposition windows from publication facts without persisting data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Publication facts to compute in request order. |
| `as_of_date` | string | No | Office-local date to compute relative to; defaults to today. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create API Key

**Slug:** `SIGNA_CREATE_API_KEY`

Create an organization API key; the raw key is returned exactly once.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | API key name. |
| `scopes` | array | Yes | Scopes for the key. |
| `metadata` | object | No | String metadata, up to 50 keys. |
| `expires_at` | string | No | ISO 8601 expiry, or null. |
| `idempotency_key` | string | No | Stable retry key for API-key creation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Calendar Feed

**Slug:** `SIGNA_CREATE_CALENDAR_FEED`

Create a secret iCalendar subscription URL for open portfolio deadlines.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Calendar name shown to subscribers. |
| `portfolio_id` | string | No | Portfolio to include; omit for the whole docket. |
| `idempotency_key` | string | No | Stable retry key generated when omitted; reuse only with the identical body for 24 hours. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Manual Deadline

**Slug:** `SIGNA_CREATE_DEADLINE`

Add a manual deadline to the organization's docket.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note` | string | No | Optional note. |
| `title` | string | Yes | Manual deadline title. |
| `assignee` | string | No | Optional assignee. |
| `due_date` | string | Yes | Deadline due date. |
| `portfolio_id` | string | No | Portfolio under which to file the deadline. |
| `trademark_id` | string | No | Trademark the deadline concerns. |
| `idempotency_key` | string | No | Stable retry key generated when omitted; reuse only with the identical body for 24 hours. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Deadline Reminder

**Slug:** `SIGNA_CREATE_DEADLINE_REMINDER`

Create a pending email deadline-reminder subscription and send its confirmation email.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address that will receive reminders after confirmation. |
| `offsets` | array | No | Days before due dates to remind, each from 0 through 365. |
| `portfolio_id` | string | No | Portfolio to cover; omit for the whole docket. |
| `idempotency_key` | string | No | Stable retry key generated when omitted; reuse only with the identical body for 24 hours. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Submit Feedback

**Slug:** `SIGNA_CREATE_FEEDBACK`

Submit a data issue, bug, feature request, rating, or other feedback to Signa.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | string | No | Originating page path. |
| `type` | string ("data_issue" | "bug" | "feature_request" | "other") | Yes | Feedback type. |
| `field` | string | No | Incorrect field name. |
| `rating` | integer | No | Optional rating. |
| `message` | string | No | Report body. |
| `metadata` | object | No | String metadata, up to 50 keys. |
| `request_id` | string | No | Referenced request ID. |
| `resource_id` | string | No | Referenced public resource ID. |
| `expected_value` | string | No | Expected field value. |
| `idempotency_key` | string | No | Stable retry key for feedback submission. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Portfolio

**Slug:** `SIGNA_CREATE_PORTFOLIO`

Create a named trademark portfolio with optional description and metadata. Returns the portfolio ID for subsequent membership and lifecycle operations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique portfolio name. |
| `metadata` | object | No | Optional string key-value metadata, up to 50 keys. |
| `description` | string | No | Optional purpose or notes for the portfolio. |
| `idempotency_key` | string | No | Stable retry key. Composio generates one when omitted. Reuse a supplied key only with the identical create request for up to 24 hours. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Watch

**Slug:** `SIGNA_CREATE_WATCH`

Create a beta trademark-monitoring watch. Monitoring is plan-gated and may consume daily credits per monitored mark.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Watch name. |
| `query` | object | No | Versioned watch query; serialized size is limited to 50,000 bytes and depth to five. |
| `metadata` | object | No | Arbitrary watch metadata. |
| `watch_type` | string ("mark" | "portfolio" | "owner" | "class" | "similarity") | Yes | Watch type. |
| `delivery_mode` | string | No | Delivery mode; only always_per_alert is accepted. |
| `idempotency_key` | string | No | Stable retry key. Reuse it only with the identical request for 24 hours. |
| `customer_reference` | string | No | Optional customer reference echoed on alerts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Webhook

**Slug:** `SIGNA_CREATE_WEBHOOK`

Register a signed webhook endpoint. The signing secret is returned only once; store it securely before making another request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | HTTPS delivery URL. |
| `metadata` | object | No | Arbitrary endpoint metadata. |
| `description` | string | No | Endpoint description. |
| `portfolio_id` | string | No | Optional ptf_* membership-snapshot filter applying to every event type. |
| `enabled_events` | array | Yes | One to 20 official event types to deliver. |
| `idempotency_key` | string | No | Stable retry key. Reuse only with the identical endpoint request for 24 hours. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Calendar Feed

**Slug:** `SIGNA_DELETE_CALENDAR_FEED`

Revoke a calendar feed so its subscription URL stops serving deadlines.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `idempotency_key` | string | No | Stable retry key generated when omitted; reuse only with the identical delete for 24 hours. |
| `calendar_feed_id` | string | Yes | Signa calendar feed ID beginning with cal_. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Manual Deadline

**Slug:** `SIGNA_DELETE_DEADLINE`

Delete a manual deadline and its history; computed deadlines cannot be deleted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `deadline_id` | string | Yes | Signa deadline ID beginning with dl_. |
| `idempotency_key` | string | No | Stable retry key generated when omitted; reuse only with the identical delete for 24 hours. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Deadline Reminder

**Slug:** `SIGNA_DELETE_DEADLINE_REMINDER`

Stop a deadline-reminder subscription and invalidate its email links.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `idempotency_key` | string | No | Stable retry key generated when omitted; reuse only with the identical delete for 24 hours. |
| `deadline_reminder_id` | string | Yes | Signa reminder ID beginning with drm_. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Portfolio

**Slug:** `SIGNA_DELETE_PORTFOLIO`

Delete one portfolio and its membership links. The trademarks referenced by the portfolio are not deleted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `portfolio_id` | string | Yes | Signa portfolio ID beginning with ptf_. |
| `idempotency_key` | string | No | Stable retry key. Composio generates one when omitted. Reuse a supplied key only with the identical delete request for up to 24 hours. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Watch

**Slug:** `SIGNA_DELETE_WATCH`

Soft-delete a monitoring watch and stop future evaluations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `watch_id` | string | Yes | Watch ID. |
| `idempotency_key` | string | No | Stable retry key for this deletion. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Webhook

**Slug:** `SIGNA_DELETE_WEBHOOK`

Permanently remove a webhook endpoint and stop future deliveries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | string | Yes | Webhook endpoint ID. |
| `idempotency_key` | string | No | Stable retry key for this deletion. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Estimate Official Fees

**Slug:** `SIGNA_ESTIMATE_FEES`

Estimate official trademark fees in native currency without persisting data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `late` | boolean | No | Whether a late surcharge applies. |
| `route` | string ("direct" | "madrid") | Yes | Filing route. |
| `action` | string ("filing" | "renewal" | "declaration_of_use" | "declaration_of_incontestability" | "statement_of_use" | "amendment_to_allege_use" | "sou_extension" | "opposition" | "oa_extension" | "expungement_oa_extension" | "petition_to_revive" | "restoration" | "continuation" | "restitutio" | "subsequent_designation" | "transfer" | "name_address_change" | "limitation" | "licence" | "division") | Yes | Official-fee action to estimate. |
| `colour` | boolean | No | Whether the mark claims colour where the office charges for it. |
| `office` | string | Yes | Office code or documented office alias. |
| `classes` | string | Yes | One Nice class count from 1-45, or one to 45 class numbers. |
| `applicant` | object | No | Applicant fee-reduction facts. |
| `designations` | array | No | Madrid designation codes. |
| `payment_date` | string | No | Payment date. |
| `filing_channel` | string ("electronic" | "paper") | No | Filing channel. |
| `application_date` | string | No | Application date. |
| `renewal_due_date` | string | No | Renewal due date. |
| `application_in_payment_grace` | boolean | No | Whether the application is in payment grace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Alert

**Slug:** `SIGNA_GET_ALERT`

Retrieve one organization monitoring alert by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `alert_id` | string | Yes | Alert ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get API Key

**Slug:** `SIGNA_GET_API_KEY`

Retrieve organization API-key metadata without the raw key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider resource ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Attorney Analytics

**Slug:** `SIGNA_GET_ATTORNEY_ANALYTICS`

Retrieve the composed analytics report for a trademark attorney.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider resource ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Classification Analytics

**Slug:** `SIGNA_GET_CLASSIFICATION_ANALYTICS`

Retrieve aggregate trademark analytics for one Nice class.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `class_number` | string | Yes | Nice class number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Credit Pricing

**Slug:** `SIGNA_GET_CREDIT_PRICING`

Get credit prices, units, availability, and schedule version for API actions.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Credit Balance

**Slug:** `SIGNA_GET_CREDITS`

Get pooled credit balance, grant breakdown, and expiry schedule.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Deadline

**Slug:** `SIGNA_GET_DEADLINE`

Retrieve one deadline after recomputation, including sources and change history.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `deadline_id` | string | Yes | Signa deadline ID beginning with dl_. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Entity Analytics

**Slug:** `SIGNA_GET_ENTITY_ANALYTICS`

Retrieve analytics aggregated across an entity's resolved owner portfolio.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider resource ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Event

**Slug:** `SIGNA_GET_EVENT`

Retrieve event detail, including field-level before/after changes where applicable.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `event_id` | string | Yes | Event ID beginning with evt_. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Feedback

**Slug:** `SIGNA_GET_FEEDBACK`

Retrieve one feedback item submitted by the authenticated organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider resource ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Firm Analytics

**Slug:** `SIGNA_GET_FIRM_ANALYTICS`

Retrieve the composed analytics report for a trademark firm.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider resource ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Listing Screening Batch

**Slug:** `SIGNA_GET_LISTING_BATCH`

Poll an asynchronous listing-screening job and retrieve terminal item outcomes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider resource ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get API Request Log

**Slug:** `SIGNA_GET_LOG`

Retrieve one organization API request log by request ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `request_id` | string | Yes | Signa request ID beginning with req_. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Request Log Histogram

**Slug:** `SIGNA_GET_LOG_HISTOGRAM`

Get matching API requests bucketed over time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | No | Alias for end_date. |
| `from_` | string | No | Alias for start_date. |
| `method` | string | No | HTTP method. |
| `search` | string | No | Path or request-ID substring. |
| `success` | boolean | No | Filter by request outcome. |
| `end_date` | string | No | ISO 8601 range end. |
| `api_key_id` | string | No | API key ID. |
| `start_date` | string | No | ISO 8601 range start. |
| `status_code` | integer | No | HTTP status. |
| `endpoint_type` | string | No | Endpoint billing type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Request Log Stats

**Slug:** `SIGNA_GET_LOG_STATS`

Aggregate request counts, errors, latency, and credits for matching API logs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | No | Alias for end_date. |
| `from_` | string | No | Alias for start_date. |
| `method` | string | No | HTTP method. |
| `search` | string | No | Path or request-ID substring. |
| `success` | boolean | No | Filter by request outcome. |
| `end_date` | string | No | ISO 8601 range end. |
| `api_key_id` | string | No | API key ID. |
| `start_date` | string | No | ISO 8601 range start. |
| `status_code` | integer | No | HTTP status. |
| `endpoint_type` | string | No | Endpoint billing type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Market Analytics

**Slug:** `SIGNA_GET_MARKET_ANALYTICS`

Retrieve aggregate trademark market analytics.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Monitoring Status

**Slug:** `SIGNA_GET_MONITORING_STATUS`

Read organization watch health, per-office freshness, and continuous pipeline verification gauges.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Notification Preferences

**Slug:** `SIGNA_GET_NOTIFICATION_PREFERENCES`

Get organization notification preferences.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Office Analytics

**Slug:** `SIGNA_GET_OFFICE_ANALYTICS`

Retrieve aggregate trademark analytics for one office.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | WIPO ST.3 office code; legacy codes are accepted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Organization

**Slug:** `SIGNA_GET_ORGANIZATION`

Get the authenticated Signa organization and API-key identity context.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Organization Plan

**Slug:** `SIGNA_GET_ORGANIZATION_PLAN`

Get the organization's current plan, billing period, and endpoint quotas.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Owner Analytics

**Slug:** `SIGNA_GET_OWNER_ANALYTICS`

Retrieve the composed analytics report for a trademark owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider resource ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Portfolio

**Slug:** `SIGNA_GET_PORTFOLIO`

Retrieve one portfolio and one optional page of its trademark memberships.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Trademark memberships to include (0-100); use 0 for portfolio metadata only. |
| `cursor` | string | No | Opaque cursor returned by the previous page of embedded trademark memberships. |
| `external_ref` | string | No | Return only the membership carrying this exact portfolio-scoped external reference. |
| `portfolio_id` | string | Yes | Signa portfolio ID beginning with ptf_. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trademark

**Slug:** `SIGNA_GET_TRADEMARK`

Retrieve full details for one trademark, including parties, classifications, proceeding counts, computed deadlines, and freshness metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | array | No | Sparse top-level response fields; id and object are always retained. |
| `language` | string | No | Preferred 2-3 letter goods/services language, optionally followed by a two-letter region. |
| `trademark_id` | string | Yes | Signa trademark ID beginning with tm_. |
| `include_office_extensions` | boolean | No | Include raw office-specific extension data when needed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Usage

**Slug:** `SIGNA_GET_USAGE`

Get current billing-period usage and rate-limit status.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Usage Estimate

**Slug:** `SIGNA_GET_USAGE_ESTIMATE`

Price recorded API traffic at Signa's published credit schedule.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | No | Inclusive ISO date range end. |
| `from_` | string | No | ISO date range start. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Usage Summary

**Slug:** `SIGNA_GET_USAGE_SUMMARY`

Get daily, endpoint-type, or API-key usage for a date range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_date` | string | No | ISO date range end. |
| `group_by` | string ("day" | "endpoint_type" | "api_key") | No | Usage grouping dimension. |
| `start_date` | string | No | ISO date range start. |
| `endpoint_type` | string | No | Endpoint-type filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Watch

**Slug:** `SIGNA_GET_WATCH`

Retrieve one watch including its 24-hour alert count and current health.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `watch_id` | string | Yes | Watch ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Watch Attestation

**Slug:** `SIGNA_GET_WATCH_ATTESTATION`

Retrieve monthly proof of monitoring. PDF format returns a binary file payload; JSON returns structured evidence.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("json" | "pdf") | No | json by default; pdf returns the downloadable business record. |
| `period` | string | No | UTC month in YYYY-MM form; defaults to the previous month. |
| `partial` | string ("true" | "false") | No | Set true to permit the current open month. |
| `watch_id` | string | Yes | Watch ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Watch Diagnostics

**Slug:** `SIGNA_GET_WATCH_DIAGNOSTICS`

Explain the evaluation path for one watch and trademark pair.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `watch_id` | string | Yes | Watch ID. |
| `trademark_id` | string | Yes | Trademark ID beginning with tm_. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Webhook

**Slug:** `SIGNA_GET_WEBHOOK`

Retrieve one webhook endpoint. The signing secret is redacted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | string | Yes | Webhook endpoint ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Webhook Delivery

**Slug:** `SIGNA_GET_WEBHOOK_DELIVERY`

Retrieve one webhook delivery attempt and its retry state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | string | Yes | Webhook endpoint ID. |
| `delivery_id` | string | Yes | Webhook delivery ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Alerts

**Slug:** `SIGNA_LIST_ALERTS`

List monitoring alerts for the connected organization with official filters and opaque pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `epoch` | string ("all" | "current") | No | Evaluation epoch filter; all is the provider default. |
| `limit` | integer | No | Page size. |
| `cursor` | string | No | Opaque pagination cursor. |
| `severity` | string ("normal" | "high" | "critical") | No | Severity filter. |
| `event_type` | string ("trademark.created" | "trademark.updated" | "trademark.status_changed" | "trademark.retracted" | "trademark.corrected") | No | Event-type filter. |
| `detected_late` | boolean | No | Filter alerts by late-detection status. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List API Keys

**Slug:** `SIGNA_LIST_API_KEYS`

List organization API keys without exposing raw key values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Page size. |
| `cursor` | string | No | Pagination cursor. |
| `status` | string ("active" | "revoked" | "expired" | "all") | No | API-key lifecycle filter; defaults to active. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List assignments

**Slug:** `SIGNA_LIST_ASSIGNMENTS`

List recorded trademark assignments. At least one filter is required.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role` | string ("assignor" | "assignee") | No | Filter by assignment party role |
| `sort` | string ("-recorded_date" | "recorded_date") | No | Sort field with optional - prefix for descending. Default: -recorded_date |
| `type` | array | No | Alias for conveyance_type |
| `limit` | integer | No | Page size (1-100, default 20) |
| `cursor` | string | No | Pagination cursor from previous response |
| `owner_id` | string | No | Filter by resolved owner ID (own_...) |
| `entity_id` | string | No | Filter by resolved entity ID (ent_...) across its member owners |
| `trademark_id` | string | No | Filter by trademark ID (tm_...) |
| `conveyance_type` | array | No | Filter by conveyance type (assignment, security_interest, release, merger, name_change, license, partial_assignment, correction, entity_conversion, other) |
| `recorded_date_lt` | string | No | Recorded date < (YYYY-MM-DD) |
| `recorded_date_gte` | string | No | Recorded date >= (YYYY-MM-DD) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List attorney clients

**Slug:** `SIGNA_LIST_ATTORNEY_CLIENTS`

List owners this attorney represents. Derived from trademark_owners and trademark_attorneys intersection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Attorney ID (att_...) |
| `limit` | integer | No | Page size (1-100, default 20) |
| `cursor` | string | No | Pagination cursor |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List attorneys

**Slug:** `SIGNA_LIST_ATTORNEYS`

List attorneys with optional search and filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Fuzzy, typo-tolerant attorney name search. Without `sort`, exact names and larger portfolios rank first. Once the attorney search index has been rebuilt it also matches the names of the firms on the attorney's filings. |
| `sort` | string ("-trademark_count" | "trademark_count" | "-registration_rate" | "registration_rate" | "-grant_rate" | "grant_rate" | "-avg_prosecution_days" | "avg_prosecution_days" | "-latest_filing" | "latest_filing" | "-name" | "name") | No | Sort field with optional - prefix for descending. Options: trademark_count, grant_rate, avg_prosecution_days, latest_filing, name. `registration_rate` is a deprecated alias of `grant_rate` (same value). Default: -trademark_count |
| `limit` | integer | No | Page size (1-100, default 20) |
| `cursor` | string | No | Pagination cursor |
| `firm_id` | string | No | Filter by firm ID (firm_...): attorneys with at least one current filing that names the firm. |
| `country_code` | string | No | Filter by country code. Two-letter country code, case-insensitive. Office spellings match too: `EU` and `EM` both match records stored under either, as do `GB` and `UK` (`WIPO` is read as `WO`). Historical codes such as `DD` or `SU` are accepted; an empty value is no filter; a value that is not a two-letter code returns 400 `unknown_country_code`. |
| `include_total` | boolean | No | If true, returns total_count in the pagination object. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List attorney trademarks

**Slug:** `SIGNA_LIST_ATTORNEY_TRADEMARKS`

List an attorney's trademarks with full Appendix A filter support. Returns summary tier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Search text within this attorney's trademarks, ranked through the similarity channels (1-500 characters; one is enough here). One text only: a list of terms is searched with /v1/trademarks. |
| `id` | string | Yes | Attorney ID (att_...) |
| `sort` | string | No | Sort field(s), comma-separated, - prefix for desc. Default: relevance with q, mark text order with a mark_text filter and no q, otherwise -filing_date. |
| `limit` | integer | No | Page size (1-100, default 20) |
| `cursor` | string | No | Pagination cursor from previous response |
| `fields` | array | No | Sparse top-level field projection. id and object are always retained. Fields you do not request are omitted, although the response schema lists every field. |
| `office` | string | No | Office code (required with application_number or registration_number) |
| `firm_id` | string | No | Filter by firm ID (firm_...) |
| `include` | array | No | Comma-separated optional row projections. `full_goods_services` returns full classifications[].goods_services_text. `match_details` adds match.details (the matched lanes and the ranking factors applied) to each hit. |
| `offices` | array | No | Filter by office code(s) |
| `owner_id` | array | No | Filter by owner (own_...). Takes one ID or a comma-separated list of up to 100; a mark matches when any listed owner holds it. Unlike owner_name this is an exact match on the owner record. A GET URL is limited to 2 KB, which holds about 45 IDs; send a longer list with POST /v1/trademarks. |
| `has_media` | boolean | No | Filter by media presence |
| `ir_number` | string | No | International registration number |
| `is_madrid` | boolean | No | Filter Madrid marks |
| `owner_lei` | string | No | Filter by exact LEI (uppercased server-side). |
| `highlights` | boolean | No | If true, includes highlight snippets for a ranked q. |
| `owner_name` | string | No | Filter by owner name. Case and accents are ignored. By default every word must match, in any order, with other words allowed between them, so `KG Mobility` also matches `e-mobility ... Co. KG`. Set owner_name_match=phrase to require the words next to each other and in order. For one exact owner use owner_id. |
| `right_kind` | string ("trademark" | "trade_name" | "commercial_notice" | "geographical_indication" | "other") | No | Filter by right kind. Valid values: trademark, trade_name, commercial_notice, geographical_indication, other. |
| `scope_kind` | array | No | Filter by scope kind(s) |
| `similarity` | array | No | Similarity channels for q, comma-separated: identical, fuzzy, embedded, phonetic, lookalike. Default identical,fuzzy,embedded,lookalike; identical is always on. Requires q. |
| `filing_basis` | array | No | Filter by namespaced filing basis code(s), e.g. US:1A |
| `filing_route` | array | No | Filter by filing route(s) |
| `is_retracted` | boolean | No | Filter retracted marks |
| `mark_text_is` | array | No | Marks where the whole mark equals the value (case, accents, punctuation, spacing and trademark notices ignored). Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `nice_classes` | array | No | Filter by Nice class number(s) |
| `owner_id_not` | array | No | Exclude marks held by these owners (own_...). Repeat the key for several ids. |
| `owner_ticker` | string | No | Filter by exact ticker symbol (uppercased server-side). |
| `status_stage` | array | No | Filter by status stage(s). "mixed" matches grouped IR rows whose designations disagree; it applies to the grouped view only, and a request served one row per record (international_registrations=expanded, or a grouped fallback) that filters on it is a 400. |
| `vienna_codes` | array | No | Filter by Vienna code(s) |
| `allow_partial` | boolean | No | Return 200 with search_meta.complete=false when the engine times out or a shard fails, instead of 503. Default false. |
| `entity_id_not` | array | No | Exclude marks whose owners are linked to these entities (ent_...). Repeat the key for several ids. |
| `include_total` | boolean | No | If true, returns total_count in the pagination object (exact up to 10,000, then total_count_approximate=true). |
| `jurisdictions` | array | No | Filter by jurisdiction code(s) (UK is read as GB, WIPO as WO) |
| `owner_country` | string | No | Filter by owner country code. Two-letter country code, case-insensitive. Office spellings match too: `EU` and `EM` both match records stored under either, as do `GB` and `UK` (`WIPO` is read as `WO`). Historical codes such as `DD` or `SU` are accepted; an empty value is no filter; a value that is not a two-letter code returns 400 `unknown_country_code`. |
| `owner_has_lei` | boolean | No | Filter by LEI presence. A false/absent value means no confirmed match — owner→company matching covers ~6% of marks. |
| `register_type` | string | No | Filter by the office register (`register.type`), e.g. principal or supplemental (US) or the CIPO register category (CA). Case-insensitive. |
| `status_reason` | array | No | Filter by status reason(s) |
| `updated_at_gt` | string | No | Updated at > (YYYY-MM-DD or ISO 8601) |
| `updated_at_lt` | string | No | Updated at < (YYYY-MM-DD or ISO 8601) |
| `expiry_date_gt` | string | No | Expiry date > (YYYY-MM-DD) |
| `expiry_date_lt` | string | No | Expiry date < (YYYY-MM-DD) |
| `filing_date_gt` | string | No | Filing date > (YYYY-MM-DD) |
| `filing_date_lt` | string | No | Filing date < (YYYY-MM-DD) |
| `include_timing` | boolean | No | If true, includes timing breakdown. |
| `is_series_mark` | boolean | No | Filter series marks |
| `mark_text_word` | array | No | Marks where the value appears as a whole word (or consecutive words) of the mark. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `status_primary` | array | No | Filter by primary status. Accepts a single value or a comma-separated list (e.g. `active,pending` for live marks). Valid values: pending, active, inactive, unknown, mixed. "mixed" matches grouped IR rows whose designations disagree; it applies to the grouped view only, and a request served one row per record (international_registrations=expanded, or a grouped fallback) that filters on it is a 400. |
| `updated_at_gte` | string | No | Updated at >= (YYYY-MM-DD or ISO 8601) |
| `updated_at_lte` | string | No | Updated at <= (YYYY-MM-DD or ISO 8601) |
| `expiry_date_gte` | string | No | Expiry date >= (YYYY-MM-DD) |
| `expiry_date_lte` | string | No | Expiry date <= (YYYY-MM-DD) |
| `filing_date_gte` | string | No | Filing date >= (YYYY-MM-DD) |
| `filing_date_lte` | string | No | Filing date <= (YYYY-MM-DD) |
| `has_proceedings` | boolean | No | Filter by proceedings presence |
| `territory_match` | string ("protection" | "direct") | No | How jurisdictions filters match: protection (default - includes regional rights whose membership covers the requested territory, e.g. a EUTM for jurisdictions=FR) or direct (literal territory legs only). |
| `us_design_codes` | array | No | Filter by U.S. design search code(s) |
| `challenge_states` | array | No | Filter by challenge state(s) |
| `entity_group_not` | array | No | Exclude marks linked to any entity in these entities' corporate families (ent_...). Repeat the key for several ids. |
| `mark_text_not_is` | array | No | Exclude marks where the whole mark equals the value (case, accents, punctuation, spacing and trademark notices ignored). Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `owner_name_match` | string ("all_words" | "phrase") | No | How owner_name matches. all_words (default): every word, in any order. phrase: the words next to each other and in order within one owner name, so `KG Mobility` matches `KG Mobility Corp.` but not `e-mobility ... Co. KG`. Punctuation, case and accents are ignored. Requires owner_name. |
| `priority_date_gt` | string | No | Priority date > (YYYY-MM-DD) |
| `priority_date_lt` | string | No | Priority date < (YYYY-MM-DD) |
| `seniority_claims` | string ("claimed" | "none" | "unknown") | No | Filter by seniority claim state: claimed, none, or unknown. |
| `mark_feature_type` | array | No | Filter by mark feature type(s) |
| `mark_text_pattern` | array | No | Marks where `*` matches any run, `?` one character, `\` escapes the next character; everything else is literal. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `opposition_status` | string ("open" | "not_started" | "closed" | "unknown") | No | Filter by derived opposition window status: open, not_started, closed, or unknown. |
| `priority_date_gte` | string | No | Priority date >= (YYYY-MM-DD) |
| `priority_date_lte` | string | No | Priority date <= (YYYY-MM-DD) |
| `trademark_ids_not` | array | No | Exclude these trademarks (tm_...); on the grouped view, the family row containing them. Up to 1000. Repeat the key for several ids. |
| `application_number` | string | No | Application number (requires office) |
| `attorney_firm_name` | string | No | Filter by attorney/firm name (fuzzy) |
| `mark_text_contains` | array | No | Marks where the value appears anywhere in the mark (folded like starts_with); at least 3 characters. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `mark_text_not_word` | array | No | Exclude marks where the value appears as a whole word (or consecutive words) of the mark. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `origin_office_code` | string | No | Madrid origin office code |
| `designation_date_gt` | string | No | Designation date after (YYYY-MM-DD). Date the designation was made under the Madrid Protocol (international registration date, or the subsequent-designation date). Set on Madrid designation records. Record grain only: the default grouped view falls back to one row per record with an `expanded_fallback` warning, and international_registrations=grouped returns 400. |
| `designation_date_lt` | string | No | Designation date before (YYYY-MM-DD). Date the designation was made under the Madrid Protocol (international registration date, or the subsequent-designation date). Set on Madrid designation records. Record grain only: the default grouped view falls back to one row per record with an `expanded_fallback` warning, and international_registrations=grouped returns 400. |
| `goods_services_text` | string | No | Filter by goods/services text |
| `mark_legal_category` | array | No | Filter by mark legal category(s) |
| `mark_text_ends_with` | array | No | Marks where the mark ends with the value (folded like starts_with); at least 3 characters. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `publication_date_gt` | string | No | Publication date > (YYYY-MM-DD) |
| `publication_date_lt` | string | No | Publication date < (YYYY-MM-DD) |
| `registration_number` | string | No | Registration number (requires office) |
| `renewal_due_date_gt` | string | No | Renewal due date > (YYYY-MM-DD) |
| `renewal_due_date_lt` | string | No | Renewal due date < (YYYY-MM-DD) |
| `termination_date_gt` | string | No | Termination date > (YYYY-MM-DD) |
| `termination_date_lt` | string | No | Termination date < (YYYY-MM-DD) |
| `designation_date_gte` | string | No | Designation date on or after (YYYY-MM-DD). Date the designation was made under the Madrid Protocol (international registration date, or the subsequent-designation date). Set on Madrid designation records. Record grain only: the default grouped view falls back to one row per record with an `expanded_fallback` warning, and international_registrations=grouped returns 400. |
| `designation_date_lte` | string | No | Designation date on or before (YYYY-MM-DD). Date the designation was made under the Madrid Protocol (international registration date, or the subsequent-designation date). Set on Madrid designation records. Record grain only: the default grouped view falls back to one row per record with an `expanded_fallback` warning, and international_registrations=grouped returns 400. |
| `publication_date_gte` | string | No | Publication date >= (YYYY-MM-DD) |
| `publication_date_lte` | string | No | Publication date <= (YYYY-MM-DD) |
| `registration_date_gt` | string | No | Registration date > (YYYY-MM-DD) |
| `registration_date_lt` | string | No | Registration date < (YYYY-MM-DD) |
| `renewal_due_date_gte` | string | No | Renewal due date >= (YYYY-MM-DD) |
| `renewal_due_date_lte` | string | No | Renewal due date <= (YYYY-MM-DD) |
| `termination_date_gte` | string | No | Termination date >= (YYYY-MM-DD) |
| `termination_date_lte` | string | No | Termination date <= (YYYY-MM-DD) |
| `mark_text_not_pattern` | array | No | Exclude marks where `*` matches any run, `?` one character, `\` escapes the next character; everything else is literal. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `mark_text_starts_with` | array | No | Marks where the mark begins with the value (case, accents, punctuation and spacing folded). Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `opposition_closes_gte` | string | No | Opposition window closes on or after this date (YYYY-MM-DD). |
| `opposition_closes_lte` | string | No | Opposition window closes on or before this date (YYYY-MM-DD). |
| `owner_publicly_traded` | boolean | No | Filter by public trading status. A false/absent value means no confirmed match, NOT confirmed private — owner→company matching covers ~6% of marks. |
| `registration_date_gte` | string | No | Registration date >= (YYYY-MM-DD) |
| `registration_date_lte` | string | No | Registration date <= (YYYY-MM-DD) |
| `mark_text_not_contains` | array | No | Exclude marks where the value appears anywhere in the mark (folded like starts_with); at least 3 characters. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `mark_text_not_ends_with` | array | No | Exclude marks where the mark ends with the value (folded like starts_with); at least 3 characters. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `status_effective_date_gt` | string | No | Status effective date > (YYYY-MM-DD) |
| `status_effective_date_lt` | string | No | Status effective date < (YYYY-MM-DD) |
| `mark_text_not_starts_with` | array | No | Exclude marks where the mark begins with the value (case, accents, punctuation and spacing folded). Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `status_effective_date_gte` | string | No | Status effective date >= (YYYY-MM-DD) |
| `status_effective_date_lte` | string | No | Status effective date <= (YYYY-MM-DD) |
| `first_use_anywhere_date_gt` | string | No | First use anywhere date > (YYYY-MM-DD) |
| `first_use_anywhere_date_lt` | string | No | First use anywhere date < (YYYY-MM-DD) |
| `first_use_anywhere_date_gte` | string | No | First use anywhere date >= (YYYY-MM-DD) |
| `first_use_anywhere_date_lte` | string | No | First use anywhere date <= (YYYY-MM-DD) |
| `international_registrations` | string ("grouped" | "expanded") | No | International registration presentation. Default grouped → one row per mark/IR. Use expanded for one row per Madrid designation. |
| `first_use_in_commerce_date_gt` | string | No | First use in commerce date > (YYYY-MM-DD) |
| `first_use_in_commerce_date_lt` | string | No | First use in commerce date < (YYYY-MM-DD) |
| `first_use_in_commerce_date_gte` | string | No | First use in commerce date >= (YYYY-MM-DD) |
| `first_use_in_commerce_date_lte` | string | No | First use in commerce date <= (YYYY-MM-DD) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Calendar Feeds

**Slug:** `SIGNA_LIST_CALENDAR_FEEDS`

List active calendar feeds for the organization; secret URLs are never returned.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List citations

**Slug:** `SIGNA_LIST_CITATIONS`

List examiner refusal citations across all marks — the prior marks an office cited against an application. Coverage today is USPTO §2(d) refusals; check `capabilities.citations` on `GET /v1/offices` for the per-office state. Extracted hourly from office actions; dispositions are refreshed daily. Ordered by `action_date` (undated actions last) with `id` as the final tiebreaker.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("-action_date" | "action_date") | No | Sort field with optional - prefix for descending. Default: -action_date |
| `limit` | integer | No | Page size (1-100, default 20) |
| `cursor` | string | No | Pagination cursor from a previous response |
| `offices` | array | No | Filter by issuing office, comma-separated (e.g. US,EM). WIPO ST.3 uppercase (e.g. US); legacy acronym slugs (uspto) and EU are also accepted. Values are OR-ed: an unknown code contributes no matches rather than erroring, so the list is empty only when NONE of the supplied codes match (`?offices=US,ZZ` still returns the US rows). |
| `cited_ref` | string | No | Exact cited reference (digits; punctuation is ignored). Must not be blank. Requires `offices` — an office-less reference lookup is unindexable. |
| `disposition` | array | No | Filter by disposition (citation_issued, maintained, withdrawn, abandoned_after, published). Comma-separated. |
| `action_stage` | array | No | Filter by office-action stage (nonfinal, final). Comma-separated. |
| `refusal_type` | array | No | Filter by refusal ground (2d). Office-local vocabulary. |
| `trademark_id` | string | No | Filter by citing application (tm_...). Must not be blank. |
| `action_date_gte` | string | No | Office action date >= (YYYY-MM-DD) |
| `action_date_lte` | string | No | Office action date <= (YYYY-MM-DD) |
| `cited_trademark_id` | string | No | Filter by cited mark (tm_...). Must not be blank. Matches the same rows as `GET /v1/trademarks/{id}/cited-by`, which includes REFERENCE-MATCHED citations: rows whose `cited_trademark` is `null` because the cited mark was never resolved to a link, but whose `cited_ref` is this mark's application or registration number in the same office. So a returned row does not necessarily carry the id you filtered on — do not assert `cited_trademark.id === <filter>`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Trademark Classifications

**Slug:** `SIGNA_LIST_CLASSIFICATIONS`

List or search Nice classes used to classify trademark goods and services.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum classifications to return in this page (1-500). |
| `query` | string | No | Case-insensitive text to find in classification titles (maximum 200 characters). |
| `cursor` | string | No | Opaque cursor returned by the previous page; omit for the first page. |
| `classification_type` | string ("goods" | "services") | No | Restrict results to goods classes 1-34 or services classes 35-45. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Deadline Coverage Gaps

**Slug:** `SIGNA_LIST_DEADLINE_COVERAGE`

List docketed trademarks whose maintenance or prosecution deadlines Signa cannot fully compute.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Page size. |
| `cursor` | string | No | Opaque cursor from the previous page. |
| `portfolio_id` | string | No | Limit coverage gaps to one portfolio. |
| `trademark_id` | string | No | Limit coverage gaps to one trademark. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Deadline Reminders

**Slug:** `SIGNA_LIST_DEADLINE_REMINDERS`

List pending and active deadline-reminder subscriptions for the organization.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Deadline Rules

**Slug:** `SIGNA_LIST_DEADLINE_RULES`

List modeled trademark maintenance deadline rules with statutory citations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filing_route` | array | No | Filing routes, comma-separated. |
| `jurisdiction` | array | No | Jurisdiction codes, comma-separated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Deadlines

**Slug:** `SIGNA_LIST_DEADLINES`

List the organization's portfolio deadline docket one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | array | No | Deadline types, comma-separated. |
| `limit` | integer | No | Page size. |
| `cursor` | string | No | Opaque seek cursor from the previous page. |
| `office` | array | No | Office codes, comma-separated. |
| `source` | string ("computed" | "manual") | No | Deadline source. |
| `status` | array | No | Workflow statuses, comma-separated. |
| `urgency` | array | No | Urgencies, comma-separated. |
| `due_after` | string | No | Earliest due date, inclusive. |
| `due_before` | string | No | Latest due date, inclusive. |
| `engine_state` | array | No | Engine states, comma-separated; defaults to live and unverified. |
| `portfolio_id` | string | No | Limit results to one portfolio. |
| `trademark_id` | string | No | Limit results to one trademark. |
| `review_required` | boolean | No | Filter by review flag. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List design codes

**Slug:** `SIGNA_LIST_DESIGN_CODES`

List Vienna classification design codes. Optional search by description, filter by depth (1-3) or category.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Search descriptions (case-insensitive contains) |
| `depth` | integer | No | Filter by depth level (1=category, 2=division, 3=section) |
| `limit` | integer | No | Max results (default: 100, max: 500) |
| `cursor` | string | No | Pagination cursor (code of last item) |
| `category` | string | No | Filter by 2-digit category code (e.g. "03") |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List entities

**Slug:** `SIGNA_LIST_ENTITIES`

List resolved entities with optional search and filters. q searches the survivorship name and member name variants. An owner not linked to any entity is not listed (see /v1/owners). Served from the search index: when it is unavailable the endpoint returns 503.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Fuzzy name search across the survivorship name and member name variants. |
| `lei` | string | No | Exact LEI (uppercased server-side). Matches the entity survivorship LEI or a member owner GLEIF LEI, skipping a member LEI that Signa assigns to another entity. |
| `sort` | string ("-trademark_count" | "trademark_count" | "-name" | "name" | "-member_count" | "member_count") | No | Sort field with optional - prefix for descending. Options: trademark_count, name, member_count. Default: -trademark_count (or -relevance with q). |
| `limit` | integer | No | Page size (1-100, default 20) |
| `cursor` | string | No | Pagination cursor |
| `ticker` | string | No | Exact ticker symbol (uppercased server-side). Matches DIRECT tickers AND inherited/subsidiary tickers (entities.listing_ticker): an entity inherits the ticker of the nearest listed company up its GLEIF direct-parent chain, else of its listed GLEIF ultimate parent. Subsidiaries without a GLEIF-reported parent are not matched. Ultimate-parent inheritance takes effect after the weekly GLEIF refresh. Also covers member-owner SEC company tickers. |
| `has_lei` | boolean | No | Filter to entities with a GLEIF LEI (the entity survivorship LEI or a member owner GLEIF link, skipping a member LEI that Signa assigns to another entity). |
| `legal_form` | string ("individual" | "corporation" | "partnership" | "government" | "association" | "trust" | "sole_proprietorship" | "cooperative" | "foundation" | "other") | No | Filter by the entity's `legal_form` (the kind of legal person). Valid values: individual, corporation, partnership, government, association, trust, sole_proprietorship, cooperative, foundation, other. Replaces the retired `entity_type` parameter. |
| `country_code` | string | No | Filter by survivorship country code. Two-letter country code, case-insensitive. Office spellings match too: `EU` and `EM` both match records stored under either, as do `GB` and `UK` (`WIPO` is read as `WO`). Historical codes such as `DD` or `SU` are accepted; an empty value is no filter; a value that is not a two-letter code returns 400 `unknown_country_code`. |
| `include_total` | boolean | No | If true, returns total_count in the pagination object (exact up to 10,000, then total_count_approximate=true). |
| `publicly_traded` | boolean | No | Filter to publicly-listed entities: either a member owner is matched to an active SEC company with a ticker, OR the entity itself is listed / a subsidiary of a listed company (entities.listing_status). false/absent = no confirmed listing, NOT confirmed-private. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List entity trademarks

**Slug:** `SIGNA_LIST_ENTITY_TRADEMARKS`

List an entity's trademarks (summary tier): every mark whose owner is linked to the entity, with full Appendix A filter support. Scoped exactly like GET /v1/trademarks?entity_id= (the same resolved entity ids, no member-owner cap), so both return the same set for the same entity; the difference is that a missing entity is a 404 here and an empty page there. Rate class: search.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Search text within this entity's trademarks, ranked through the similarity channels (1-500 characters; one is enough here). One text only: a list of terms is searched with /v1/trademarks. |
| `id` | string | Yes | Entity ID (ent_...) |
| `sort` | string | No | Sort field(s), comma-separated, - prefix for desc. Default: relevance with q, mark text order with a mark_text filter and no q, otherwise -filing_date. |
| `limit` | integer | No | Page size (1-100, default 20) |
| `cursor` | string | No | Pagination cursor from previous response |
| `fields` | array | No | Sparse top-level field projection. id and object are always retained. Fields you do not request are omitted, although the response schema lists every field. |
| `office` | string | No | Office code (required with application_number or registration_number) |
| `firm_id` | string | No | Filter by firm ID (firm_...) |
| `include` | array | No | Comma-separated optional row projections. `full_goods_services` returns full classifications[].goods_services_text. `match_details` adds match.details (the matched lanes and the ranking factors applied) to each hit. |
| `offices` | array | No | Filter by office code(s) |
| `has_media` | boolean | No | Filter by media presence |
| `ir_number` | string | No | International registration number |
| `is_madrid` | boolean | No | Filter Madrid marks |
| `owner_lei` | string | No | Filter by exact LEI (uppercased server-side). |
| `highlights` | boolean | No | If true, includes highlight snippets for a ranked q. |
| `owner_name` | string | No | Filter by owner name. Case and accents are ignored. By default every word must match, in any order, with other words allowed between them, so `KG Mobility` also matches `e-mobility ... Co. KG`. Set owner_name_match=phrase to require the words next to each other and in order. For one exact owner use owner_id. |
| `right_kind` | string ("trademark" | "trade_name" | "commercial_notice" | "geographical_indication" | "other") | No | Filter by right kind. Valid values: trademark, trade_name, commercial_notice, geographical_indication, other. |
| `scope_kind` | array | No | Filter by scope kind(s) |
| `similarity` | array | No | Similarity channels for q, comma-separated: identical, fuzzy, embedded, phonetic, lookalike. Default identical,fuzzy,embedded,lookalike; identical is always on. Requires q. |
| `attorney_id` | string | No | Filter by attorney ID (att_...) |
| `filing_basis` | array | No | Filter by namespaced filing basis code(s), e.g. US:1A |
| `filing_route` | array | No | Filter by filing route(s) |
| `is_retracted` | boolean | No | Filter retracted marks |
| `mark_text_is` | array | No | Marks where the whole mark equals the value (case, accents, punctuation, spacing and trademark notices ignored). Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `nice_classes` | array | No | Filter by Nice class number(s) |
| `owner_id_not` | array | No | Exclude marks held by these owners (own_...). Repeat the key for several ids. |
| `owner_ticker` | string | No | Filter by exact ticker symbol (uppercased server-side). |
| `status_stage` | array | No | Filter by status stage(s). "mixed" matches grouped IR rows whose designations disagree; it applies to the grouped view only, and a request served one row per record (international_registrations=expanded, or a grouped fallback) that filters on it is a 400. |
| `vienna_codes` | array | No | Filter by Vienna code(s) |
| `allow_partial` | boolean | No | Return 200 with search_meta.complete=false when the engine times out or a shard fails, instead of 503. Default false. |
| `entity_id_not` | array | No | Exclude marks whose owners are linked to these entities (ent_...). Repeat the key for several ids. |
| `include_total` | boolean | No | If true, returns total_count in the pagination object (exact up to 10,000, then total_count_approximate=true). |
| `jurisdictions` | array | No | Filter by jurisdiction code(s) (UK is read as GB, WIPO as WO) |
| `owner_country` | string | No | Filter by owner country code. Two-letter country code, case-insensitive. Office spellings match too: `EU` and `EM` both match records stored under either, as do `GB` and `UK` (`WIPO` is read as `WO`). Historical codes such as `DD` or `SU` are accepted; an empty value is no filter; a value that is not a two-letter code returns 400 `unknown_country_code`. |
| `owner_has_lei` | boolean | No | Filter by LEI presence. |
| `register_type` | string | No | Filter by the office register (`register.type`), e.g. principal or supplemental (US) or the CIPO register category (CA). Case-insensitive. |
| `status_reason` | array | No | Filter by status reason(s) |
| `updated_at_gt` | string | No | Updated at > (YYYY-MM-DD or ISO 8601) |
| `updated_at_lt` | string | No | Updated at < (YYYY-MM-DD or ISO 8601) |
| `expiry_date_gt` | string | No | Expiry date > (YYYY-MM-DD) |
| `expiry_date_lt` | string | No | Expiry date < (YYYY-MM-DD) |
| `filing_date_gt` | string | No | Filing date > (YYYY-MM-DD) |
| `filing_date_lt` | string | No | Filing date < (YYYY-MM-DD) |
| `include_family` | boolean | No | If true, expand the trademark set to this entity AND all of its family-tree descendants (via entities.parent_entity_id, a bounded cycle-safe downward walk), then run the same query over the expanded entity set. Default false (this entity only). A family graph larger than the walk bounds returns 422 (family_graph_too_large). |
| `include_timing` | boolean | No | If true, includes timing breakdown. |
| `is_series_mark` | boolean | No | Filter series marks |
| `mark_text_word` | array | No | Marks where the value appears as a whole word (or consecutive words) of the mark. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `status_primary` | array | No | Filter by primary status. Accepts a single value or comma-separated list. Valid values: pending, active, inactive, unknown, mixed. "mixed" matches grouped IR rows whose designations disagree; it applies to the grouped view only, and a request served one row per record (international_registrations=expanded, or a grouped fallback) that filters on it is a 400. |
| `updated_at_gte` | string | No | Updated at >= (YYYY-MM-DD or ISO 8601) |
| `updated_at_lte` | string | No | Updated at <= (YYYY-MM-DD or ISO 8601) |
| `expiry_date_gte` | string | No | Expiry date >= (YYYY-MM-DD) |
| `expiry_date_lte` | string | No | Expiry date <= (YYYY-MM-DD) |
| `filing_date_gte` | string | No | Filing date >= (YYYY-MM-DD) |
| `filing_date_lte` | string | No | Filing date <= (YYYY-MM-DD) |
| `has_proceedings` | boolean | No | Filter by proceedings presence |
| `territory_match` | string ("protection" | "direct") | No | How jurisdictions filters match: protection (default - includes regional rights whose membership covers the requested territory, e.g. a EUTM for jurisdictions=FR) or direct (literal territory legs only). |
| `us_design_codes` | array | No | Filter by U.S. design search code(s) |
| `challenge_states` | array | No | Filter by challenge state(s) |
| `entity_group_not` | array | No | Exclude marks linked to any entity in these entities' corporate families (ent_...). Repeat the key for several ids. |
| `mark_text_not_is` | array | No | Exclude marks where the whole mark equals the value (case, accents, punctuation, spacing and trademark notices ignored). Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `owner_name_match` | string ("all_words" | "phrase") | No | How owner_name matches. all_words (default): every word, in any order. phrase: the words next to each other and in order within one owner name, so `KG Mobility` matches `KG Mobility Corp.` but not `e-mobility ... Co. KG`. Punctuation, case and accents are ignored. Requires owner_name. |
| `priority_date_gt` | string | No | Priority date > (YYYY-MM-DD) |
| `priority_date_lt` | string | No | Priority date < (YYYY-MM-DD) |
| `seniority_claims` | string ("claimed" | "none" | "unknown") | No | Filter by seniority claim state: claimed, none, or unknown. |
| `mark_feature_type` | array | No | Filter by mark feature type(s) |
| `mark_text_pattern` | array | No | Marks where `*` matches any run, `?` one character, `\` escapes the next character; everything else is literal. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `opposition_status` | string ("open" | "not_started" | "closed" | "unknown") | No | Filter by derived opposition window status: open, not_started, closed, or unknown. |
| `priority_date_gte` | string | No | Priority date >= (YYYY-MM-DD) |
| `priority_date_lte` | string | No | Priority date <= (YYYY-MM-DD) |
| `trademark_ids_not` | array | No | Exclude these trademarks (tm_...); on the grouped view, the family row containing them. Up to 1000. Repeat the key for several ids. |
| `application_number` | string | No | Application number (requires office) |
| `attorney_firm_name` | string | No | Filter by attorney/firm name (fuzzy) |
| `mark_text_contains` | array | No | Marks where the value appears anywhere in the mark (folded like starts_with); at least 3 characters. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `mark_text_not_word` | array | No | Exclude marks where the value appears as a whole word (or consecutive words) of the mark. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `origin_office_code` | string | No | Madrid origin office code |
| `designation_date_gt` | string | No | Designation date after (YYYY-MM-DD). Date the designation was made under the Madrid Protocol (international registration date, or the subsequent-designation date). Set on Madrid designation records. Record grain only: the default grouped view falls back to one row per record with an `expanded_fallback` warning, and international_registrations=grouped returns 400. |
| `designation_date_lt` | string | No | Designation date before (YYYY-MM-DD). Date the designation was made under the Madrid Protocol (international registration date, or the subsequent-designation date). Set on Madrid designation records. Record grain only: the default grouped view falls back to one row per record with an `expanded_fallback` warning, and international_registrations=grouped returns 400. |
| `goods_services_text` | string | No | Filter by goods/services text |
| `mark_legal_category` | array | No | Filter by mark legal category(s) |
| `mark_text_ends_with` | array | No | Marks where the mark ends with the value (folded like starts_with); at least 3 characters. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `publication_date_gt` | string | No | Publication date > (YYYY-MM-DD) |
| `publication_date_lt` | string | No | Publication date < (YYYY-MM-DD) |
| `registration_number` | string | No | Registration number (requires office) |
| `renewal_due_date_gt` | string | No | Renewal due date > (YYYY-MM-DD) |
| `renewal_due_date_lt` | string | No | Renewal due date < (YYYY-MM-DD) |
| `termination_date_gt` | string | No | Termination date > (YYYY-MM-DD) |
| `termination_date_lt` | string | No | Termination date < (YYYY-MM-DD) |
| `designation_date_gte` | string | No | Designation date on or after (YYYY-MM-DD). Date the designation was made under the Madrid Protocol (international registration date, or the subsequent-designation date). Set on Madrid designation records. Record grain only: the default grouped view falls back to one row per record with an `expanded_fallback` warning, and international_registrations=grouped returns 400. |
| `designation_date_lte` | string | No | Designation date on or before (YYYY-MM-DD). Date the designation was made under the Madrid Protocol (international registration date, or the subsequent-designation date). Set on Madrid designation records. Record grain only: the default grouped view falls back to one row per record with an `expanded_fallback` warning, and international_registrations=grouped returns 400. |
| `publication_date_gte` | string | No | Publication date >= (YYYY-MM-DD) |
| `publication_date_lte` | string | No | Publication date <= (YYYY-MM-DD) |
| `registration_date_gt` | string | No | Registration date > (YYYY-MM-DD) |
| `registration_date_lt` | string | No | Registration date < (YYYY-MM-DD) |
| `renewal_due_date_gte` | string | No | Renewal due date >= (YYYY-MM-DD) |
| `renewal_due_date_lte` | string | No | Renewal due date <= (YYYY-MM-DD) |
| `termination_date_gte` | string | No | Termination date >= (YYYY-MM-DD) |
| `termination_date_lte` | string | No | Termination date <= (YYYY-MM-DD) |
| `mark_text_not_pattern` | array | No | Exclude marks where `*` matches any run, `?` one character, `\` escapes the next character; everything else is literal. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `mark_text_starts_with` | array | No | Marks where the mark begins with the value (case, accents, punctuation and spacing folded). Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `opposition_closes_gte` | string | No | Opposition window closes on or after this date (YYYY-MM-DD). |
| `opposition_closes_lte` | string | No | Opposition window closes on or before this date (YYYY-MM-DD). |
| `owner_publicly_traded` | boolean | No | Filter by public trading status. |
| `registration_date_gte` | string | No | Registration date >= (YYYY-MM-DD) |
| `registration_date_lte` | string | No | Registration date <= (YYYY-MM-DD) |
| `mark_text_not_contains` | array | No | Exclude marks where the value appears anywhere in the mark (folded like starts_with); at least 3 characters. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `mark_text_not_ends_with` | array | No | Exclude marks where the mark ends with the value (folded like starts_with); at least 3 characters. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `status_effective_date_gt` | string | No | Status effective date > (YYYY-MM-DD) |
| `status_effective_date_lt` | string | No | Status effective date < (YYYY-MM-DD) |
| `mark_text_not_starts_with` | array | No | Exclude marks where the mark begins with the value (case, accents, punctuation and spacing folded). Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `status_effective_date_gte` | string | No | Status effective date >= (YYYY-MM-DD) |
| `status_effective_date_lte` | string | No | Status effective date <= (YYYY-MM-DD) |
| `first_use_anywhere_date_gt` | string | No | First use anywhere date > (YYYY-MM-DD) |
| `first_use_anywhere_date_lt` | string | No | First use anywhere date < (YYYY-MM-DD) |
| `first_use_anywhere_date_gte` | string | No | First use anywhere date >= (YYYY-MM-DD) |
| `first_use_anywhere_date_lte` | string | No | First use anywhere date <= (YYYY-MM-DD) |
| `international_registrations` | string ("grouped" | "expanded") | No | International registration presentation. Default grouped → one row per mark/IR. Use expanded for one row per Madrid designation. |
| `first_use_in_commerce_date_gt` | string | No | First use in commerce date > (YYYY-MM-DD) |
| `first_use_in_commerce_date_lt` | string | No | First use in commerce date < (YYYY-MM-DD) |
| `first_use_in_commerce_date_gte` | string | No | First use in commerce date >= (YYYY-MM-DD) |
| `first_use_in_commerce_date_lte` | string | No | First use in commerce date <= (YYYY-MM-DD) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Events

**Slug:** `SIGNA_LIST_EVENTS`

List the organization's projected event feed. Use sort=id and after for durable replay checkpoints.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("-id" | "id") | No | Descending order, or ascending replay order. |
| `after` | string | No | Exclusive evt_* checkpoint, valid only with sort=id. |
| `limit` | integer | No | Page size. |
| `since` | string | No | ISO date or date-time lower bound. |
| `cursor` | string | No | Opaque pagination cursor. |
| `event_type` | array | No | Event types, serialized as the provider's comma-separated form. Deadline types require portfolios:manage. |
| `office_code` | array | No | Office codes, serialized as comma-separated values. |
| `portfolio_id` | string | No | Historical portfolio-membership snapshot filter; requires portfolios:manage. |
| `trademark_id` | string | No | tm_* trademark filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List event types

**Slug:** `SIGNA_LIST_EVENT_TYPES`

List the office event codes Signa has catalogued and the canonical `event_type` each maps to. The catalogue covers the USPTO (`US`), IP Australia (`AU`) and WIPO (`WO`) today; any other office returns an empty list, and its trademark events still carry their own `raw` code and label. `raw` is the office's verbatim code and label, as on a trademark event's `raw` (label null when we hold no verbatim office label for the code; every WIPO label is null because the catalogue's WIPO wording is Signa's).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Max results per page (default: 100, max: 500) |
| `cursor` | string | No | Pagination cursor — opaque value returned in `pagination.cursor` of the previous page |
| `office_code` | string | No | Filter by office code (the rows' `office_code`). WIPO ST.3 uppercase (e.g. US, EM); legacy acronym slugs (uspto, euipo) and EU are also accepted. Unknown query parameters are rejected with 400. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Feedback

**Slug:** `SIGNA_LIST_FEEDBACK`

List feedback submitted by the authenticated organization, newest first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | array | No | Types. |
| `limit` | integer | No | Page size. |
| `cursor` | string | No | Pagination cursor. |
| `status` | array | No | Statuses. |
| `created_at_lt` | string | No | Exclusive creation upper bound. |
| `created_at_gte` | string | No | Inclusive creation lower bound. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Official Fees

**Slug:** `SIGNA_LIST_FEES`

List Signa's bounded official-fee catalog with native amounts and source snapshots.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `action` | string ("filing" | "renewal" | "declaration_of_use" | "declaration_of_incontestability" | "statement_of_use" | "amendment_to_allege_use" | "sou_extension" | "opposition" | "oa_extension" | "expungement_oa_extension" | "petition_to_revive" | "restoration" | "continuation" | "restitutio" | "subsequent_designation" | "transfer" | "name_address_change" | "limitation" | "licence" | "division") | No | Fee action to include. |
| `office` | string | No | Office code or documented office alias. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List firm attorneys

**Slug:** `SIGNA_LIST_FIRM_ATTORNEYS`

List the attorneys with at least one current filing that names this firm, with per-firm counts (marks filed naming this firm), sorted by that count.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Firm ID (firm_...) |
| `limit` | integer | No | Page size (1-100, default 20) |
| `cursor` | string | No | Pagination cursor |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List firms

**Slug:** `SIGNA_LIST_FIRMS`

List firms with optional search and filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Fuzzy, typo-tolerant name match. Without `sort`, exact names and larger portfolios rank first. |
| `sort` | string ("-trademark_count" | "trademark_count" | "-attorney_count" | "attorney_count" | "-registration_rate" | "registration_rate" | "-grant_rate" | "grant_rate" | "-name" | "name") | No | Sort field with optional - prefix for descending. Options: trademark_count, attorney_count, grant_rate, name. `registration_rate` is a deprecated alias of `grant_rate` (same value). Default: -trademark_count |
| `limit` | integer | No | Page size (1-100, default 20) |
| `cursor` | string | No | Pagination cursor |
| `min_filings` | integer | No | Minimum trademark count |
| `country_code` | string | No | Filter by country code. Two-letter country code, case-insensitive. Office spellings match too: `EU` and `EM` both match records stored under either, as do `GB` and `UK` (`WIPO` is read as `WO`). Historical codes such as `DD` or `SU` are accepted; an empty value is no filter; a value that is not a two-letter code returns 400 `unknown_country_code`. |
| `include_total` | boolean | No | If true, returns total_count in the pagination object. |
| `min_attorneys` | integer | No | Minimum attorney count |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List firm trademarks

**Slug:** `SIGNA_LIST_FIRM_TRADEMARKS`

List trademarks whose filing names this firm.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Search text within this firm's trademarks, ranked through the similarity channels (1-500 characters; one is enough here). One text only: a list of terms is searched with /v1/trademarks. |
| `id` | string | Yes | Firm ID (firm_...) |
| `sort` | string | No | Sort field(s), comma-separated, - prefix for desc. Default: relevance with q, mark text order with a mark_text filter and no q, otherwise -filing_date. |
| `limit` | integer | No | Page size (1-100, default 20) |
| `cursor` | string | No | Pagination cursor |
| `fields` | array | No | Sparse top-level field projection. id and object are always retained. Fields you do not request are omitted, although the response schema lists every field. |
| `office` | string | No | Office code (required with application_number or registration_number) |
| `include` | array | No | Comma-separated optional row projections. `full_goods_services` returns full classifications[].goods_services_text. `match_details` adds match.details (the matched lanes and the ranking factors applied) to each hit. |
| `offices` | array | No | Filter by office code(s) |
| `owner_id` | array | No | Filter by owner (own_...). Takes one ID or a comma-separated list of up to 100; a mark matches when any listed owner holds it. Unlike owner_name this is an exact match on the owner record. A GET URL is limited to 2 KB, which holds about 45 IDs; send a longer list with POST /v1/trademarks. |
| `has_media` | boolean | No | Filter by media presence |
| `ir_number` | string | No | International registration number |
| `is_madrid` | boolean | No | Filter Madrid marks |
| `owner_lei` | string | No | Filter by exact LEI (uppercased server-side). |
| `highlights` | boolean | No | If true, includes highlight snippets for a ranked q. |
| `owner_name` | string | No | Filter by owner name. Case and accents are ignored. By default every word must match, in any order, with other words allowed between them, so `KG Mobility` also matches `e-mobility ... Co. KG`. Set owner_name_match=phrase to require the words next to each other and in order. For one exact owner use owner_id. |
| `right_kind` | string ("trademark" | "trade_name" | "commercial_notice" | "geographical_indication" | "other") | No | Filter by right kind. Valid values: trademark, trade_name, commercial_notice, geographical_indication, other. |
| `scope_kind` | array | No | Filter by scope kind(s) |
| `similarity` | array | No | Similarity channels for q, comma-separated: identical, fuzzy, embedded, phonetic, lookalike. Default identical,fuzzy,embedded,lookalike; identical is always on. Requires q. |
| `attorney_id` | string | No | Filter by attorney ID (att_...) |
| `filing_basis` | array | No | Filter by namespaced filing basis code(s), e.g. US:1A |
| `filing_route` | array | No | Filter by filing route(s) |
| `is_retracted` | boolean | No | Filter retracted marks |
| `mark_text_is` | array | No | Marks where the whole mark equals the value (case, accents, punctuation, spacing and trademark notices ignored). Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `nice_classes` | array | No | Filter by Nice class number(s) |
| `owner_id_not` | array | No | Exclude marks held by these owners (own_...). Repeat the key for several ids. |
| `owner_ticker` | string | No | Filter by exact ticker symbol (uppercased server-side). |
| `status_stage` | array | No | Filter by status stage(s). "mixed" matches grouped IR rows whose designations disagree; it applies to the grouped view only, and a request served one row per record (international_registrations=expanded, or a grouped fallback) that filters on it is a 400. |
| `vienna_codes` | array | No | Filter by Vienna code(s) |
| `allow_partial` | boolean | No | Return 200 with search_meta.complete=false when the engine times out or a shard fails, instead of 503. Default false. |
| `entity_id_not` | array | No | Exclude marks whose owners are linked to these entities (ent_...). Repeat the key for several ids. |
| `include_total` | boolean | No | If true, returns total_count in the pagination object (exact up to 10,000, then total_count_approximate=true). |
| `jurisdictions` | array | No | Filter by jurisdiction code(s) (UK is read as GB, WIPO as WO) |
| `owner_country` | string | No | Filter by owner country code. Two-letter country code, case-insensitive. Office spellings match too: `EU` and `EM` both match records stored under either, as do `GB` and `UK` (`WIPO` is read as `WO`). Historical codes such as `DD` or `SU` are accepted; an empty value is no filter; a value that is not a two-letter code returns 400 `unknown_country_code`. |
| `owner_has_lei` | boolean | No | Filter by LEI presence. A false/absent value means no confirmed match — owner→company matching covers ~6% of marks. |
| `register_type` | string | No | Filter by the office register (`register.type`), e.g. principal or supplemental (US) or the CIPO register category (CA). Case-insensitive. |
| `status_reason` | array | No | Filter by status reason(s) |
| `updated_at_gt` | string | No | Updated at > (YYYY-MM-DD or ISO 8601) |
| `updated_at_lt` | string | No | Updated at < (YYYY-MM-DD or ISO 8601) |
| `expiry_date_gt` | string | No | Expiry date > (YYYY-MM-DD) |
| `expiry_date_lt` | string | No | Expiry date < (YYYY-MM-DD) |
| `filing_date_gt` | string | No | Filing date > (YYYY-MM-DD) |
| `filing_date_lt` | string | No | Filing date < (YYYY-MM-DD) |
| `include_timing` | boolean | No | If true, includes timing breakdown. |
| `is_series_mark` | boolean | No | Filter series marks |
| `mark_text_word` | array | No | Marks where the value appears as a whole word (or consecutive words) of the mark. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `status_primary` | array | No | Filter by primary status. Accepts a single value or a comma-separated list (e.g. `active,pending` for live marks). Valid values: pending, active, inactive, unknown, mixed. "mixed" matches grouped IR rows whose designations disagree; it applies to the grouped view only, and a request served one row per record (international_registrations=expanded, or a grouped fallback) that filters on it is a 400. |
| `updated_at_gte` | string | No | Updated at >= (YYYY-MM-DD or ISO 8601) |
| `updated_at_lte` | string | No | Updated at <= (YYYY-MM-DD or ISO 8601) |
| `expiry_date_gte` | string | No | Expiry date >= (YYYY-MM-DD) |
| `expiry_date_lte` | string | No | Expiry date <= (YYYY-MM-DD) |
| `filing_date_gte` | string | No | Filing date >= (YYYY-MM-DD) |
| `filing_date_lte` | string | No | Filing date <= (YYYY-MM-DD) |
| `has_proceedings` | boolean | No | Filter by proceedings presence |
| `territory_match` | string ("protection" | "direct") | No | How jurisdictions filters match: protection (default - includes regional rights whose membership covers the requested territory, e.g. a EUTM for jurisdictions=FR) or direct (literal territory legs only). |
| `us_design_codes` | array | No | Filter by U.S. design search code(s) |
| `challenge_states` | array | No | Filter by challenge state(s) |
| `entity_group_not` | array | No | Exclude marks linked to any entity in these entities' corporate families (ent_...). Repeat the key for several ids. |
| `mark_text_not_is` | array | No | Exclude marks where the whole mark equals the value (case, accents, punctuation, spacing and trademark notices ignored). Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `owner_name_match` | string ("all_words" | "phrase") | No | How owner_name matches. all_words (default): every word, in any order. phrase: the words next to each other and in order within one owner name, so `KG Mobility` matches `KG Mobility Corp.` but not `e-mobility ... Co. KG`. Punctuation, case and accents are ignored. Requires owner_name. |
| `priority_date_gt` | string | No | Priority date > (YYYY-MM-DD) |
| `priority_date_lt` | string | No | Priority date < (YYYY-MM-DD) |
| `seniority_claims` | string ("claimed" | "none" | "unknown") | No | Filter by seniority claim state: claimed, none, or unknown. |
| `mark_feature_type` | array | No | Filter by mark feature type(s) |
| `mark_text_pattern` | array | No | Marks where `*` matches any run, `?` one character, `\` escapes the next character; everything else is literal. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `opposition_status` | string ("open" | "not_started" | "closed" | "unknown") | No | Filter by derived opposition window status: open, not_started, closed, or unknown. |
| `priority_date_gte` | string | No | Priority date >= (YYYY-MM-DD) |
| `priority_date_lte` | string | No | Priority date <= (YYYY-MM-DD) |
| `trademark_ids_not` | array | No | Exclude these trademarks (tm_...); on the grouped view, the family row containing them. Up to 1000. Repeat the key for several ids. |
| `application_number` | string | No | Application number (requires office) |
| `attorney_firm_name` | string | No | Filter by attorney/firm name (fuzzy) |
| `mark_text_contains` | array | No | Marks where the value appears anywhere in the mark (folded like starts_with); at least 3 characters. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `mark_text_not_word` | array | No | Exclude marks where the value appears as a whole word (or consecutive words) of the mark. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `origin_office_code` | string | No | Madrid origin office code |
| `designation_date_gt` | string | No | Designation date after (YYYY-MM-DD). Date the designation was made under the Madrid Protocol (international registration date, or the subsequent-designation date). Set on Madrid designation records. Record grain only: the default grouped view falls back to one row per record with an `expanded_fallback` warning, and international_registrations=grouped returns 400. |
| `designation_date_lt` | string | No | Designation date before (YYYY-MM-DD). Date the designation was made under the Madrid Protocol (international registration date, or the subsequent-designation date). Set on Madrid designation records. Record grain only: the default grouped view falls back to one row per record with an `expanded_fallback` warning, and international_registrations=grouped returns 400. |
| `goods_services_text` | string | No | Filter by goods/services text |
| `mark_legal_category` | array | No | Filter by mark legal category(ies) |
| `mark_text_ends_with` | array | No | Marks where the mark ends with the value (folded like starts_with); at least 3 characters. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `publication_date_gt` | string | No | Publication date > (YYYY-MM-DD) |
| `publication_date_lt` | string | No | Publication date < (YYYY-MM-DD) |
| `registration_number` | string | No | Registration number (requires office) |
| `renewal_due_date_gt` | string | No | Renewal due date > (YYYY-MM-DD) |
| `renewal_due_date_lt` | string | No | Renewal due date < (YYYY-MM-DD) |
| `termination_date_gt` | string | No | Termination date > (YYYY-MM-DD) |
| `termination_date_lt` | string | No | Termination date < (YYYY-MM-DD) |
| `designation_date_gte` | string | No | Designation date on or after (YYYY-MM-DD). Date the designation was made under the Madrid Protocol (international registration date, or the subsequent-designation date). Set on Madrid designation records. Record grain only: the default grouped view falls back to one row per record with an `expanded_fallback` warning, and international_registrations=grouped returns 400. |
| `designation_date_lte` | string | No | Designation date on or before (YYYY-MM-DD). Date the designation was made under the Madrid Protocol (international registration date, or the subsequent-designation date). Set on Madrid designation records. Record grain only: the default grouped view falls back to one row per record with an `expanded_fallback` warning, and international_registrations=grouped returns 400. |
| `publication_date_gte` | string | No | Publication date >= (YYYY-MM-DD) |
| `publication_date_lte` | string | No | Publication date <= (YYYY-MM-DD) |
| `registration_date_gt` | string | No | Registration date > (YYYY-MM-DD) |
| `registration_date_lt` | string | No | Registration date < (YYYY-MM-DD) |
| `renewal_due_date_gte` | string | No | Renewal due date >= (YYYY-MM-DD) |
| `renewal_due_date_lte` | string | No | Renewal due date <= (YYYY-MM-DD) |
| `termination_date_gte` | string | No | Termination date >= (YYYY-MM-DD) |
| `termination_date_lte` | string | No | Termination date <= (YYYY-MM-DD) |
| `mark_text_not_pattern` | array | No | Exclude marks where `*` matches any run, `?` one character, `\` escapes the next character; everything else is literal. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `mark_text_starts_with` | array | No | Marks where the mark begins with the value (case, accents, punctuation and spacing folded). Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `opposition_closes_gte` | string | No | Opposition window closes on or after this date (YYYY-MM-DD). |
| `opposition_closes_lte` | string | No | Opposition window closes on or before this date (YYYY-MM-DD). |
| `owner_publicly_traded` | boolean | No | Filter by public trading status. A false/absent value means no confirmed match, NOT confirmed private — owner→company matching covers ~6% of marks. |
| `registration_date_gte` | string | No | Registration date >= (YYYY-MM-DD) |
| `registration_date_lte` | string | No | Registration date <= (YYYY-MM-DD) |
| `mark_text_not_contains` | array | No | Exclude marks where the value appears anywhere in the mark (folded like starts_with); at least 3 characters. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `mark_text_not_ends_with` | array | No | Exclude marks where the mark ends with the value (folded like starts_with); at least 3 characters. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `status_effective_date_gt` | string | No | Status effective date > (YYYY-MM-DD) |
| `status_effective_date_lt` | string | No | Status effective date < (YYYY-MM-DD) |
| `mark_text_not_starts_with` | array | No | Exclude marks where the mark begins with the value (case, accents, punctuation and spacing folded). Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `status_effective_date_gte` | string | No | Status effective date >= (YYYY-MM-DD) |
| `status_effective_date_lte` | string | No | Status effective date <= (YYYY-MM-DD) |
| `first_use_anywhere_date_gt` | string | No | First use anywhere date > (YYYY-MM-DD) |
| `first_use_anywhere_date_lt` | string | No | First use anywhere date < (YYYY-MM-DD) |
| `first_use_anywhere_date_gte` | string | No | First use anywhere date >= (YYYY-MM-DD) |
| `first_use_anywhere_date_lte` | string | No | First use anywhere date <= (YYYY-MM-DD) |
| `international_registrations` | string ("grouped" | "expanded") | No | International registration presentation. Default grouped → one row per mark/IR. Use expanded for one row per Madrid designation. |
| `first_use_in_commerce_date_gt` | string | No | First use in commerce date > (YYYY-MM-DD) |
| `first_use_in_commerce_date_lt` | string | No | First use in commerce date < (YYYY-MM-DD) |
| `first_use_in_commerce_date_gte` | string | No | First use in commerce date >= (YYYY-MM-DD) |
| `first_use_in_commerce_date_lte` | string | No | First use in commerce date <= (YYYY-MM-DD) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List goods services

**Slug:** `SIGNA_LIST_GOODS_SERVICES`

Browse/search the aggregated goods & services term catalog (Harmonised Database + USPTO ID Manual). At least one of `q` or `class` is required. Pass `class` to scope to one Nice class, or `q` to substring-search across all classes — or both.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Substring search across term text (2-200 characters). Optional if `class` is provided. |
| `limit` | integer | No | Max results (default: 20, max: 100) |
| `cursor` | string | No | Pagination cursor — opaque value returned in `pagination.cursor` of the previous page |
| `language` | string | No | Language code (default: en) |
| `class_number` | integer | No | Nice class number (1-45). Optional if `q` is provided. |
| `harmonised_only` | boolean | No | Only return terms on a harmonised list (the EUIPO Harmonised Database, or a USPTO ID Manual entry marked TM5-harmonised). Not a per-office acceptance statement: check accepted_offices. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List jurisdictions

**Slug:** `SIGNA_LIST_JURISDICTIONS`

List supported jurisdictions one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Max results per page (default: 100, max: 500) |
| `cursor` | string | No | Pagination cursor — opaque value returned in `pagination.cursor` of the previous page |
| `include_total` | boolean | No | If true, returns total_count in the pagination object. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List API Request Logs

**Slug:** `SIGNA_LIST_LOGS`

List organization API request logs with date, outcome, key, and endpoint filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | No | Alias for end_date. |
| `from_` | string | No | Alias for start_date. |
| `limit` | integer | No | Page size. |
| `cursor` | string | No | Pagination cursor. |
| `method` | string | No | HTTP method. |
| `search` | string | No | Path or request-ID substring. |
| `success` | boolean | No | Filter by request outcome. |
| `end_date` | string | No | ISO 8601 range end. |
| `api_key_id` | string | No | API key ID. |
| `start_date` | string | No | ISO 8601 range start. |
| `status_code` | integer | No | HTTP status. |
| `endpoint_type` | string | No | Endpoint billing type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Trademark Offices

**Slug:** `SIGNA_LIST_OFFICES`

List one page of trademark offices and their coverage status for use in trademark search filters. Pass the returned cursor to retrieve the next page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum offices to return in this page (1-500). |
| `cursor` | string | No | Opaque cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List office votes

**Slug:** `SIGNA_LIST_OFFICE_VOTES`

List the authenticated organization's office-coverage votes, alphabetical by office code. The set is bounded by the votable vocabulary, so the list is always a single page: `limit` and `cursor` are accepted for list-client compatibility but do not affect the response, which always returns every vote with `has_more: false`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Accepted for list-client compatibility and ignored — the list is single-page. |
| `cursor` | string | No | Accepted for list-client compatibility and ignored — the list is single-page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Opposition Rules

**Slug:** `SIGNA_LIST_OPPOSITION_RULES`

List modeled opposition-window rules with statutory citations and office time zones.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `office` | array | No | Office codes, comma-separated. |
| `filing_route` | array | No | Filing routes, comma-separated. |
| `jurisdiction` | array | No | Jurisdiction codes, comma-separated. |
| `trigger_event` | array | No | Trigger events, comma-separated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List owner related

**Slug:** `SIGNA_LIST_OWNER_RELATED`

List related owners via the GLEIF corporate hierarchy (parent/child relationships) of the `lei` GET /v1/owners/{id} shows: the owner's own first GLEIF LEI, else its entity's.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Owner ID (own_...) |
| `limit` | integer | No | Page size (1-100, default 20) |
| `cursor` | string | No | Pagination cursor |
| `direction` | string ("parent" | "child") | No | Filter by relationship direction: parent or child. Omit to return both. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List owners

**Slug:** `SIGNA_LIST_OWNERS`

List owners with optional search and filters. Suppressed owners are always excluded.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Fuzzy, typo-tolerant name match. Without `sort`, exact names and larger portfolios rank first; with `ticker`, `lei`, `publicly_traded` or `has_lei`, matches are ordered by trademark count instead. |
| `lei` | string | No | Owners with this value (case-insensitive) among their LEIs: the owner's own GLEIF LEIs or, when it has none and is linked to an entity, the entity's LEIs (its own LEI and its members' GLEIF LEIs). The `lei` GET /v1/owners/{id} serves is always one of them. |
| `sort` | string ("-trademark_count" | "trademark_count" | "-registration_rate" | "registration_rate" | "-grant_rate" | "grant_rate" | "-latest_filing" | "latest_filing" | "-name" | "name") | No | Sort field with optional - prefix for descending. Options: trademark_count, grant_rate, latest_filing, name. `registration_rate` is a deprecated alias of `grant_rate` (same value). Default: -trademark_count |
| `limit` | integer | No | Page size (1-100, default 20) |
| `cursor` | string | No | Pagination cursor |
| `ticker` | string | No | Owners with this value (case-insensitive) among their tickers: the owner's own SEC tickers or, when it has none and is linked to an entity, the entity's `tickers` (members' SEC tickers and its listing ticker, which can be inherited from a listed ancestor). The `ticker` GET /v1/owners/{id} serves is always one of them. Tickers on GLEIF records do not match. |
| `has_lei` | boolean | No | true: owners with a GLEIF LEI among their own matches. Reads the owner's own matches only, not its entity's, so it can differ from the `has_lei` GET /v1/owners/{id} serves for an owner linked to an entity. false = no confirmed match of its own. |
| `legal_form` | string ("individual" | "corporation" | "partnership" | "government" | "association" | "trust" | "sole_proprietorship" | "cooperative" | "foundation" | "other") | No | Filter by the owner's `legal_form` (the kind of legal person). Valid values: individual, corporation, partnership, government, association, trust, sole_proprietorship, cooperative, foundation, other. Replaces the retired `entity_type` parameter. |
| `country_code` | string | No | Filter by the owner's country code, case-insensitive. Office spellings match too: `EU` and `EM` both return owners stored under either, as do `GB` and `UK`. Historical codes such as `DD` or `SU` are accepted. A value that is not a two-letter code returns 400. |
| `include_total` | boolean | No | If true, returns total_count in the pagination object. |
| `publicly_traded` | boolean | No | true: owners with an active SEC company with a ticker among their own matches. Reads the owner's own matches only, not its entity's, so it can differ from the `publicly_traded` GET /v1/owners/{id} serves for an owner linked to an entity. false = no confirmed match of its own, NOT confirmed-private. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List owner trademarks

**Slug:** `SIGNA_LIST_OWNER_TRADEMARKS`

List an owner's trademarks with full Appendix A filter support. Returns summary tier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Search text within this owner's trademarks, ranked through the similarity channels (1-500 characters; one is enough here). One text only: a list of terms is searched with /v1/trademarks. |
| `id` | string | Yes | Owner ID (own_...) |
| `sort` | string | No | Sort field(s), comma-separated, - prefix for desc. Default: relevance with q, mark text order with a mark_text filter and no q, otherwise -filing_date. |
| `limit` | integer | No | Page size (1-100, default 20) |
| `cursor` | string | No | Pagination cursor from previous response |
| `fields` | array | No | Sparse top-level field projection. id and object are always retained. Fields you do not request are omitted, although the response schema lists every field. |
| `office` | string | No | Office code (required with application_number or registration_number) |
| `firm_id` | string | No | Filter by firm ID (firm_...) |
| `include` | array | No | Comma-separated optional row projections. `full_goods_services` returns full classifications[].goods_services_text. `match_details` adds match.details (the matched lanes and the ranking factors applied) to each hit. |
| `offices` | array | No | Filter by office code(s) |
| `has_media` | boolean | No | Filter by media presence |
| `ir_number` | string | No | International registration number |
| `is_madrid` | boolean | No | Filter Madrid marks |
| `owner_lei` | string | No | Filter by exact LEI (uppercased server-side). |
| `highlights` | boolean | No | If true, includes highlight snippets for a ranked q. |
| `owner_name` | string | No | Filter by owner name. Case and accents are ignored. By default every word must match, in any order, with other words allowed between them, so `KG Mobility` also matches `e-mobility ... Co. KG`. Set owner_name_match=phrase to require the words next to each other and in order. For one exact owner use owner_id. |
| `right_kind` | string ("trademark" | "trade_name" | "commercial_notice" | "geographical_indication" | "other") | No | Filter by right kind. Valid values: trademark, trade_name, commercial_notice, geographical_indication, other. |
| `scope_kind` | array | No | Filter by scope kind(s) |
| `similarity` | array | No | Similarity channels for q, comma-separated: identical, fuzzy, embedded, phonetic, lookalike. Default identical,fuzzy,embedded,lookalike; identical is always on. Requires q. |
| `attorney_id` | string | No | Filter by attorney ID (att_...) |
| `filing_basis` | array | No | Filter by namespaced filing basis code(s), e.g. US:1A |
| `filing_route` | array | No | Filter by filing route(s) |
| `is_retracted` | boolean | No | Filter retracted marks |
| `mark_text_is` | array | No | Marks where the whole mark equals the value (case, accents, punctuation, spacing and trademark notices ignored). Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `nice_classes` | array | No | Filter by Nice class number(s) |
| `owner_id_not` | array | No | Exclude marks held by these owners (own_...). Repeat the key for several ids. |
| `owner_ticker` | string | No | Filter by exact ticker symbol (uppercased server-side). |
| `status_stage` | array | No | Filter by status stage(s). "mixed" matches grouped IR rows whose designations disagree; it applies to the grouped view only, and a request served one row per record (international_registrations=expanded, or a grouped fallback) that filters on it is a 400. |
| `vienna_codes` | array | No | Filter by Vienna code(s) |
| `allow_partial` | boolean | No | Return 200 with search_meta.complete=false when the engine times out or a shard fails, instead of 503. Default false. |
| `entity_id_not` | array | No | Exclude marks whose owners are linked to these entities (ent_...). Repeat the key for several ids. |
| `include_total` | boolean | No | If true, returns total_count in the pagination object (exact up to 10,000, then total_count_approximate=true). |
| `jurisdictions` | array | No | Filter by jurisdiction code(s) (UK is read as GB, WIPO as WO) |
| `owner_country` | string | No | Filter by owner country code. Two-letter country code, case-insensitive. Office spellings match too: `EU` and `EM` both match records stored under either, as do `GB` and `UK` (`WIPO` is read as `WO`). Historical codes such as `DD` or `SU` are accepted; an empty value is no filter; a value that is not a two-letter code returns 400 `unknown_country_code`. |
| `owner_has_lei` | boolean | No | Filter by LEI presence. A false/absent value means no confirmed match — owner→company matching covers ~6% of marks. |
| `register_type` | string | No | Filter by the office register (`register.type`), e.g. principal or supplemental (US) or the CIPO register category (CA). Case-insensitive. |
| `status_reason` | array | No | Filter by status reason(s) |
| `updated_at_gt` | string | No | Updated at > (YYYY-MM-DD or ISO 8601) |
| `updated_at_lt` | string | No | Updated at < (YYYY-MM-DD or ISO 8601) |
| `expiry_date_gt` | string | No | Expiry date > (YYYY-MM-DD) |
| `expiry_date_lt` | string | No | Expiry date < (YYYY-MM-DD) |
| `filing_date_gt` | string | No | Filing date > (YYYY-MM-DD) |
| `filing_date_lt` | string | No | Filing date < (YYYY-MM-DD) |
| `include_timing` | boolean | No | If true, includes timing breakdown. |
| `is_series_mark` | boolean | No | Filter series marks |
| `mark_text_word` | array | No | Marks where the value appears as a whole word (or consecutive words) of the mark. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `status_primary` | array | No | Filter by primary status. Accepts a single value or a comma-separated list (e.g. `active,pending` for live marks). Valid values: pending, active, inactive, unknown, mixed. "mixed" matches grouped IR rows whose designations disagree; it applies to the grouped view only, and a request served one row per record (international_registrations=expanded, or a grouped fallback) that filters on it is a 400. |
| `updated_at_gte` | string | No | Updated at >= (YYYY-MM-DD or ISO 8601) |
| `updated_at_lte` | string | No | Updated at <= (YYYY-MM-DD or ISO 8601) |
| `expiry_date_gte` | string | No | Expiry date >= (YYYY-MM-DD) |
| `expiry_date_lte` | string | No | Expiry date <= (YYYY-MM-DD) |
| `filing_date_gte` | string | No | Filing date >= (YYYY-MM-DD) |
| `filing_date_lte` | string | No | Filing date <= (YYYY-MM-DD) |
| `has_proceedings` | boolean | No | Filter by proceedings presence |
| `territory_match` | string ("protection" | "direct") | No | How jurisdictions filters match: protection (default - includes regional rights whose membership covers the requested territory, e.g. a EUTM for jurisdictions=FR) or direct (literal territory legs only). |
| `us_design_codes` | array | No | Filter by U.S. design search code(s) |
| `challenge_states` | array | No | Filter by challenge state(s) |
| `entity_group_not` | array | No | Exclude marks linked to any entity in these entities' corporate families (ent_...). Repeat the key for several ids. |
| `mark_text_not_is` | array | No | Exclude marks where the whole mark equals the value (case, accents, punctuation, spacing and trademark notices ignored). Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `owner_name_match` | string ("all_words" | "phrase") | No | How owner_name matches. all_words (default): every word, in any order. phrase: the words next to each other and in order within one owner name, so `KG Mobility` matches `KG Mobility Corp.` but not `e-mobility ... Co. KG`. Punctuation, case and accents are ignored. Requires owner_name. |
| `priority_date_gt` | string | No | Priority date > (YYYY-MM-DD) |
| `priority_date_lt` | string | No | Priority date < (YYYY-MM-DD) |
| `seniority_claims` | string ("claimed" | "none" | "unknown") | No | Filter by seniority claim state: claimed, none, or unknown. |
| `mark_feature_type` | array | No | Filter by mark feature type(s) |
| `mark_text_pattern` | array | No | Marks where `*` matches any run, `?` one character, `\` escapes the next character; everything else is literal. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `opposition_status` | string ("open" | "not_started" | "closed" | "unknown") | No | Filter by derived opposition window status: open, not_started, closed, or unknown. |
| `priority_date_gte` | string | No | Priority date >= (YYYY-MM-DD) |
| `priority_date_lte` | string | No | Priority date <= (YYYY-MM-DD) |
| `trademark_ids_not` | array | No | Exclude these trademarks (tm_...); on the grouped view, the family row containing them. Up to 1000. Repeat the key for several ids. |
| `application_number` | string | No | Application number (requires office) |
| `attorney_firm_name` | string | No | Filter by attorney/firm name (fuzzy) |
| `mark_text_contains` | array | No | Marks where the value appears anywhere in the mark (folded like starts_with); at least 3 characters. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `mark_text_not_word` | array | No | Exclude marks where the value appears as a whole word (or consecutive words) of the mark. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `origin_office_code` | string | No | Madrid origin office code |
| `designation_date_gt` | string | No | Designation date after (YYYY-MM-DD). Date the designation was made under the Madrid Protocol (international registration date, or the subsequent-designation date). Set on Madrid designation records. Record grain only: the default grouped view falls back to one row per record with an `expanded_fallback` warning, and international_registrations=grouped returns 400. |
| `designation_date_lt` | string | No | Designation date before (YYYY-MM-DD). Date the designation was made under the Madrid Protocol (international registration date, or the subsequent-designation date). Set on Madrid designation records. Record grain only: the default grouped view falls back to one row per record with an `expanded_fallback` warning, and international_registrations=grouped returns 400. |
| `goods_services_text` | string | No | Filter by goods/services text |
| `mark_legal_category` | array | No | Filter by mark legal category(s) |
| `mark_text_ends_with` | array | No | Marks where the mark ends with the value (folded like starts_with); at least 3 characters. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `publication_date_gt` | string | No | Publication date > (YYYY-MM-DD) |
| `publication_date_lt` | string | No | Publication date < (YYYY-MM-DD) |
| `registration_number` | string | No | Registration number (requires office) |
| `renewal_due_date_gt` | string | No | Renewal due date > (YYYY-MM-DD) |
| `renewal_due_date_lt` | string | No | Renewal due date < (YYYY-MM-DD) |
| `termination_date_gt` | string | No | Termination date > (YYYY-MM-DD) |
| `termination_date_lt` | string | No | Termination date < (YYYY-MM-DD) |
| `designation_date_gte` | string | No | Designation date on or after (YYYY-MM-DD). Date the designation was made under the Madrid Protocol (international registration date, or the subsequent-designation date). Set on Madrid designation records. Record grain only: the default grouped view falls back to one row per record with an `expanded_fallback` warning, and international_registrations=grouped returns 400. |
| `designation_date_lte` | string | No | Designation date on or before (YYYY-MM-DD). Date the designation was made under the Madrid Protocol (international registration date, or the subsequent-designation date). Set on Madrid designation records. Record grain only: the default grouped view falls back to one row per record with an `expanded_fallback` warning, and international_registrations=grouped returns 400. |
| `publication_date_gte` | string | No | Publication date >= (YYYY-MM-DD) |
| `publication_date_lte` | string | No | Publication date <= (YYYY-MM-DD) |
| `registration_date_gt` | string | No | Registration date > (YYYY-MM-DD) |
| `registration_date_lt` | string | No | Registration date < (YYYY-MM-DD) |
| `renewal_due_date_gte` | string | No | Renewal due date >= (YYYY-MM-DD) |
| `renewal_due_date_lte` | string | No | Renewal due date <= (YYYY-MM-DD) |
| `termination_date_gte` | string | No | Termination date >= (YYYY-MM-DD) |
| `termination_date_lte` | string | No | Termination date <= (YYYY-MM-DD) |
| `mark_text_not_pattern` | array | No | Exclude marks where `*` matches any run, `?` one character, `\` escapes the next character; everything else is literal. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `mark_text_starts_with` | array | No | Marks where the mark begins with the value (case, accents, punctuation and spacing folded). Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `opposition_closes_gte` | string | No | Opposition window closes on or after this date (YYYY-MM-DD). |
| `opposition_closes_lte` | string | No | Opposition window closes on or before this date (YYYY-MM-DD). |
| `owner_publicly_traded` | boolean | No | Filter by public trading status. A false/absent value means no confirmed match, NOT confirmed private — owner→company matching covers ~6% of marks. |
| `registration_date_gte` | string | No | Registration date >= (YYYY-MM-DD) |
| `registration_date_lte` | string | No | Registration date <= (YYYY-MM-DD) |
| `mark_text_not_contains` | array | No | Exclude marks where the value appears anywhere in the mark (folded like starts_with); at least 3 characters. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `mark_text_not_ends_with` | array | No | Exclude marks where the mark ends with the value (folded like starts_with); at least 3 characters. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `status_effective_date_gt` | string | No | Status effective date > (YYYY-MM-DD) |
| `status_effective_date_lt` | string | No | Status effective date < (YYYY-MM-DD) |
| `mark_text_not_starts_with` | array | No | Exclude marks where the mark begins with the value (case, accents, punctuation and spacing folded). Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `status_effective_date_gte` | string | No | Status effective date >= (YYYY-MM-DD) |
| `status_effective_date_lte` | string | No | Status effective date <= (YYYY-MM-DD) |
| `first_use_anywhere_date_gt` | string | No | First use anywhere date > (YYYY-MM-DD) |
| `first_use_anywhere_date_lt` | string | No | First use anywhere date < (YYYY-MM-DD) |
| `first_use_anywhere_date_gte` | string | No | First use anywhere date >= (YYYY-MM-DD) |
| `first_use_anywhere_date_lte` | string | No | First use anywhere date <= (YYYY-MM-DD) |
| `international_registrations` | string ("grouped" | "expanded") | No | International registration presentation. Default grouped → one row per mark/IR. Use expanded for one row per Madrid designation. |
| `first_use_in_commerce_date_gt` | string | No | First use in commerce date > (YYYY-MM-DD) |
| `first_use_in_commerce_date_lt` | string | No | First use in commerce date < (YYYY-MM-DD) |
| `first_use_in_commerce_date_gte` | string | No | First use in commerce date >= (YYYY-MM-DD) |
| `first_use_in_commerce_date_lte` | string | No | First use in commerce date <= (YYYY-MM-DD) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Portfolios

**Slug:** `SIGNA_LIST_PORTFOLIOS`

List the connected organization's trademark portfolios one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("-created_at" | "created_at" | "-updated_at" | "updated_at" | "-name" | "name") | No | Field and direction used to order portfolios. |
| `limit` | integer | No | Maximum portfolios to return in this page (1-100). |
| `cursor` | string | No | Opaque cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List proceedings

**Slug:** `SIGNA_LIST_PROCEEDINGS`

List proceedings across all trademarks. At least one filter is required. Proceedings are served only for offices whose `capabilities.proceedings` on `GET /v1/offices` is `available`; an `office_code` naming any other live office returns 422 `capability_not_available` without running a query or charging credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Search party name: a case-insensitive substring of a party name as the office recorded it (`%` and `_` match literally). It matches names only; it does not resolve related companies or subsidiaries. Combined with `party_role`, `party_owner_id` or `party_entity_id`, every party filter must match the same party: `q=Acme&party_role=opponent` returns proceedings where a party named Acme is the opponent. |
| `sort` | string ("-filed_date" | "filed_date" | "-decided_date" | "decided_date") | No | Sort field with optional - prefix for descending. Default: -filed_date |
| `limit` | integer | No | Page size (1-100, default 20) |
| `cursor` | string | No | Pagination cursor from previous response |
| `status` | string ("pending" | "decided_granted" | "decided_rejected" | "withdrawn" | "settled" | "suspended" | "partial" | "other") | No | Filter by status (pending, decided_granted, decided_rejected, withdrawn, settled, suspended, partial, other) |
| `entity_id` | string | No | Alias for party_entity_id (ent_...), with the same matching and validation (400 / 422 `entity_too_large`). |
| `party_role` | string ("opponent" | "petitioner" | "respondent" | "intervener" | "other") | No | Filter by party role. Combined with `q`, the party whose name matches must hold this role. The `party_role` aggregation still counts every role on the matching proceedings. |
| `office_code` | string | No | Filter by trademark office code. WIPO ST.3 uppercase (e.g. US, EM); legacy acronym slugs (uspto, euipo) and EU are also accepted. A live office whose `capabilities.proceedings` on GET /v1/offices is not `available` returns 422 `capability_not_available`; an unknown or planned office code returns 400. |
| `aggregations` | array | No | Optional faceted bucket maps (outcome, party_role, nice_class, office_code, filed_year, trademark_role). Buckets count the matching items, one per proceeding and linked mark, like the list; add trademark_role=contested to leave out the asserted marks (about one item per case). |
| `trademark_id` | string | No | Filter by trademark ID (tm_...) |
| `filed_date_lt` | string | No | Filed date < (YYYY-MM-DD) |
| `filed_date_gte` | string | No | Filed date >= (YYYY-MM-DD) |
| `party_owner_id` | string | No | Filter by party owner ID (own_...): proceedings where a party is linked to this owner. A party is linked only when the marks in the dispute show which owner it is and the names match with the same company suffix. Parties without a link are not returned, for example most Canadian and Australian opponents (they are matched only against the owner of the mark under challenge), a name that matches only without its company suffix, or a recorded name that lists several parties. Use `q` to match by name or for complete coverage. |
| `trademark_role` | string ("contested" | "asserted") | No | Filter by the linked mark's side: `contested` (the opposed / appealed mark) or `asserted` (a mark the opposer or petitioner pleaded). Distinct from `party_role`, which is about the named parties. |
| `contested_class` | integer | No | Filter by Nice class involved in the dispute (1-45) |
| `party_entity_id` | string | No | Filter by resolved or derived entity ID (ent_...): proceedings where a party is linked to any member owner of the entity. Linking works as for `party_owner_id`, and parties without a link are not returned; use `q` to match by name or for complete coverage. A malformed id returns 400 and an entity with more member owners than the cap returns 422 `entity_too_large`. |
| `proceeding_type` | string ("opposition" | "cancellation" | "revocation" | "invalidity" | "appeal" | "non_use_removal" | "court_action" | "other") | No | Filter by proceeding type (opposition, cancellation, revocation, invalidity, appeal, non_use_removal, court_action, other). A type that no office with `capabilities.proceedings = "available"` records (or that the requested `office_code` does not record) returns an empty page without running a query. |
| `decision_date_lt` | string | No | Decision date < (YYYY-MM-DD) |
| `decision_date_gte` | string | No | Decision date >= (YYYY-MM-DD) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Prosecution Rules

**Slug:** `SIGNA_LIST_PROSECUTION_RULES`

List modeled prosecution deadline rules and their citations, eras, extensions, and remedies.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `office` | array | No | Office codes, comma-separated. |
| `filing_route` | array | No | Filing routes, comma-separated. |
| `jurisdiction` | array | No | Jurisdiction codes, comma-separated. |
| `deadline_type` | array | No | Prosecution deadline types, comma-separated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List status codes

**Slug:** `SIGNA_LIST_STATUS_CODES`

List office status codes: the office's verbatim code and label (`raw`, as on a trademark's `status.raw`) and the canonical `primary`/`stage`/`reason` Signa maps it to. `raw.label` is null when we hold no verbatim office label for the code (for example USPTO codes today).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Max results per page (default: 100, max: 500) |
| `cursor` | string | No | Pagination cursor — opaque value returned in `pagination.cursor` of the previous page |
| `office_code` | string | No | Filter by office code (the rows' `office_code`). WIPO ST.3 uppercase (e.g. US, EM); legacy acronym slugs (uspto, euipo) and EU are also accepted. Unknown query parameters are rejected with 400. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List trademark assignments

**Slug:** `SIGNA_LIST_TRADEMARK_ASSIGNMENTS`

Recorded assignment chain of title for this mark. Each item includes parties[] and properties[]. Paginated, reverse chronological by recorded_date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Trademark ID (tm_...) |
| `type` | string ("assignment" | "security_interest" | "release" | "merger" | "name_change" | "license" | "partial_assignment" | "correction" | "entity_conversion" | "other") | No | Alias for conveyance_type |
| `limit` | integer | No | Page size (1-100, default 20) |
| `cursor` | string | No | Pagination cursor from previous response |
| `conveyance_type` | string ("assignment" | "security_interest" | "release" | "merger" | "name_change" | "license" | "partial_assignment" | "correction" | "entity_conversion" | "other") | No | Filter by conveyance type (assignment, security_interest, release, merger, name_change, license, partial_assignment, correction, entity_conversion, other) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List trademark citations

**Slug:** `SIGNA_LIST_TRADEMARK_CITATIONS`

Examiner refusal citations issued AGAINST this mark's application — the prior marks an office cited as a bar to registration. Coverage today is USPTO §2(d) refusals; see `capabilities.citations` on `GET /v1/offices`. Paginated, ordered by `action_date` descending (undated actions last) with `id` as the final tiebreaker. Fixed order — no `sort` parameter.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Trademark ID (tm_...) |
| `limit` | integer | No | Page size (1-100, default 20) |
| `cursor` | string | No | Pagination cursor from a previous response |
| `disposition` | array | No | Filter by disposition (citation_issued, maintained, withdrawn, abandoned_after, published). Comma-separated. |
| `action_stage` | array | No | Filter by office-action stage (nonfinal, final). Comma-separated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List trademark cited by

**Slug:** `SIGNA_LIST_TRADEMARK_CITED_BY`

Applications this mark was cited AGAINST — the refusals where this mark is the prior right. Includes citations matched by reference only (application/registration number), which carry `cited_trademark: null`. Paginated, ordered by `action_date` descending (undated actions last) with `id` as the final tiebreaker. Fixed order — no `sort` parameter.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Trademark ID (tm_...) |
| `limit` | integer | No | Page size (1-100, default 20) |
| `cursor` | string | No | Pagination cursor from a previous response |
| `disposition` | array | No | Filter by disposition (citation_issued, maintained, withdrawn, abandoned_after, published). Comma-separated. |
| `action_stage` | array | No | Filter by office-action stage (nonfinal, final). Comma-separated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List trademark documents

**Slug:** `SIGNA_LIST_TRADEMARK_DOCUMENTS`

Office documents for this mark, such as office actions, certificates, filed forms, and correspondence. USPTO marks are lazily metadata-fetched on first request when no document sync state exists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Trademark ID (tm_...) |
| `limit` | integer | No | Page size (1-100, default 20) |
| `cursor` | string | No | Pagination cursor from previous response |
| `document_kind` | array | No | Filter by document kind(s): office_action, certificate, correspondence, filed_form, other |
| `official_date_lt` | string | No | Official document date < (YYYY-MM-DD) |
| `official_date_gte` | string | No | Official document date >= (YYYY-MM-DD) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List trademark events

**Slug:** `SIGNA_LIST_TRADEMARK_EVENTS`

Paginated prosecution event timeline for THIS mark, reverse chronological (maps to the trademark_event table): filings, publications, registrations, status changes. This is the office-reported history of a single trademark — not the org-level `/v1/events` activity feed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Trademark ID (tm_...) |
| `limit` | integer | No | Page size (1-100, default 20) |
| `cursor` | string | No | Pagination cursor from previous response |
| `event_type` | array | No | Filter by event type (comma-separated, case-insensitive): filing, examination_start, office_action, response_filed, approval, publication, opposition_filed, opposition_decided, registration, renewal, cancellation_filed, cancellation_decided, assignment, name_change, address_change, licence_recorded, limitation, correction, appeal_filed, appeal_decided, ceasing_of_effect, central_attack_notification, partial_transfer, partial_cancellation, suspension, extension_requested, extension_granted, payment_received, representative_changed, recordal_received, recordal_registered, amendment_received, revoked, litigation, other. Any other value returns 400. |
| `event_scope` | string ("right" | "class" | "designation" | "proceeding" | "other") | No | Filter by event scope (right, class, designation, proceeding, other) |
| `event_date_lt` | string | No | Event date < (YYYY-MM-DD) |
| `event_date_gte` | string | No | Event date >= (YYYY-MM-DD) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List trademark proceedings

**Slug:** `SIGNA_LIST_TRADEMARK_PROCEEDINGS`

Proceedings involving this mark, on either side: `trademark_role` is `contested` when the proceeding targets this mark and `asserted` when this mark was pleaded by the opposer or petitioner. Each item includes a parties[] array. Paginated, reverse chronological by filed_date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Trademark ID (tm_...) |
| `limit` | integer | No | Page size (1-100, default 20) |
| `cursor` | string | No | Pagination cursor from previous response |
| `status` | string ("pending" | "decided_granted" | "decided_rejected" | "withdrawn" | "settled" | "suspended" | "partial" | "other") | No | Filter by status (pending, decided_granted, decided_rejected, withdrawn, settled, suspended, partial, other) |
| `trademark_role` | string ("contested" | "asserted") | No | Only proceedings where this mark is the `contested` (filed against it) or `asserted` (pleaded by the opposer / petitioner). |
| `proceeding_type` | string ("opposition" | "cancellation" | "revocation" | "invalidity" | "appeal" | "non_use_removal" | "court_action" | "other") | No | Filter by type (opposition, cancellation, revocation, invalidity, appeal, non_use_removal, court_action, other) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List trademarks

**Slug:** `SIGNA_LIST_TRADEMARKS`

GET variant of trademark search/list. Same search as POST, with flat query params.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Search text, ranked through the similarity channels: 1-500 characters, at least 2 after case and accent folding (one CJK character is enough). Always literal; filter on the mark text with the mark_text operators. A trademark number in q (1939139, US 5123456, tm_...) is also looked up and its records lead the page. Optional for a filtered listing. A list of 1-100 terms (each up to 200 characters, e.g. spelling variants) runs every term through the same similarity channels in one search: a hit ranks by its best term and match.terms names the terms that reached it. A list over 10 terms needs similarity limited to identical and lookalike; with fuzzy, embedded or phonetic a list takes 10 terms and 30 words in total. A list is never read as a trademark number. On GET send a list as a JSON array (q=["limber","bimber"]). The whole query string must stay under 2 KB (longer ones are rejected with 403 before reaching the API); send long lists with POST. |
| `sort` | string | No | Sort field(s), comma-separated, - prefix for desc. Default: relevance with q, mark text order with a mark_text filter and no q, otherwise -filing_date. relevance_score stays on every hit under any sort when q is present. sort=office_code orders by the ST.3 code shown in office_code. |
| `limit` | integer | No | Page size (1-100, default 20) |
| `cursor` | string | No | Documented cursor parameter. |
| `fields` | array | No | Sparse top-level field projection. Comma-separated field names; id and object are always retained. Fields you do not request are omitted, although the response schema lists every field. |
| `office` | string | No | Documented office parameter. |
| `firm_id` | string | No | Documented firm_id parameter. |
| `include` | array | No | Comma-separated optional row projections. `full_goods_services` returns full classifications[].goods_services_text; default rows truncate long G&S text to about 280 characters. `match_details` adds match.details (the matched lanes and the ranking factors applied) to each hit. |
| `offices` | array | No | Filter by office code(s). |
| `owner_id` | array | No | Filter by owner (own_...). Takes one ID or a comma-separated list of up to 100; a mark matches when any listed owner holds it. Unlike owner_name this is an exact match on the owner record. A GET URL is limited to 2 KB, which holds about 45 IDs; send a longer list with POST /v1/trademarks. |
| `entity_id` | array | No | Filter by resolved entity (ent_...): marks whose owners are linked to the entity, the global cross-office portfolio. An owner id written with the entity prefix (ent_<owner-uuid>) is not an entity and matches nothing; use owner_id. Mutually exclusive with entity_group. Takes one ID or a comma-separated list of up to 100; a mark matches when it is linked to any listed entity. An ID that names no entity matches nothing. A GET URL is limited to 2 KB, which holds about 45 IDs; send a longer list with POST /v1/trademarks. |
| `has_media` | boolean | No | Filter by media presence. |
| `ir_number` | string | No | Documented ir_number parameter. |
| `is_madrid` | boolean | No | Filter Madrid marks. |
| `owner_lei` | string | No | Filter by exact LEI (uppercased server-side). |
| `highlights` | boolean | No | If true, includes highlight snippets for a ranked q. |
| `owner_name` | string | No | Filter by owner name. Case and accents are ignored. By default every word must match, in any order, with other words allowed between them, so `KG Mobility` also matches `e-mobility ... Co. KG`. Set owner_name_match=phrase to require the words next to each other and in order. For one exact owner use owner_id. |
| `right_kind` | string ("trademark" | "trade_name" | "commercial_notice" | "geographical_indication" | "other") | No | Documented right_kind parameter. |
| `scope_kind` | array | No | Filter by scope kind(s). |
| `similarity` | array | No | Similarity channels for q, comma-separated: identical, fuzzy, embedded, phonetic, lookalike. Default identical,fuzzy,embedded,lookalike; identical is always on. Requires q. |
| `attorney_id` | string | No | Documented attorney_id parameter. |
| `aggregations` | array | No | Faceted bucket counts (TMview "Statistics view"). Comma-separated field names. Buckets respect every filter by default; see `aggregation_mode`. Values: status_stage, office_code, jurisdiction_code, nice_classes, filing_year, mark_feature_type, mark_legal_category, filing_route, right_kind, scope_kind, firm_id, attorney_id, owner_country, owner_id, entity_id, owner_count, entity_count. Bucket lists are top-N (owner_id, attorney_id, firm_id, entity_id: top 50). owner_count and entity_count return { value }: distinct owner records (per office) and distinct linked companies across offices (owners not yet linked to an entity are not counted) in the result set, close to exact up to 40,000. |
| `entity_group` | string | No | Filter by an entity's whole GLEIF corporate family (ent_...): marks linked to any entity in the family (group-level, never identity). Mutually exclusive with entity_id. |
| `filing_basis` | array | No | Filter by namespaced filing basis code(s), e.g. US:1A,US:44E. |
| `filing_route` | array | No | Filter by filing route(s). |
| `is_retracted` | boolean | No | Filter retracted marks. |
| `mark_text_is` | array | No | Marks where the whole mark equals the value (case, accents, punctuation, spacing and trademark notices ignored). Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `nice_classes` | array | No | Filter by Nice class number(s) (1-45). |
| `owner_id_not` | array | No | Exclude marks held by these owners (own_...). Repeat the key for several ids. |
| `owner_ticker` | string | No | Filter by exact ticker symbol (uppercased server-side, e.g. AAPL). |
| `status_stage` | array | No | Filter by status stage(s). "mixed" matches grouped IR rows whose designations disagree; it applies to the grouped view only, and a request served one row per record (international_registrations=expanded, or a grouped fallback) that filters on it is a 400. |
| `vienna_codes` | array | No | Filter by Vienna code(s). |
| `allow_partial` | boolean | No | Return 200 with search_meta.complete=false when the engine times out or a shard fails, instead of 503. Default false. |
| `entity_id_not` | array | No | Exclude marks whose owners are linked to these entities (ent_...). Repeat the key for several ids. |
| `include_total` | boolean | No | If true, returns total_count in the pagination object (exact up to 10,000, then total_count_approximate=true). |
| `jurisdictions` | array | No | Filter by jurisdiction code(s) (UK is read as GB, WIPO as WO). Protection-scope by default: rights that protect, or seek protection, in these territories (a EUTM matches a jurisdictions=FR request). Use territory_match=direct for literal-leg matching. |
| `owner_country` | string | No | Filter by owner country code. Two-letter country code, case-insensitive. Office spellings match too: `EU` and `EM` both match records stored under either, as do `GB` and `UK` (`WIPO` is read as `WO`). Historical codes such as `DD` or `SU` are accepted; an empty value is no filter; a value that is not a two-letter code returns 400 `unknown_country_code`. |
| `owner_has_lei` | boolean | No | Filter by LEI presence. A false/absent value means no confirmed match — owner→company matching covers ~6% of marks. |
| `register_type` | string | No | Filter by the office register (`register.type`), e.g. principal or supplemental (US) or the CIPO register category (CA). Case-insensitive. |
| `status_reason` | array | No | Filter by status reason(s). |
| `updated_at_gt` | string | No | Documented updated_at_gt parameter. |
| `updated_at_lt` | string | No | Documented updated_at_lt parameter. |
| `expiry_date_gt` | string | No | Documented expiry_date_gt parameter. |
| `expiry_date_lt` | string | No | Documented expiry_date_lt parameter. |
| `filing_date_gt` | string | No | Documented filing_date_gt parameter. |
| `filing_date_lt` | string | No | Documented filing_date_lt parameter. |
| `include_timing` | boolean | No | If true, includes timing breakdown. |
| `is_series_mark` | boolean | No | Filter series marks. |
| `mark_text_word` | array | No | Marks where the value appears as a whole word (or consecutive words) of the mark. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `status_primary` | array | No | Filter by primary status. "mixed" matches grouped IR rows whose designations disagree; it applies to the grouped view only, and a request served one row per record (international_registrations=expanded, or a grouped fallback) that filters on it is a 400. |
| `updated_at_gte` | string | No | Documented updated_at_gte parameter. |
| `updated_at_lte` | string | No | Documented updated_at_lte parameter. |
| `expiry_date_gte` | string | No | Documented expiry_date_gte parameter. |
| `expiry_date_lte` | string | No | Documented expiry_date_lte parameter. |
| `filing_date_gte` | string | No | Documented filing_date_gte parameter. |
| `filing_date_lte` | string | No | Documented filing_date_lte parameter. |
| `has_proceedings` | boolean | No | Filter by proceedings presence. |
| `territory_match` | string ("protection" | "direct") | No | How jurisdictions filters match: protection (default — includes regional rights whose membership covers the requested territory, e.g. a EUTM for jurisdictions=FR) or direct (literal territory legs only). |
| `us_design_codes` | array | No | Filter by U.S. design search code(s). |
| `aggregation_mode` | string ("filtered" | "exclude_own_filter") | No | How aggregation counts relate to filters. `filtered` (default): every bucket counts the same filtered set as the results, so buckets add up to `total_count` for single-valued fields. `exclude_own_filter`: each aggregation applies every filter except its own (the `office_code` buckets ignore `offices`, the `nice_classes` buckets ignore `nice_classes`, …), for drill-down sidebars that show the alternatives. |
| `challenge_states` | array | No | Filter by challenge state(s). |
| `entity_group_not` | array | No | Exclude marks linked to any entity in these entities' corporate families (ent_...). Repeat the key for several ids. |
| `mark_text_not_is` | array | No | Exclude marks where the whole mark equals the value (case, accents, punctuation, spacing and trademark notices ignored). Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `owner_name_match` | string ("all_words" | "phrase") | No | How owner_name matches. all_words (default): every word, in any order. phrase: the words next to each other and in order within one owner name, so `KG Mobility` matches `KG Mobility Corp.` but not `e-mobility ... Co. KG`. Punctuation, case and accents are ignored. Requires owner_name. |
| `priority_date_gt` | string | No | Documented priority_date_gt parameter. |
| `priority_date_lt` | string | No | Documented priority_date_lt parameter. |
| `seniority_claims` | string | No | Filter by seniority claim state: claimed, none, or unknown. |
| `aggregations_only` | boolean | No | When true, return only aggregation counts (size:0) — no result documents. |
| `mark_feature_type` | array | No | Filter by mark feature type(s). |
| `mark_text_pattern` | array | No | Marks where `*` matches any run, `?` one character, `\` escapes the next character; everything else is literal. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `opposition_status` | string | No | Filter by derived opposition window status: open, not_started, closed, or unknown. |
| `priority_date_gte` | string | No | Documented priority_date_gte parameter. |
| `priority_date_lte` | string | No | Documented priority_date_lte parameter. |
| `trademark_ids_not` | array | No | Exclude these trademarks (tm_...); on the grouped view, the family row containing them. Up to 1000. Repeat the key for several ids. |
| `application_number` | string | No | Documented application_number parameter. |
| `attorney_firm_name` | string | No | Documented attorney_firm_name parameter. |
| `mark_text_contains` | array | No | Marks where the value appears anywhere in the mark (folded like starts_with); at least 3 characters. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `mark_text_not_word` | array | No | Exclude marks where the value appears as a whole word (or consecutive words) of the mark. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `origin_office_code` | string | No | Documented origin_office_code parameter. |
| `designation_date_gt` | string | No | Designation date after (YYYY-MM-DD). Date the designation was made under the Madrid Protocol (international registration date, or the subsequent-designation date). Set on Madrid designation records. Record grain only: the default grouped view falls back to one row per record with an `expanded_fallback` warning, and international_registrations=grouped returns 400. |
| `designation_date_lt` | string | No | Designation date before (YYYY-MM-DD). Date the designation was made under the Madrid Protocol (international registration date, or the subsequent-designation date). Set on Madrid designation records. Record grain only: the default grouped view falls back to one row per record with an `expanded_fallback` warning, and international_registrations=grouped returns 400. |
| `goods_services_text` | string | No | Documented goods_services_text parameter. |
| `mark_legal_category` | array | No | Filter by mark legal category(s). |
| `mark_text_ends_with` | array | No | Marks where the mark ends with the value (folded like starts_with); at least 3 characters. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `publication_date_gt` | string | No | Documented publication_date_gt parameter. |
| `publication_date_lt` | string | No | Documented publication_date_lt parameter. |
| `registration_number` | string | No | Documented registration_number parameter. |
| `renewal_due_date_gt` | string | No | Documented renewal_due_date_gt parameter. |
| `renewal_due_date_lt` | string | No | Documented renewal_due_date_lt parameter. |
| `termination_date_gt` | string | No | Documented termination_date_gt parameter. |
| `termination_date_lt` | string | No | Documented termination_date_lt parameter. |
| `designation_date_gte` | string | No | Designation date on or after (YYYY-MM-DD). Date the designation was made under the Madrid Protocol (international registration date, or the subsequent-designation date). Set on Madrid designation records. Record grain only: the default grouped view falls back to one row per record with an `expanded_fallback` warning, and international_registrations=grouped returns 400. |
| `designation_date_lte` | string | No | Designation date on or before (YYYY-MM-DD). Date the designation was made under the Madrid Protocol (international registration date, or the subsequent-designation date). Set on Madrid designation records. Record grain only: the default grouped view falls back to one row per record with an `expanded_fallback` warning, and international_registrations=grouped returns 400. |
| `publication_date_gte` | string | No | Documented publication_date_gte parameter. |
| `publication_date_lte` | string | No | Documented publication_date_lte parameter. |
| `registration_date_gt` | string | No | Documented registration_date_gt parameter. |
| `registration_date_lt` | string | No | Documented registration_date_lt parameter. |
| `renewal_due_date_gte` | string | No | Documented renewal_due_date_gte parameter. |
| `renewal_due_date_lte` | string | No | Documented renewal_due_date_lte parameter. |
| `termination_date_gte` | string | No | Documented termination_date_gte parameter. |
| `termination_date_lte` | string | No | Documented termination_date_lte parameter. |
| `mark_text_not_pattern` | array | No | Exclude marks where `*` matches any run, `?` one character, `\` escapes the next character; everything else is literal. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `mark_text_starts_with` | array | No | Marks where the mark begins with the value (case, accents, punctuation and spacing folded). Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `opposition_closes_gte` | string | No | Opposition window closes on or after this date (YYYY-MM-DD). |
| `opposition_closes_lte` | string | No | Opposition window closes on or before this date (YYYY-MM-DD). |
| `owner_publicly_traded` | boolean | No | Filter by public trading status. A false/absent value means no confirmed match, NOT confirmed private — owner→company matching covers ~6% of marks. |
| `registration_date_gte` | string | No | Documented registration_date_gte parameter. |
| `registration_date_lte` | string | No | Documented registration_date_lte parameter. |
| `mark_text_not_contains` | array | No | Exclude marks where the value appears anywhere in the mark (folded like starts_with); at least 3 characters. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `mark_text_not_ends_with` | array | No | Exclude marks where the mark ends with the value (folded like starts_with); at least 3 characters. Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `status_effective_date_gt` | string | No | Documented status_effective_date_gt parameter. |
| `status_effective_date_lt` | string | No | Documented status_effective_date_lt parameter. |
| `mark_text_not_starts_with` | array | No | Exclude marks where the mark begins with the value (case, accents, punctuation and spacing folded). Repeat the key for several values (any one matches). Up to 100 values of 200 characters. |
| `status_effective_date_gte` | string | No | Documented status_effective_date_gte parameter. |
| `status_effective_date_lte` | string | No | Documented status_effective_date_lte parameter. |
| `first_use_anywhere_date_gt` | string | No | Documented first_use_anywhere_date_gt parameter. |
| `first_use_anywhere_date_lt` | string | No | Documented first_use_anywhere_date_lt parameter. |
| `first_use_anywhere_date_gte` | string | No | Documented first_use_anywhere_date_gte parameter. |
| `first_use_anywhere_date_lte` | string | No | Documented first_use_anywhere_date_lte parameter. |
| `international_registrations` | string ("grouped" | "expanded") | No | International registration presentation. Default grouped → one row per mark/IR, with coverage on IR rows; a trademark number in q returns one row per record it names. Use expanded for one row per Madrid designation. |
| `first_use_in_commerce_date_gt` | string | No | Documented first_use_in_commerce_date_gt parameter. |
| `first_use_in_commerce_date_lt` | string | No | Documented first_use_in_commerce_date_lt parameter. |
| `first_use_in_commerce_date_gte` | string | No | Documented first_use_in_commerce_date_gte parameter. |
| `first_use_in_commerce_date_lte` | string | No | Documented first_use_in_commerce_date_lte parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Watch Alerts

**Slug:** `SIGNA_LIST_WATCH_ALERTS`

List alerts emitted by one watch, optionally restricted to its current query revision.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `epoch` | string ("all" | "current") | No | Evaluation epoch filter; all is the provider default. |
| `limit` | integer | No | Page size. |
| `cursor` | string | No | Opaque pagination cursor. |
| `watch_id` | string | Yes | Watch ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Watches

**Slug:** `SIGNA_LIST_WATCHES`

List organization monitoring watches and their honest health state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Page size. |
| `cursor` | string | No | Opaque pagination cursor. |
| `status` | string ("active" | "paused") | No | Watch status filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Webhook Deliveries

**Slug:** `SIGNA_LIST_WEBHOOK_DELIVERIES`

List retained delivery audit rows for one endpoint, optionally from an ISO 8601 timestamp.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Page size. |
| `since` | string | No | ISO 8601 lower bound on delivery creation time. |
| `cursor` | string | No | Opaque pagination cursor. |
| `webhook_id` | string | Yes | Webhook endpoint ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Webhooks

**Slug:** `SIGNA_LIST_WEBHOOKS`

List organization webhook endpoints. Signing secrets are always redacted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Page size. |
| `cursor` | string | No | Opaque pagination cursor. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Lookup Alerts

**Slug:** `SIGNA_LOOKUP_ALERTS`

Bulk-fetch up to 100 organization alerts by ID for polling workflows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | Yes | One to 100 alert IDs. Alerts outside the organization are silently omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Pause Watch

**Slug:** `SIGNA_PAUSE_WATCH`

Pause future evaluations for a monitoring watch.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `watch_id` | string | Yes | Watch ID. |
| `idempotency_key` | string | No | Stable retry key for this pause operation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Preview Watch

**Slug:** `SIGNA_PREVIEW_WATCH`

Dry-run a watch query over a trial window without creating or changing a watch.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | object | Yes | Watch query to evaluate without writing data. |
| `count_only` | boolean | No | Return only the estimated count when true. |
| `result_limit` | integer | No | Maximum matching marks to return. |
| `trial_window_days` | integer | No | Historical trial window in days. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reconcile Trademark Record

**Slug:** `SIGNA_RECONCILE`

Compare caller-held trademark fields with Signa's normalized register and optional rulebook schedule.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Trademark records and caller-held fields to compare. |
| `verdict_detail` | boolean | No | Include three-source per-field verdict detail; defaults to false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Redeliver Webhook Delivery

**Slug:** `SIGNA_REDELIVER_WEBHOOK_DELIVERY`

Create a new external delivery attempt for a terminal webhook event. This sends the payload to the customer endpoint again.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | string | Yes | Webhook endpoint ID. |
| `delivery_id` | string | Yes | Terminal delivery ID to redeliver. |
| `idempotency_key` | string | No | Stable retry key for this redelivery request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Trademarks from Portfolio

**Slug:** `SIGNA_REMOVE_PORTFOLIO_TRADEMARKS`

Remove up to 100 portfolio memberships by trademark ID or external docket reference without deleting the trademarks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `portfolio_id` | string | Yes | Signa portfolio ID beginning with ptf_. |
| `external_refs` | array | No | Portfolio-scoped external references whose memberships should be removed. Unknown references are no-ops; mutually exclusive with trademark_ids. |
| `trademark_ids` | array | No | Trademark IDs whose memberships should be removed. Unknown IDs are no-ops; mutually exclusive with external_refs. |
| `idempotency_key` | string | No | Stable retry key. Composio generates one when omitted. Reuse a supplied key only with the identical removal request for up to 24 hours. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resume Watch

**Slug:** `SIGNA_RESUME_WATCH`

Resume future evaluations for a paused monitoring watch.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `watch_id` | string | Yes | Watch ID. |
| `idempotency_key` | string | No | Stable retry key for this resume operation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retract office vote

**Slug:** `SIGNA_RETRACT_OFFICE_VOTE`

Retract your organization's vote for an office. Accepts the same code vocabulary as casting; votes for offices that have since gone live can still be retracted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Office code (ST.3 / ISO, any accepted alias). |
| `idempotency_key` | string | Yes | Documented Idempotency-Key parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve assignment

**Slug:** `SIGNA_RETRIEVE_ASSIGNMENT`

Retrieve a single recorded trademark assignment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Assignment ID (asg_...) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve attorney

**Slug:** `SIGNA_RETRIEVE_ATTORNEY`

Retrieve a single attorney by ID with full detail.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Attorney ID (att_...) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve classification

**Slug:** `SIGNA_RETRIEVE_CLASSIFICATION`

Retrieve a single Nice classification with its terms.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `class_number` | integer | Yes | Nice class number (1-45) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve design code

**Slug:** `SIGNA_RETRIEVE_DESIGN_CODE`

Retrieve a single Vienna classification code with notes and children at the next depth level.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Vienna classification code, zero-padded. Accepts any depth: `01` (category), `01.01` (division), `01.01.01` (section). Also accepts the undotted form `010101`. Call `GET /v1/design-codes` for the full tree. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve entity

**Slug:** `SIGNA_RETRIEVE_ENTITY`

Retrieve a single resolved entity by ID, with member owners + per-link evidence embedded. A retired entity (merged into another) returns 410 with the successor's id. An owner's id with the entity prefix (`ent_<owner id>`, the derived singleton ids earlier releases served) is not an entity and returns 404.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Entity ID (ent_...) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve entity family

**Slug:** `SIGNA_RETRIEVE_ENTITY_FAMILY`

Retrieve an entity's direct GLEIF corporate family (1 level): parent + direct subsidiaries, sourced from GLEIF Level 2 (IS_DIRECTLY_CONSOLIDATED_BY). Covers LEI-reporting companies only — an absent edge does not imply the absence of a corporate relationship (see coverage_caveat). An entity with no edges returns parent: null, children: [].

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Entity ID (ent_...) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve firm

**Slug:** `SIGNA_RETRIEVE_FIRM`

Retrieve a single firm by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Firm ID (firm_...) |
| `include` | array | No | Comma-separated relations: attorneys |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve jurisdiction

**Slug:** `SIGNA_RETRIEVE_JURISDICTION`

Retrieve a single jurisdiction with Madrid membership details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Jurisdiction code (e.g. US, EU, GB) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve office

**Slug:** `SIGNA_RETRIEVE_OFFICE`

Retrieve a single trademark office with sync metadata and connector details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Office code as returned by `GET /v1/offices` — the WIPO ST.3 code, any case (e.g. `US`, `EM`, `WO`, `se`). Legacy internal codes (`uspto`, `euipo`, `prv`, ...) and the `EU` alias for EUIPO are accepted permanently. This is **not** the jurisdiction code — use `/v1/jurisdictions/{code}` for ISO country codes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve owner

**Slug:** `SIGNA_RETRIEVE_OWNER`

Retrieve a single owner by ID with full detail.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Owner ID (own_...) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve proceeding

**Slug:** `SIGNA_RETRIEVE_PROCEEDING`

Retrieve a single proceeding by ID, including parent trademark summary. A proceeding on a mark of an office whose `capabilities.proceedings` is not `available` is not served (404).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Proceeding ID (prc_...) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Revoke API Key

**Slug:** `SIGNA_REVOKE_API_KEY`

Soft-revoke an organization API key while preserving its audit record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider resource ID. |
| `idempotency_key` | string | No | Stable retry key for this API-key mutation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rotate API Key

**Slug:** `SIGNA_ROTATE_API_KEY`

Rotate an API key and return the replacement raw key once; the old key expires after 24 hours.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider resource ID. |
| `idempotency_key` | string | No | Stable retry key for this API-key mutation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rotate Webhook Secret

**Slug:** `SIGNA_ROTATE_WEBHOOK_SECRET`

Rotate a webhook signing secret. The new secret is shown once. force=true immediately invalidates the old secret and can break in-flight verification; without force, the old secret overlaps for 24 hours.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `force` | string ("true" | "false") | No | Set true to immediately invalidate the previous secret instead of retaining its 24-hour overlap. |
| `webhook_id` | string | Yes | Webhook endpoint ID. |
| `idempotency_key` | string | No | Stable retry key for this secret rotation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Screen Trademark Name

**Slug:** `SIGNA_SCREEN_NAME`

Run Signa's alpha knockout screen for a candidate name or existing trademark. This is not legal advice.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Candidate mark text, at least two non-space characters. |
| `limit` | integer | No | Page size. |
| `include` | string ("live" | "all") | No | Status population. |
| `offices` | array | No | Office codes. |
| `sensitivity` | string ("strict" | "standard" | "broad") | No | Screening sensitivity. |
| `nice_classes` | array | No | Nice classes 1-45. |
| `trademark_id` | string | No | Existing candidate trademark ID. |
| `jurisdictions` | array | No | Jurisdictions. |
| `goods_services` | string | No | Goods/services text. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Trademarks

**Slug:** `SIGNA_SEARCH_TRADEMARKS`

Search and filter trademarks by text, status, territory, office, Nice class, owner, identifiers, and dates. Returns one page plus a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Up to three comma-separated sort fields; prefix a field with - for descending order. |
| `limit` | integer | No | Maximum trademarks to return in this page (1-100). |
| `query` | string | No | Literal search text or 1-100 spelling variants. Omit only when filters are supplied. |
| `cursor` | string | No | Opaque cursor returned by the previous page; keep all other search inputs unchanged. |
| `fields` | array | No | Sparse top-level response fields; id and object are always retained. |
| `exclude` | object | No | Structured exclusions; matching rows are removed without affecting ranking. |
| `filters` | object | No | Structured trademark filters; unknown keys are rejected. |
| `include` | array | No | Optional row expansions for full goods/services text or ranking details. |
| `highlights` | boolean | No | Include matching text snippets for ranked text searches. |
| `similarity` | array | No | Similarity channels for query ranking; identical is always enabled and this field requires query. |
| `aggregations` | array | No | Facet fields whose bucket counts should be returned. |
| `allow_partial` | boolean | No | Return an incomplete 200 response when search times out or a shard fails, instead of a 503 error. |
| `include_total` | boolean | No | Include a total count, exact up to the provider's 10,000-result threshold. |
| `include_timing` | boolean | No | Include the provider's per-phase timing breakdown in search metadata. |
| `territory_match` | string ("protection" | "direct") | No | Whether jurisdiction filters include regional protection coverage or only direct territory legs. |
| `aggregation_mode` | string ("filtered" | "exclude_own_filter") | No | Count facets against all active filters, or exclude each facet's own filter to show drill-down alternatives. |
| `aggregations_only` | boolean | No | Return requested aggregation counts without trademark result rows. |
| `international_registrations` | string ("grouped" | "expanded") | No | Return one row per international registration or one row per Madrid designation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search trademarks by image

**Slug:** `SIGNA_SEARCH_TRADEMARKS_BY_IMAGE`

INTERNAL/alpha — requires the `image-search:read` scope (internal + design-partner keys only until GA). Search trademarks by logo/image similarity. Accepts a multipart `image` upload, an `{image_url}` (https, SSRF-guarded), or a `{media_id}` (reuse an existing mark logo). Returns mark-level hits with named signal channels + thumbnails. Metered as `image_search`, at the price generated below, which is not charged while the image index is being built. Zero-billed calls report `X-Credits-Charged: 0` and omit the `X-Credits-Limit`, `X-Credits-Remaining` and `X-Credits-Reset` balance headers (nothing is debited); see the credit headers section of the rate limits guide. Bounded top-K (limit ≤ 100). The query image is never stored.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `crop` | object | No | Normalized crop box (fractions of width/height) applied before embedding. |
| `limit` | integer | No | Bounded top-K page size (1-100, default 20). ANN results are not deep-pageable. |
| `filters` | object | No | Efficient-filtered facets applied inside the knn query. |
| `channels` | array | No | Subset of §3.5 signal channels. Default: visual, logo_text, exact_dup. |
| `media_id` | string | No | Existing media id (med_…) — reuse its stored vector. |
| `image_url` | string | No | https URL of the query image (SSRF-guarded). |
| `territory_match` | string ("protection" | "direct") | No | How filters.jurisdictions matches: protection (default) or direct (literal territory legs only). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Submit Listing Screening Batch

**Slug:** `SIGNA_SUBMIT_LISTING_BATCH`

Submit 1-100 listings for asynchronous alpha screening and return a pollable job ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `listings` | array | Yes | Listings. |
| `idempotency_key` | string | No | Stable retry key for batch submission. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Suggest classifications

**Slug:** `SIGNA_SUGGEST_CLASSIFICATIONS`

Suggest Nice classification classes for a natural-language description. Returns ranked classes with confidence and rationale. For filing-ready goods/services wording per class, use POST /v1/goods-services/suggest.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `description` | string | Yes | Natural-language description of goods, services, or business (3-500 chars). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Suggest goods services

**Slug:** `SIGNA_SUGGEST_GOODS_SERVICES`

Draft a goods/services specification for a natural-language description. Returns ranked Nice classes with filing-ready goods/services wording per class, grounded in the pre-approved term catalog (Harmonised Database + USPTO ID Manual). Pass `class_number` to restrict the response to a single, already-chosen class.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `description` | string | Yes | Natural-language description of goods, services, or business (3-500 chars). |
| `class_number` | integer | No | Optional Nice class (1-45). When set, only goods/services wording for this class is returned — useful for refining wording when the class has already been chosen. |
| `jurisdiction_code` | string | No | Optional jurisdiction code (ISO 3166-1 alpha-2, e.g. US, EU, JP). Wording accepted by that office's catalogue (USPTO, EUIPO, JPO, KIPO, CNIPA) is preferred; other codes have no effect. Does not change the classes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Test Webhook

**Slug:** `SIGNA_TEST_WEBHOOK`

Send an externally visible synthetic webhook-event-type:ping request to the endpoint. Failures do not increment the production failure counter.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | string | Yes | Webhook endpoint ID. |
| `idempotency_key` | string | No | Stable retry key for this test delivery. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update API Key

**Slug:** `SIGNA_UPDATE_API_KEY`

Update an API key's name, scopes, expiry, or metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider resource ID. |
| `name` | string | No | New key name. |
| `scopes` | array | No | Replacement scopes. |
| `metadata` | object | No | Metadata merge; null values remove keys. |
| `expires_at` | string | No | Replacement ISO 8601 expiry or null. |
| `idempotency_key` | string | No | Stable retry key for this API-key update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Deadline

**Slug:** `SIGNA_UPDATE_DEADLINE`

Update workflow fields or editable title and date fields on a manual deadline.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note` | string | No | New note, or null to clear. |
| `title` | string | No | New title for a manual deadline. |
| `status` | string ("open" | "done" | "dismissed") | No | New workflow status. |
| `assignee` | string | No | New assignee, or null to clear. |
| `due_date` | string | No | New due date for a manual deadline. |
| `deadline_id` | string | Yes | Signa deadline ID beginning with dl_. |
| `idempotency_key` | string | No | Stable retry key generated when omitted; reuse only with the identical body for 24 hours. |
| `review_required` | boolean | No | Pass false to acknowledge a review flag. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Deadline Reminder

**Slug:** `SIGNA_UPDATE_DEADLINE_REMINDER`

Replace the day offsets on a deadline-reminder subscription.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `offsets` | array | Yes | One to eight reminder offsets in days. |
| `idempotency_key` | string | No | Stable retry key generated when omitted; reuse only with the identical body for 24 hours. |
| `deadline_reminder_id` | string | Yes | Signa reminder ID beginning with drm_. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Notification Preferences

**Slug:** `SIGNA_UPDATE_NOTIFICATION_PREFERENCES`

Merge changes into organization notification preferences.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `marketing` | boolean | No | Marketing email preference. |
| `idempotency_key` | string | No | Stable retry key for this preference update. |
| `changelog_updates` | boolean | No | Changelog email preference. |
| `auto_topup_receipts` | boolean | No | Auto-top-up receipts. |
| `credit_usage_alerts` | boolean | No | Credit threshold alerts. |
| `watch_credit_notifications` | boolean | No | Watch credit notices. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Organization

**Slug:** `SIGNA_UPDATE_ORGANIZATION`

Rename the authenticated Signa organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Organization display name. |
| `idempotency_key` | string | No | Stable retry key for this organization update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Portfolio

**Slug:** `SIGNA_UPDATE_PORTFOLIO`

Update a portfolio's name, description, metadata patch, or deadline-docket setting. Omitted fields remain unchanged; an explicit null description clears it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New portfolio name. |
| `metadata` | object | No | Metadata patch to merge into the existing metadata. Set a value to null to remove that key. |
| `description` | string | No | New description; pass null explicitly to clear it. |
| `portfolio_id` | string | Yes | Signa portfolio ID beginning with ptf_. |
| `docket_enabled` | boolean | No | Whether marks in this portfolio contribute to the deadline docket. |
| `idempotency_key` | string | No | Stable retry key. Composio generates one when omitted. Reuse a supplied key only with the identical update request for up to 24 hours. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Watch

**Slug:** `SIGNA_UPDATE_WATCH`

Update a watch. Replacing its query advances the evaluation epoch for future ingestion.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New watch name. |
| `query` | object | No | Replacement watch query. |
| `status` | string ("active" | "paused") | No | New watch status. |
| `metadata` | object | No | Replacement metadata. |
| `watch_id` | string | Yes | Watch ID. |
| `delivery_mode` | string | No | Delivery mode. |
| `idempotency_key` | string | No | Stable retry key. Reuse only with the identical patch for 24 hours. |
| `customer_reference` | string | No | Customer reference; null clears it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Webhook

**Slug:** `SIGNA_UPDATE_WEBHOOK`

Update a webhook URL, description, subscriptions, portfolio filter, status, or metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | New delivery URL. |
| `status` | string ("active" | "disabled") | No | New endpoint status. |
| `metadata` | object | No | Replacement endpoint metadata. |
| `webhook_id` | string | Yes | Webhook endpoint ID. |
| `description` | string | No | Description; null clears it. |
| `portfolio_id` | string | No | New ptf_* filter; null clears it. |
| `enabled_events` | array | No | Replacement event subscriptions. |
| `idempotency_key` | string | No | Stable retry key. Reuse only with the identical patch for 24 hours. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate goods services

**Slug:** `SIGNA_VALIDATE_GOODS_SERVICES`

Check goods & services wording against the pre-approved catalogs we hold (EUIPO Harmonised Database + USPTO ID Manual), per office and per Nice class. Returns one row per submitted item, in request order, with a per-office verdict and — when the wording is not listed and a class is known — nearby catalogued wording to draft from.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Documented items parameter. |
| `offices` | array | Yes | Offices to report on, as ST.3 codes (legacy internal codes and the `EU` alias also resolve). At most 10 distinct offices are allowed after normalization. Duplicates and aliases of the same office collapse, and every code is echoed back as ST.3. An office we hold no catalog for is answered `unsupported_office` rather than rejected. |
| `language` | string | No | Catalog language. Only `en` is available today; other languages are not yet available. |
| `idempotency_key` | string | No | Documented Idempotency-Key parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
