Skip to main content

Moxie Public API

The Moxie Public API lets you read from and push data into a Moxie workspace — clients, contacts, projects, invoices, payments, time entries, tickets and more. It is the same surface that powers the Moxie Zapier integration.

Every endpoint is exposed under two equivalent path prefixes:

  • /public/action/… — for direct API integrations
  • /zapier/action/… — used by the Zapier connector

This documentation describes the /public/action/* surface. The request and response shapes are identical on both prefixes.

Conventions​

  • Base URL: your Moxie API host (e.g. https://api.withmoxie.com).
  • All requests authenticate with an X-API-KEY header.
  • Request and response bodies are JSON (application/json), except file uploads, which use multipart/form-data.
  • Many create endpoints resolve related records by name (e.g. clientName, projectName) rather than by id, creating them where noted.
  • Dates are ISO-8601 (YYYY-MM-DD for dates, RFC-3339 for timestamps).
  • Missing required headers or query parameters, malformed JSON, and parameter type mismatches return 400 Bad Request. Domain precondition failures use 412 Precondition Failed.

Endpoints by resource​

The reference is organized by the resource each endpoint acts on. Within a resource, list/search endpoints come before the create/action endpoints.

Start with Authentication, then jump into the reference.