Moxie

https://help.withmoxie.com/
Admin
Moxie is a comprehensive freelance business management platform that helps freelancers manage...
Tokens:163,904
Snippets:2,811
Trust Score:9.4
Update:1 month ago
Show doc for...
Tokens:
Raw
### timer_start

Source: https://help.withmoxie.com/en/articles/16751074

Starts a new live timer for the user.

```APIDOC
## timer_start

### Description
Start the user's timer (live time tracking/stopwatch) against an optional client, project, task, or ticket. If a timer is already running it is returned unchanged with outcome already_running.
```

--------------------------------

### playbooks_get

Source: https://help.withmoxie.com/en/articles/16751074

Get one workflow guide by ID (from playbooks_list). Returns markdown instructions: required inputs, safe ordering, confirmation rules, and error recovery for that workflow.

```APIDOC
## playbooks_get

### Description
Get one workflow guide by ID (from playbooks_list). Returns markdown instructions: required inputs, safe ordering, confirmation rules, and error recovery for that workflow.
```

--------------------------------

### GET /action/clients/list

Source: https://help.withmoxie.com/en/articles/8163927-list-clients

Retrieves a list of all clients in the Moxie workspace.

```APIDOC
## GET /action/clients/list

### Description
Retrieves a list of all clients in your Moxie workspace.

### Method
GET

### Endpoint
/action/clients/list

### Response
#### Success Response (200)
- **name** (string) - Client name
- **clientType** (string) - Type of client
- **initials** (string) - Client initials
- **address1** (string) - Primary address line
- **address2** (string) - Secondary address line
- **city** (string) - City
- **locality** (string) - Locality
- **postal** (string) - Postal code
- **country** (string) - Country
- **website** (string) - Website URL
- **phone** (string) - Phone number
- **color** (string) - Assigned color
- **taxId** (string) - Tax identification number
- **leadSource** (string) - Lead source
- **archive** (boolean) - Archive status
- **paymentTerms** (object) - Payment terms configuration
- **payInstructions** (string) - Payment instructions
- **hourlyAmount** (number) - Hourly rate
- **roundingIncrement** (number) - Rounding increment
- **currency** (string) - Currency code
- **stripeClientId** (string) - Stripe client ID
- **notes** (string) - Client notes
- **contacts** (array) - List of associated contacts

#### Response Example
[
  {
    "name": "",
    "clientType": "Client",
    "initials": "",
    "address1": "",
    "address2": "",
    "city": "",
    "locality": "",
    "postal": "",
    "country": "",
    "website": "",
    "phone": "",
    "color": "",
    "taxId": "",
    "leadSource": "",
    "archive": false,
    "paymentTerms": {
      "paymentDays": 0,
      "latePaymentFee": 0.0,
      "hourlyAmount": 0.0,
      "whoPaysCardFees": "Client"
    },
    "payInstructions": "",
    "hourlyAmount": 0.0,
    "roundingIncrement": 0,
    "currency": "USD",
    "stripeClientId": "",
    "notes": "",
    "contacts": [
      {
        "firstName": "",
        "lastName": "",
        "role": "",
        "phone": "",
        "email": "",
        "notes": "",
        "defaultContact": false,
        "invoiceContact": false,
        "portalAccess": false
      }
    ]
  }
]
```

--------------------------------

### products_get

Source: https://help.withmoxie.com/en/articles/16751074

Get one product/service: rate, billing type (fixed/hourly/deposit), tax setting, per-currency rates.

```APIDOC
## products_get

### Description
Get one product/service: rate, billing type (fixed/hourly/deposit), tax setting, per-currency rates.
```

--------------------------------

### projects_get

Source: https://help.withmoxie.com/en/articles/16751074

Get one project: description, dates, color, owners, client-portal access level, custom fields.

```APIDOC
## projects_get

### Description
Get one project: description, dates, color, owners, client-portal access level, custom fields.
```

--------------------------------

### GET /action/projects/search

Source: https://help.withmoxie.com/en/articles/8260204-search-projects

Retrieves a list of active projects, with an optional filter for client name.

```APIDOC
## GET /action/projects/search

### Description
Search for active projects. You can optionally filter the results by client name.

### Method
GET

### Endpoint
/action/projects/search

### Parameters
#### Query Parameters
- **query** (string) - Optional - Client name filter if you only want projects for a specific client

### Response
#### Success Response (200)
- **Array of objects** - A list of project objects containing details such as id, accountId, name, description, and associated client information.
```

--------------------------------

### agreements_get

Source: https://help.withmoxie.com/en/articles/16751074

Get one agreement: structure summary, settings, styles, signers with signature state, event history.

```APIDOC
## agreements_get

### Description
Get one agreement: structure summary, settings, styles, signers with signature state, event history.
```

--------------------------------

### meeting_types_get

Source: https://help.withmoxie.com/en/articles/16751074

Get details for a specific meeting type.

```APIDOC
## meeting_types_get

### Description
Get one meeting type: public booking slug, duration, location (Zoom/phone/in-person), owner, portal visibility.
```

--------------------------------

### clients_create

Source: https://help.withmoxie.com/en/articles/16751074

Create a client or prospect (new customer/company) with profile fields and an optional first note.

```APIDOC
## clients_create

### Description
Create a client or prospect (new customer/company) with profile fields and an optional first note. Also the way to record a new lead as a company.
```

--------------------------------

### projects_create

Source: https://help.withmoxie.com/en/articles/16751074

Create a project for a client: name, type, dates, description, color, owners, portal visibility.

```APIDOC
## projects_create

### Description
Create a project for a client: name, type, dates, description, color, owners, portal visibility. Ask for any missing details before you save the change.
```

--------------------------------

### email_lists_get

Source: https://help.withmoxie.com/en/articles/16751074

Get one email audience's details.

```APIDOC
## email_lists_get

### Description
Get one email audience's details and counts.
```

--------------------------------

### products_create

Source: https://help.withmoxie.com/en/articles/16751074

Create a reusable product or service for invoices, agreements, and proposals: name, description, rate, hourly/fixed, taxable.

```APIDOC
## products_create

### Description
Create a reusable product or service for invoices, agreements, and proposals: name, description, rate, hourly/fixed, taxable.
```

--------------------------------

### bulk_email_get

Source: https://help.withmoxie.com/en/articles/16751074

Get one bulk email campaign's status.

```APIDOC
## bulk_email_get

### Description
Get one bulk email campaign's status and delivery summary.
```

--------------------------------

### email_logs_get

Source: https://help.withmoxie.com/en/articles/16751074

Get one sent email's full content.

```APIDOC
## email_logs_get

### Description
Get one sent email's full content: subject, body, recipients, attachments list.
```

--------------------------------

### POST /action/tasks/create

Source: https://help.withmoxie.com/en/articles/8160423-create-task

Creates a new task in the project management board.

```APIDOC
## POST /action/tasks/create

### Description
Create a new task in your project management board which can optionally be associated with a project and a client.

### Method
POST

### Endpoint
/action/tasks/create

### Request Body
- **name** (string) - Required - Task Name
- **clientName** (string) - Required - Exact match of a client record in your CRM
- **projectName** (string) - Required - Exact match of a project that is owned by the client referenced
- **status** (string) - Optional - Must match exactly a status in your kanban if provided
- **description** (string) - Optional - Task description
- **dueDate** (string) - Optional - Due date in YYYY-MM-DD format
- **startDate** (string) - Optional - Start date in YYYY-MM-DD format
- **priority** (number) - Optional - Numeric priority for sorting in kanban
- **tasks** (array) - Optional - List of sub-tasks
- **assignedTo** (array) - Optional - Email addresses of users in the workspace
- **customValues** (object) - Optional - Map of custom fields where keys must match project settings

### Request Example
{
  "name": "",
  "clientName": "",
  "projectName": "",
  "status": "",
  "description": "",
  "dueDate": "2023-07-20",
  "startDate": "2023-07-20",
  "priority": 1,
  "tasks": [
    "One",
    "Two",
    "Three"
  ],
  "assignedTo": [
    "user1@withmoxie.com",
    "user2@withmoxie.com"
  ],
  "customValues": {
    "Field1 name": "Field value",
    "Field2 name": "Field value"
  }
}
```

--------------------------------

### GET /action/vendors/list

Source: https://help.withmoxie.com/en/articles/8260220-list-vendor-names

Retrieves a list of all vendor names available in the system.

```APIDOC
## GET /action/vendors/list

### Description
Returns a list of all vendor names.

### Method
GET

### Endpoint
/action/vendors/list

### Response
#### Success Response (200)
- **body** (array) - A list of strings representing vendor names.

#### Response Example
[
  "Vendor 1",
  "Vendor 2"
]
```

--------------------------------

### Custom Redirect URL with Parameters

Source: https://help.withmoxie.com/en/articles/5886666-how-to-use-the-moxie-meeting-scheduler

Example of a custom confirmation URL with appended meeting details as query parameters.

```text
https://www.mysite.com/confirm?id=123&start=2022-01-01T13:00:00Z&duration=30&location=Zoom&email=invitee@email.com&name=John+Doe
```

--------------------------------

### GET /action/formNames/list

Source: https://help.withmoxie.com/en/articles/8260225-list-form-names

Retrieves a list of all available form template names.

```APIDOC
## GET /action/formNames/list

### Description
Retrieves a list of all form template names available in the system.

### Method
GET

### Endpoint
/action/formNames/list

### Response
#### Success Response (200)
- **body** (array) - A list of strings representing the names of the form templates.

#### Response Example
[
  "Form Name 1",
  "Form Name 2"
]
```

--------------------------------

### POST /action/projects/create

Source: https://help.withmoxie.com/en/articles/8160400-create-project

Creates a new project record in the Moxie CRM.

```APIDOC
## POST /action/projects/create

### Description
Creates a new project record in your Moxie CRM associated with a specific client.

### Method
POST

### Endpoint
/action/projects/create

### Parameters
#### Request Body
- **name** (string) - Required - Project Name
- **clientName** (string) - Required - Exact match of a client record that exists in the CRM
- **templateName** (string) - Optional - The name of a template that should be used to create the project.
- **startDate** (string) - Optional - Start date of the project (YYYY-MM-DD)
- **dueDate** (string) - Optional - Due date of the project (YYYY-MM-DD)
- **portalAccess** (string) - Optional - One of: None, Overview, Full access, or Read only (default Read Only)
- **showTimeWorkedInPortal** (boolean) - Optional - Is time worked on this project visible in client portal
- **feeSchedule** (object) - Required when not using Template - Monetization settings for the project

### Request Example
{
  "name": "",
  "clientName": "",
  "templateName": "",
  "startDate": "2023-07-20",
  "dueDate": "2023-07-20",
  "portalAccess": "Full access",
  "showTimeWorkedInPortal": true,
  "feeSchedule": {
    "feeType": "Hourly",
    "amount": 0.00,
    "retainerSchedule": "WEEKLY",
    "estimateMax": 0,
    "estimateMin": 0,
    "retainerStart": "2023-07-20",
    "retainerTiming": "ADVANCED",
    "retainerOverageRate": 0.00,
    "taxable": false
  }
}
```

--------------------------------

### GET /action/invoiceTemplates/list

Source: https://help.withmoxie.com/en/articles/8260216-list-invoice-templates

Retrieves a list of all invoice template names in the workspace.

```APIDOC
## GET /action/invoiceTemplates/list

### Description
Returns a list of all invoice template names in the workspace.

### Method
GET

### Endpoint
/action/invoiceTemplates/list

### Response
#### Success Response (200)
- **Response Body** (array) - A list of strings representing the invoice template names.

#### Response Example
[
  "Invoice Template Name 1",
  "Invoice Template Name 2"
]
```

--------------------------------

### files_initialize_domain_root

Source: https://help.withmoxie.com/en/articles/16751074

Creates a record's file root folder if it does not exist.

```APIDOC
## files_initialize_domain_root

### Description
Create a record's file root folder if it doesn't exist yet. Use only after files_domain_root reports none.
```

--------------------------------

### GET /action/emailTemplates/list

Source: https://help.withmoxie.com/en/articles/8260211-list-email-templates

Retrieves a list of all email template names in a workspace.

```APIDOC
## GET /action/emailTemplates/list

### Description
Retrieve a list of all email template names in a workspace.

### Method
GET

### Endpoint
/action/emailTemplates/list

### Response
#### Success Response (200)
- **Response Body** (array) - A list of strings representing the names of the email templates.

#### Response Example
[
  "Email Template Name 1",
  "Email Template Name 2"
]
```

--------------------------------

### POST /action/opportunities/create

Source: https://help.withmoxie.com/en/articles/8160471-create-opportunity

Creates a new opportunity in the sales pipeline with provided details.

```APIDOC
## POST /action/opportunities/create

### Description
Create a new opportunity in your sales pipeline with basic opportunity information and custom values.

### Method
POST

### Endpoint
/action/opportunities/create

### Parameters
#### Request Body
- **name** (string) - Required - Opportunity Name
- **description** (string) - Optional - Description of the opportunity
- **clientName** (string) - Optional - Exact match of a client name in the CRM
- **stageName** (string) - Optional - If provided, must match an exact stage name in your pipeline
- **value** (number) - Optional - Monetary value of the opportunity
- **estCloseDate** (string) - Optional - Estimated close date (YYYY-MM-DD)
- **leadInfo** (object) - Optional - Information about the lead
- **toDos** (array) - Optional - List of to-do items
- **customValues** (object) - Optional - Map of custom fields matching pipeline settings

### Request Example
{
  "name": "",
  "description": "",
  "clientName": "",
  "stageName": "",
  "value": 0.00,
  "estCloseDate": "2023-07-20",
  "leadInfo": {
    "firstName": "",
    "lastName": "",
    "email": "",
    "phone": "",
    "role": "",
    "businessName": "",
    "website": "",
    "address1": "",
    "address2": "",
    "city": "",
    "locality": "",
    "postal": "",
    "country": "",
    "sourceUrl": "",
    "leadSource": "",
    "answers": [
      {
        "fieldKey": "",
        "question": "",
        "answer": ""
      }
    ]
  },
  "toDos": [
    {
      "item": "Do something",
      "complete": false,
      "dueDate": "2023-07-20"
    }
  ],
  "customValues": {
    "Field1 Name": "Value",
    "Field2 name": "Value"
  }
}
```

--------------------------------

### GET /action/pipelineStages/list

Source: https://help.withmoxie.com/en/articles/8260232-list-pipeline-stages

Retrieves a list of all stages and their associated types in the Sales Pipeline.

```APIDOC
## GET /action/pipelineStages/list

### Description
List all stages and types in the Sales Pipeline.

### Method
GET

### Endpoint
/action/pipelineStages/list

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the stage.
- **label** (string) - The display label for the stage.
- **hexColor** (string) - The color code associated with the stage.
- **stageType** (string) - The type of the stage. Must be one of: New, InProgress, OnHold, ClosedWon, ClosedLost, Complete.

#### Response Example
[
  {
    "id": "",
    "label": "",
    "hexColor": "",
    "stageType": "New"
  }
]
```

--------------------------------

### Implement deferred iframe loading with a placeholder

Source: https://help.withmoxie.com/en/articles/9167656-defer-loading-of-meeting-or-form-iframe

Uses a loading image as a placeholder that is hidden once the iframe triggers the onload event. Requires the iframe-resizer library for dynamic sizing.

```html
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/iframe-resizer/4.3.9/iframeResizer.min.js"></script>  
  
<script type="text/javascript">  
    function iframeLoaded() {  
        var iframe = document.getElementById('hectic-meeting');  
        var placeholder = document.getElementById('placeholder');  
        iframe.style.display = 'block'; // Show the iframe  
        placeholder.style.display = 'none'; // Hide the placeholder  
    }  
</script>  
      
<div style="width:100%; min-height:500px">  
    <div id="placeholder" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; background: url('https://images.unsplash.com/photo-1712431768806-5b1c94fc0cf3?q=80&w=1000') center center no-repeat;">  
        <!-- loading div -->  
    </div>  
    <iframe src="https://hello.withmoxie.com/01/your-business/30-minute-meeting?inFrame=true" id="hectic-meeting" style="padding: 0px; margin: 0px; border: 0; max-width: 100%; min-width: 100%; display: none;"  onload="iframeLoaded()"></iframe>  
</div>  
  
<script type="text/javascript">  
    setTimeout(() => iFrameResize({heightCalculationMethod: 'min', sizeWidth: true, sizeHeight: true, log: false, checkOrigin: false}, '#hectic-meeting'),100);  
</script>
```

--------------------------------

### GET /action/users/list

Source: https://help.withmoxie.com/en/articles/8260260-list-workspace-users

Retrieves a list of all users and their respective permissions in the Moxie workspace.

```APIDOC
## GET /action/users/list

### Description
List all users and permissions in the Moxie workspace.

### Method
GET

### Endpoint
/action/users/list

### Response
#### Success Response (200)
- **userType** (string) - The type of user (OWNER, FULL_USER, RESTRICTED_ACCESS, COLLABORATOR)
- **user** (object) - User profile details including userId, firstName, lastName, email, phone, phoneVerified, uuid, profilePicture, uploadedPicture, and pricingVersion
- **projectAccess** (object) - Project access details, populated if userType is COLLABORATOR
- **featureAccess** (object) - Feature access permissions, populated if userType is RESTRICTED_ACCESS

#### Response Example
{
   "userType": "OWNER",
   "user": {
      "userId": 0,
      "firstName": "",
      "lastName": "",
      "email": "",
      "phone": "",
      "phoneVerified": false,
      "uuid": "",
      "profilePicture": "",
      "uploadedPicture": false,
      "pricingVersion": 0
   },
   "projectAccess": {
      "projects": [
         {
            "grantedAt": "2023-08-15T09:28:17.852-04:00",
            "projectId": ""
         }
      ]
   },
   "featureAccess": {
      "projects": false,
      "invoices": false,
      "accounting": false,
      "pipeline": false,
      "agreements": false,
      "settings": false,
      "timesheets": false,
      "tickets": false
   }
}
```

--------------------------------

### POST /action/payment/create

Source: https://help.withmoxie.com/en/articles/8213724-apply-payment-to-invoice

Applies a payment to an open invoice within the Moxie system.

```APIDOC
## POST /action/payment/create

### Description
Applies a payment to an open invoice within Moxie.

### Method
POST

### Endpoint
/action/payment/create

### Parameters
#### Request Body
- **date** (string) - Required - The date that the payment was made on the invoice.
- **amount** (number) - Required - The amount of the payment. Must not be greater than the amount currently owed on the invoice.
- **invoiceNumber** (string) - Required - The invoice number within Moxie.
- **clientName** (string) - Optional - Required only if invoice numbering schemes create duplicate invoice numbers between clients.
- **paymentType** (string) - Optional - One of: STRIPE, CHECK, BANK_TRANSFER, CASH, VENMO, PAYPAL, ZELLE, APP_PAYOUT, CREDIT_CARD, OTHER. Defaults to OTHER.
- **referenceNumber** (string) - Optional - Informational reference number that appears in payment history.
- **memo** (string) - Optional - Notes for the payment.

### Request Example
{
  "date": "2023-08-03",
  "amount": 13675.00,
  "invoiceNumber": "E-2023-79",
  "clientName": "Client Name",
  "paymentType": "BANK_TRANSFER",
  "referenceNumber": "123",
  "memo": "API Payment"
}
```

--------------------------------

### FormCompleted Webhook Payload

Source: https://help.withmoxie.com/en/articles/8157313-form-webhook-events

Example JSON structure for a FormCompleted event payload.

```json
{
    "id": "64b8233d6ce6226305f24b47",
    "accountId": 10016,
    "client": null,
    "formName": "test-new-client",
    "businessName": "Moxie",
    "firstName": "Geoffrey",
    "lastName": "Mina",
    "phone": "+444445551212",
    "email": "hello@withmoxie.com",
    "role": null,
    "address1": null,
    "address2": null,
    "city": null,
    "locality": null,
    "postal": null,
    "country": null,
    "website": null,
    "leadSource": null,
    "sourceUrl": "https://hello.withmoxie.dev/00/hectic-lab/test-new-client?inPortal=true",
    "Field6": "Answer to your first question",
    "Field7": "Another to your other question",
    "submittedAt": "2023-07-19T17:54:05.257Z"
}
```

--------------------------------

### playbooks_list

Source: https://help.withmoxie.com/en/articles/16751074

List workflow guides for this CRM: step-by-step instructions for multi-tool jobs (billing, scheduling, sales, delivery). Filter by tool name or category.

```APIDOC
## playbooks_list

### Description
List workflow guides for this CRM: step-by-step instructions for multi-tool jobs (billing, scheduling, sales, delivery). Filter by tool name or category.
```
Tokens:
Raw