> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/onepagecrm.md).

# OnePageCRM

Create and update contacts, deals, follow-up actions, and notes in OnePageCRM.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector  | Authentication |
| ---------- | -------------- |
| OnePageCRM | Credentials    |

#### OnePageCRM

Connect to OnePageCRM with your user ID and API key.

**Set up in OnePageCRM**

1. Prepare the OnePageCRM account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Create or copy your OnePageCRM API key under Configuration, API.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **OnePageCRM**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                 |
| ------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------- |
| User ID       | Yes      | Your OnePageCRM user ID, shown with your API credentials. [Provider instructions](https://app.onepagecrm.com/app/api).        |
| API Key       | Yes      | Create or copy your OnePageCRM API key under Configuration, API. [Provider instructions](https://app.onepagecrm.com/app/api). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **OnePageCRM** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Create Contact

Create a person or company contact in OnePageCRM.

**Inputs**

| Field              | Type            | Required | Description                                                                                                   |
| ------------------ | --------------- | -------- | ------------------------------------------------------------------------------------------------------------- |
| First name         | string          | No       | The contact's first name.                                                                                     |
| Last name          | string          | No       | The contact's last name; required when no company name is supplied.                                           |
| Company name       | string          | No       | The contact's company; required when no last name is supplied.                                                |
| Job title          | string          | No       | The contact's role or job title.                                                                              |
| Work email         | string          | No       | The contact's primary work email address.                                                                     |
| Work phone         | string          | No       | The contact's primary work phone number.                                                                      |
| Status             | select (string) | No       | The contact's CRM status; defaults to Lead. Options load from the selected connection.                        |
| Owner              | select (string) | No       | The teammate who owns the contact; defaults to the connected user. Options load from the selected connection. |
| Custom field       | select (string) | No       | An optional account-defined field to set on the contact. Options load from the selected connection.           |
| Custom field value | string          | No       | The value for the selected custom field.                                                                      |
| Background         | textarea        | No       | Background information and context about the contact.                                                         |
| Tags               | string          | No       | Comma-separated tags to add to the contact.                                                                   |
| Star contact       | boolean         | No       | Mark the contact as starred for quick access. Default: false.                                                 |

**Outputs**

| Field        | Type     | Description                          |
| ------------ | -------- | ------------------------------------ |
| Contact ID   | string   | The created contact's identifier.    |
| Contact name | string   | The created contact's display name.  |
| Created at   | datetime | When OnePageCRM created the contact. |

#### Update Contact

Update selected details on an existing OnePageCRM contact.

**Inputs**

| Field        | Type            | Required | Description                                                       |
| ------------ | --------------- | -------- | ----------------------------------------------------------------- |
| Contact      | select (string) | Yes      | The contact to update. Options load from the selected connection. |
| First name   | string          | No       | A replacement first name; leave unset to preserve it.             |
| Last name    | string          | No       | A replacement last name; leave unset to preserve it.              |
| Company name | string          | No       | A replacement company name; leave unset to preserve it.           |
| Job title    | string          | No       | A replacement job title; leave unset to preserve it.              |
| Status       | select (string) | No       | A replacement CRM status.                                         |
| Owner        | select (string) | No       | A replacement contact owner.                                      |
| Background   | textarea        | No       | Replacement background information; leave unset to preserve it.   |
| Star contact | boolean         | No       | Change whether the contact is starred.                            |

**Outputs**

| Field        | Type     | Description                                |
| ------------ | -------- | ------------------------------------------ |
| Contact ID   | string   | The updated contact's identifier.          |
| Contact name | string   | The contact's returned display name.       |
| Modified at  | datetime | When OnePageCRM last modified the contact. |

#### Create Deal

Create a sales deal for a OnePageCRM contact.

**Inputs**

| Field                 | Type            | Required | Description                                                                                                |
| --------------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------- |
| Contact               | select (string) | Yes      | The contact this deal belongs to. Options load from the selected connection.                               |
| Deal name             | string          | Yes      | A concise name for the opportunity.                                                                        |
| Monthly amount        | number          | No       | The deal value per month. Default: 0.                                                                      |
| Months                | integer         | No       | The number of months in a recurring deal. Default: 1.                                                      |
| Status                | select (string) | No       | Whether the deal is pending, won, or lost. Available values: Pending, Won, Lost. Default: pending.         |
| Expected close date   | date            | No       | When a pending deal is expected to close.                                                                  |
| Close date            | date            | No       | When a won or lost deal actually closed.                                                                   |
| Stage percentage      | integer         | No       | Progress for a pending deal, from 0 to 99.                                                                 |
| Pipeline              | select (string) | No       | The sales pipeline for the deal. Options load from the selected connection.                                |
| Owner                 | select (string) | No       | The teammate who owns the deal; defaults to the connected user. Options load from the selected connection. |
| Line item name        | string          | No       | An optional product or service to include in the deal.                                                     |
| Line item description | textarea        | No       | A description of the optional line item.                                                                   |
| Line item price       | number          | No       | The selling price for one unit of the line item.                                                           |
| Line item quantity    | integer         | No       | The number of line-item units.                                                                             |
| Line item cost        | number          | No       | The internal cost for one unit of the line item.                                                           |
| Deal notes            | textarea        | No       | Additional context about the deal.                                                                         |

**Outputs**

| Field        | Type   | Description                               |
| ------------ | ------ | ----------------------------------------- |
| Deal ID      | string | The created deal's identifier.            |
| Deal name    | string | The created deal's name.                  |
| Status       | string | The deal's returned status.               |
| Total amount | number | The deal's total value across all months. |

#### Create Next Action

Schedule the next follow-up task for a OnePageCRM contact. One ASAP action is allowed per contact and assignee; another can move the existing ASAP action to today.

**Inputs**

| Field          | Type            | Required | Description                                                                                                                                                                                                                                                      |
| -------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Contact        | select (string) | Yes      | The contact this follow-up belongs to. Options load from the selected connection.                                                                                                                                                                                |
| Next action    | string          | Yes      | The concrete follow-up step to take.                                                                                                                                                                                                                             |
| Schedule type  | select (string) | No       | How the follow-up should be scheduled. OnePageCRM permits one ASAP action per contact and assignee; creating another can move the existing ASAP action to today. Available values: ASAP, Due date, Exact time, Waiting, Queued, Queued with date. Default: date. |
| Due date       | date            | No       | The due date for dated or timed follow-ups.                                                                                                                                                                                                                      |
| Exact due time | datetime        | No       | The exact due time for a timed follow-up.                                                                                                                                                                                                                        |
| Assignee       | select (string) | No       | The teammate responsible for the follow-up; defaults to the connected user.                                                                                                                                                                                      |
| Queue position | integer         | No       | Where to place a queued follow-up.                                                                                                                                                                                                                               |

**Outputs**

| Field         | Type   | Description                             |
| ------------- | ------ | --------------------------------------- |
| Action ID     | string | The created follow-up's identifier.     |
| Next action   | string | The created follow-up text.             |
| Schedule type | string | The follow-up's returned schedule type. |
| Due date      | date   | The follow-up's returned due date.      |

#### Add Note to Contact

Record a note on a OnePageCRM contact.

**Inputs**

| Field           | Type            | Required | Description                                                                         |
| --------------- | --------------- | -------- | ----------------------------------------------------------------------------------- |
| Contact         | select (string) | Yes      | The contact this note belongs to. Options load from the selected connection.        |
| Note            | textarea        | Yes      | The note text to record on the contact.                                             |
| Note date       | date            | No       | The note's activity date; defaults to today.                                        |
| Linked deal     | select (string) | No       | An optional deal related to this note. Options load from the selected connection.   |
| Notify teammate | select (string) | No       | A teammate to notify about the new note. Options load from the selected connection. |

**Outputs**

| Field      | Type     | Description                              |
| ---------- | -------- | ---------------------------------------- |
| Note ID    | string   | The created note's identifier.           |
| Contact ID | string   | The contact that received the note.      |
| Note date  | date     | The note's recorded activity date.       |
| Created at | datetime | When OnePageCRM created the note record. |

#### List Contacts

Find contacts in OnePageCRM with common CRM filters.

**Inputs**

| Field            | Type            | Required | Description                                                                             |
| ---------------- | --------------- | -------- | --------------------------------------------------------------------------------------- |
| Search           | string          | No       | A contact name, company name, or phone number to find.                                  |
| Email            | string          | No       | Only return contacts matching this email address.                                       |
| Status           | select (string) | No       | Only return contacts with this CRM status. Options load from the selected connection.   |
| Owner            | select (string) | No       | Only return contacts owned by this teammate. Options load from the selected connection. |
| Has pending deal | boolean         | No       | Optionally filter by whether a contact has a pending deal.                              |
| Has my actions   | boolean         | No       | Optionally filter contacts by actions assigned to the connected user.                   |
| Results per page | integer         | No       | Maximum contacts to return from this page. Default: 25.                                 |
| Next page cursor | string          | No       | Continue from a cursor returned by an earlier call.                                     |

**Outputs**

| Field            | Type          | Description                                       |
| ---------------- | ------------- | ------------------------------------------------- |
| Contacts         | object\_array | Structured contact summaries for this page.       |
| Total matches    | integer       | Total contacts matching the filters.              |
| Next page cursor | string        | Cursor for the next page, if more contacts exist. |

#### List Deals

Find deals in OnePageCRM with common sales filters.

**Inputs**

| Field            | Type            | Required | Description                                                                             |
| ---------------- | --------------- | -------- | --------------------------------------------------------------------------------------- |
| Search           | string          | No       | A deal, contact, or company name to find.                                               |
| Deal status      | select (string) | No       | Only return deals with this status. Available values: Pending, Won, Lost, Closed.       |
| Contact          | select (string) | No       | Only return deals belonging to this contact. Options load from the selected connection. |
| Pipeline         | select (string) | No       | Only return deals in this pipeline. Options load from the selected connection.          |
| Owner            | select (string) | No       | Only return deals owned by this teammate. Options load from the selected connection.    |
| Results per page | integer         | No       | Maximum deals to return from this page. Default: 25.                                    |
| Next page cursor | string          | No       | Continue from a cursor returned by an earlier call.                                     |

**Outputs**

| Field            | Type          | Description                                    |
| ---------------- | ------------- | ---------------------------------------------- |
| Deals            | object\_array | Structured deal summaries for this page.       |
| Total matches    | integer       | Total deals matching the filters.              |
| Next page cursor | string        | Cursor for the next page, if more deals exist. |

#### List Actions

List follow-up actions in OnePageCRM Action Stream order.

**Inputs**

| Field            | Type            | Required | Description                                                                                                                             |
| ---------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| Action status    | select (string) | No       | Only return actions with this scheduling status. Available values: ASAP, Due date, Exact time, Waiting, Queued, Queued with date, Done. |
| Completed only   | boolean         | No       | Optionally filter actions by completion.                                                                                                |
| Contact          | select (string) | No       | Only return actions for this contact.                                                                                                   |
| Assignee         | select (string) | No       | Only return actions assigned to this teammate.                                                                                          |
| Results per page | integer         | No       | Maximum actions to return from this page. Default: 25.                                                                                  |
| Next page cursor | string          | No       | Continue from a cursor returned by an earlier call.                                                                                     |

**Outputs**

| Field            | Type          | Description                                          |
| ---------------- | ------------- | ---------------------------------------------------- |
| Actions          | object\_array | Structured follow-up action summaries for this page. |
| Total matches    | integer       | Total actions matching the filters.                  |
| Next page cursor | string        | Cursor for the next page, if more actions exist.     |

#### Complete Action

Mark a OnePageCRM follow-up action as complete.

**Inputs**

| Field  | Type            | Required | Description                                                                  |
| ------ | --------------- | -------- | ---------------------------------------------------------------------------- |
| Action | select (string) | Yes      | The follow-up action to complete. Options load from the selected connection. |

**Outputs**

| Field        | Type    | Description                                     |
| ------------ | ------- | ----------------------------------------------- |
| Action ID    | string  | The completed action's identifier.              |
| Completed    | boolean | Whether OnePageCRM reports the action complete. |
| Completed at | date    | The completion date reported by OnePageCRM.     |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/onepagecrm.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
