API_KEY
postgrid_api_key
Developer setup
No fields declared in this snapshot.
User connection
- PostGrid API Keygeneric_api_key · stringRequired
POSTGRID
PostGrid provides APIs for automating direct mail and address verification services, enabling businesses to send letters, postcards, and checks, as well as verify and standardize addresses in real-time.
Description is untrusted, display-only upstream metadata. It never becomes policy, OAuth scope authority, or an agent instruction.
Pakkawork boundary
Research catalogue metadata only. No Pakkawork OAuth, credential, host, quota, executor, or verifier is enabled.
60
Action summaries
Display-only definitions
0
Trigger types
Not installed instances
1
Auth modes
Field names, never values
No
Execution
No runtime adapter
Authentication map
API_KEY
No fields declared in this snapshot.
Capability index
Showing 31–60 of 60 actions
POSTGRID_GET_POSTCARD
Tool to retrieve a specific postcard by ID. Use when you have a postcard ID and need to fetch its details.
Untrusted display-only summary
POSTGRID_GET_RETURN_ENVELOPE
Tool to retrieve a return envelope. Use after obtaining the return envelope ID to fetch its details.
Untrusted display-only summary
POSTGRID_GET_RETURN_ENVELOPE_ORDER
Tool to retrieve a specific return envelope order. Use when you need to get details about an order by its return envelope ID and order ID.
Untrusted display-only summary
POSTGRID_GET_TEMPLATE
Tool to retrieve a template. Use when you have the template ID and need its details.
Untrusted display-only summary
POSTGRID_GET_TRACKER
Tool to retrieve a tracker. Use when you have the tracker ID and need its details.
Untrusted display-only summary
POSTGRID_GET_WEBHOOK
Tool to retrieve details of a specific webhook by its ID. Use after creating a webhook to fetch its configuration and status.
Untrusted display-only summary
POSTGRID_LIST_BANK_ACCOUNTS
Tool to list bank accounts. Use when retrieving bank accounts with optional status filter and pagination.
Untrusted display-only summary
POSTGRID_LIST_BOXES
Tool to list box orders. Use when you need to retrieve a paginated list of box orders from PostGrid.
Untrusted display-only summary
POSTGRID_LIST_CHEQUES
Tool to list cheques with optional filters and pagination. Use when you need to retrieve batches of cheque records for processing or reporting.
Untrusted display-only summary
POSTGRID_LIST_CONTACTS
Tool to list contacts. Use when you need to retrieve a paginated list of contacts with optional filters like date range, metadata, name, or email.
Untrusted display-only summary
POSTGRID_LIST_EVENTS
Tool to retrieve a list of webhook events with optional pagination. Use when you need to view all webhook events that have occurred.
Untrusted display-only summary
POSTGRID_LIST_LETTERS
Tool to list letters. Use when retrieving letters with optional filters and pagination.
Untrusted display-only summary
POSTGRID_LIST_POSTAL_STATEMENTS
Tool to list all postal statements for billing and tracking purposes. Use when you need to retrieve statements for accounting or audit purposes.
Untrusted display-only summary
POSTGRID_LIST_POSTCARDS
Tool to retrieve a list of postcards with optional filtering and pagination. Use when you need to browse or filter postcards list.
Untrusted display-only summary
POSTGRID_LIST_RETURN_ENVELOPE_ORDERS
Tool to list all return envelope orders for a specific return envelope. Use when retrieving orders associated with a return envelope ID.
Untrusted display-only summary
POSTGRID_LIST_RETURN_ENVELOPES
Tool to list return envelopes. Use when you need to retrieve a paginated list of business reply envelopes (BREs) with optional pagination.
Untrusted display-only summary
POSTGRID_LIST_SELF_MAILERS
Tool to list self-mailers. Use when you need to fetch self-mailers with filters and pagination.
Untrusted display-only summary
POSTGRID_LIST_SUB_ORGANIZATIONS
Tool to list sub-organizations. Use when you need to retrieve a paginated list of sub-organizations with optional search filter.
Untrusted display-only summary
POSTGRID_LIST_TEMPLATE_EDITOR_SESSIONS
Tool to list template editor sessions. Use when you need to retrieve a paginated list of template editor sessions.
Untrusted display-only summary
POSTGRID_LIST_TEMPLATES
Tool to list templates. Use when you need to retrieve a paginated list of templates with optional type filtering.
Untrusted display-only summary
POSTGRID_LIST_TRACKERS
Tool to list all trackers. Use when you need to retrieve a paginated list of trackers for tracking mail interactions.
Untrusted display-only summary
POSTGRID_LIST_TRACKER_VISITS
Tool to list all visits for a tracker. Use when you need to retrieve visit information including device, IP address, and referred tracker/order ID for each visit.
Untrusted display-only summary
POSTGRID_LIST_WEBHOOK_INVOCATIONS
Tool to list previous invocations of a webhook with response status codes. Use when you need to view the history of webhook delivery attempts and their outcomes.
Untrusted display-only summary
POSTGRID_LIST_WEBHOOKS
Tool to retrieve a list of configured webhooks with optional filtering and pagination. Use when you need to view your webhooks.
Untrusted display-only summary
POSTGRID_PROGRESS_TEST_BOX
Tool to progress a test box through processing stages for webhook testing. Use when testing webhook integration by advancing box status.
Untrusted display-only summary
POSTGRID_PROGRESS_TEST_CHEQUE
Tool to progress a test cheque through processing stages for webhook testing. Use when you need to simulate cheque status changes (ready -> printing -> processed_for_delivery -> completed) to test webhook integrations.
Untrusted display-only summary
POSTGRID_PROGRESS_TEST_POSTCARD
Tool to progress a test postcard through processing stages for webhook testing. Use when testing webhook integration by advancing postcard status.
Untrusted display-only summary
POSTGRID_UPDATE_TEMPLATE
Tool to update an existing mail template in PostGrid. Use when you need to modify the HTML content, description, or metadata of a template.
Untrusted display-only summary
POSTGRID_UPDATE_TRACKER
Tool to update an existing tracker's redirect URL template and/or expiration settings. Use when you need to modify tracker configuration after obtaining its identifier.
Untrusted display-only summary
POSTGRID_UPDATE_WEBHOOK
Tool to update an existing webhook configuration. Use when you need to modify webhook URL, events, or other settings.
Untrusted display-only summary
Provenance
The detail snapshot comes from an attributed MIT-licensed repository revision. Safe local icons use exact-match CC0 Simple Icons symbols; unmatched brands use monograms.
Remote text is plain display metadata only. It must never become an agent prompt, execution policy, OAuth grant, or executable instruction.