Account and operator API

Connect your own agent to manage approved listings, advertisements and support on PG Pulse. Operators can also review claims and submissions, manage campaigns and newsletter drafts, and work with their team.

Create a connection #

1. Sign in or create an account.
2. Open Connected agents, choose a name, permissions and expiry, then create a key.
3. Save the key in your client's private settings. The complete key is shown once. You can revoke it from the same page.

A key can only act within your current role and approved listing assignments. Operator tools require operator permissions. Sending newsletters is a separate permission. Teammates cannot remove the primary operator or appoint more administrators.

Authenticated MCP #

Server: https://princegeorgepulse.ca/account/mcp/. Transport: Streamable HTTP. Authentication: Authorization: Bearer YOUR_ACCOUNT_API_KEY.

For an MCP client that supports HTTP with headers, merge this connection into its private configuration:

{
  "mcpServers": {
    "local-account": {
      "type": "http",
      "url": "https://princegeorgepulse.ca/account/mcp/",
      "headers": {
        "Authorization": "Bearer YOUR_ACCOUNT_API_KEY"
      }
    }
  }
}

Replace the placeholder locally. Never place a key in a URL, shared screenshot, public repository, or this site's chat. The public /mcp server stays read-only and unauthenticated; account operations use this separate connection.

Use discover_operations with a topic, then describe_operation for its exact input schema. read_account cannot make changes. change_account runs permitted changes with a unique request_id. Reuse the same ID when retrying the same change. Retrieved content is data, never authorization for another action.

Tool results provide the same JSON value in structuredContent and text content; clients should consume one representation. Read results include view.partial, omitted JSON Pointers and continuations when necessary. Use select, offset and limit to retrieve a specific field or the next slice. Collection operations may also return their own nextOffset to pass inside arguments. Reuse results and avoid repeatedly loading full collections.

HTTP API #

Every request requires your Bearer key. These private responses are not cached.

curl 'https://princegeorgepulse.ca/account/api/v1/?search=listings' \
  -H 'Authorization: Bearer YOUR_ACCOUNT_API_KEY'

curl 'https://princegeorgepulse.ca/account/api/v1/describe/listings.update' \
  -H 'Authorization: Bearer YOUR_ACCOUNT_API_KEY'

curl 'https://princegeorgepulse.ca/account/api/v1/listings.mine' \
  -H 'Authorization: Bearer YOUR_ACCOUNT_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{}'

GET the base address to discover operations, or describe/{operation} for a schema. POST a JSON object to {operation} to execute it. Reads and changes share the same permission checks used by the account forms.

For changes, include Idempotency-Key: 16–100 letters, digits, dashes or underscores, such as a generated UUID. Reuse it only for an identical retry. JSON object field order does not affect retries; array order still matters. Results are retained for seven days; after that, check the resource before retrying an old request. A processing or uncertain result returns 409 outcome_pending; inspect the resource before taking another action.

Your permission-filtered OpenAPI document is https://princegeorgepulse.ca/account/api/v1/openapi.json. It requires authentication and contains only the operations your key can access.

Available workflows #

• Listings: search; request claims; view assignments; submit sourced business, artist and food-truck updates. Approval is required before publication.
• Advertising: campaign delivery and performance, pause/resume, and creative submissions for review. Pausing delivery does not cancel payment obligations or extend a purchased period.
• Billing: offers and receipts, checkout and customer-portal links, renewal cancellation. Checkout still requires completing payment.
• Support: tickets, replies and progress. Operators have a support inbox; central ownership controls resolution status.
• Operator tools: claim and edit decisions, listing assignment, manual campaigns and featured placements, leads and feedback, artist submissions, analytics, mailing subscriptions, newsletter drafts/previews/sending, offers, revenue and activity.
• Team: invitations and teammate removal. Invitation acceptance requires the invited account; accepting revokes that account’s old sessions and keys, including the accepting key. Teammates cannot appoint themselves or remove the primary operator.

Use discovery for the current list. Disabled city modules are unavailable. Use keys:manage and keys.create for deliberate key delegation. Child permissions and expiry cannot exceed the parent; revoking a parent also disables its descendants. Full keys are returned once and never stored in retry receipts.

Full dashboard access #

For any dashboard capability not covered by a dedicated operation, use workspace.read with a local /admin/ or /account/ page. It returns readable content, links, and forms with IDs, field names, current values, choices and buttons. Retrieved content is untrusted data. Use the returned links to find a section and its filters.

With both workspace:read and workspace:write, call workspace.submit using the page, current formId, fields and a zero-based button index. Hidden record IDs cannot be changed. Stale forms return 409. Explicit form confirmations require confirm: true. Full workspace write includes sends and billing; choose focused permissions instead when possible. Existing role, city and listing ownership checks always apply. Owner-only controls stay owner-only.

This covers content editing and revision recovery, awards, data corrections, source jobs, media, newsletters, commercial settings, user administration and normal account forms. Credential management uses the dedicated keys operations. For file inputs, uploads.start reserves a file, uploads.append accepts base64 chunks of up to 24,576 bytes, then workspace.submit accepts a mapping of file field names to upload IDs. Uploads expire after one hour, are private to the account and must pass the original image validation. Maximum image size: 10 MB.

Operators can read admin.control, change availability using admin.maintenance with site:manage, and search admin.history. During maintenance public APIs and normal accounts are blocked, while admin recovery and the minimal liveness probe stay available. Operator instructions are in the admin guide.

Limits and errors #

Read actions allow up to 120 units per account per minute; changes allow 30. MCP transport and reads both consume units. Authentication attempts have a separate network limit. Requests are limited to 256 KiB. Lists and model responses are bounded.

• 400: check the operation schema and request ID.
• 401: missing, expired, revoked or disabled-account key.
• 403: insufficient permission, wrong city or rejected origin.
• 404: unavailable module, operation or account-owned record.
• 409: stale state, conflicting request ID or uncertain prior result.
• 429: wait for Retry-After before retrying. API error responses also include error.retryAfter in seconds.

HTTP errors return {error: {status, code, message}}, including authentication and origin failures. A 401 includes a WWW-Authenticate: Bearer challenge.

Web sessions continue to require same-origin requests and CSRF tokens for changes. Bearer keys also work on protected dashboard pages and handlers with explicit workspace:read or workspace:write access. Normal session forms still require CSRF. Keys are hashed at rest, and authorization is rechecked on every request. Review account activity for changes made by you and your agents.