# Ontraport

> Keep Ontraport, the CRM and marketing automation platform, in step with the rest of your business: add and update contacts from sign-ups, tag them, start them on automations, give your team tasks, track deals and log sales. Start a workflow when a contact is added or tagged, a form is filled in, a deal moves or a sale is made.

App · 24 actions. Web page: https://docs.lodol.com/docs/integrations/ontraport

## Actions

### Add contact to automation

Start a contact on automations or sequences, which then send their emails and run their steps. Pick at least one.

**Inputs**

- Contact (`contact`, text, required): The contact's ID, such as 27, from another Ontraport step or the trigger.
- Automations (`automations`, list): Automations from your account, picked from the list or by their ID.
- Sequences (`sequences`, list): Sequences, the older kind of automation, if your account has any.

**Outputs**

- `automation_ids` (list): The IDs of the automations
- `contact_id` (text): The contact's ID
- `message` (text): What Ontraport said, such as 'The subscription is now being processed.'
- `sequence_ids` (list): The IDs of the sequences

**Example output**

```json
{
  "automation_ids": [
    "3"
  ],
  "contact_id": "27",
  "message": "The subscription is now being processed.",
  "sequence_ids": []
}
```

### Add note

Add a note to a contact's record.

**Inputs**

- Contact (`contact`, text, required): The contact's ID, such as 27, from another Ontraport step or the trigger.
- Note (`note`, text, required): What the note says.

**Outputs**

- `contact_id` (text): The ID of the contact it's on
- `id` (text): The note's ID
- `note` (text): What the note says

**Example output**

```json
{
  "contact_id": "27",
  "id": "5",
  "note": "Called about the renewal; follow up next week."
}
```

### Add tags to contact

Tag a contact. Pick tags from your account or type names; a new name makes the tag. Ontraport applies tags within a moment.

**Inputs**

- Contact (`contact`, text, required): The contact's ID, such as 27, from another Ontraport step or the trigger.
- Tags (`tags`, list, required): Pick tags, or type a tag's name; a name that's new makes the tag.

**Outputs**

- `contact_id` (text): The contact's ID
- `message` (text): What Ontraport said, such as 'The tag is now being processed.'
- `tag_ids` (list): The IDs of the tags picked from the list
- `tag_names` (list): The tag names typed in

**Example output**

```json
{
  "contact_id": "27",
  "message": "The tag is now being processed.",
  "tag_ids": [
    "2"
  ],
  "tag_names": [
    "Webinar attendee"
  ]
}
```

### Complete task

Mark a task done, with an outcome such as 'Signed' if you like.

**Inputs**

- Task (`task`, text, required): The task's ID, such as 27, from another Ontraport step or the trigger.
- Outcome (`outcome`, text): How it went, such as Signed. Ontraport adds it to its outcomes.

**Outputs**

- `assigned_at` (text): When it was assigned (ISO 8601)
- `assignee_id` (text): The ID of the user it's assigned to
- `completed_at` (text): When it was completed (ISO 8601); empty if not yet
- `contact_id` (text): The ID of the contact it's about
- `details` (text): The task's instructions
- `due_at` (text): When it's due (ISO 8601)
- `id` (text): The task's ID; empty if Ontraport hasn't listed it yet
- `status` (text): pending, complete or canceled
- `subject` (text): What the task is
- `task_message_id` (text): The ID of the task message it was made from

**Example output**

```json
{
  "assigned_at": "2017-04-11T16:44:10Z",
  "assignee_id": "1",
  "completed_at": "2018-03-29T16:44:10Z",
  "contact_id": "32",
  "details": "Fred, please complete this task.",
  "due_at": "2018-03-29T16:44:10Z",
  "id": "1",
  "status": "complete",
  "subject": "Do this.",
  "task_message_id": "7"
}
```

### Create contact

Add a contact to Ontraport, with tags if you like. Ontraport allows two contacts with one email; use 'Create or update contact' for sign-ups.

**Inputs**

- First name (`first_name`, text): Their first name.
- Last name (`last_name`, text): Their last name.
- Email (`email`, text): Their email.
- Phone (`phone`, text): Their office phone, such as +1 805 555 5555.
- Mobile phone (`mobile_phone`, text): Their mobile phone.
- SMS number (`sms_number`, text): The number they get texts at, with its country code.
- Company (`company`, text): Their company.
- Job title (`job_title`, text): Their job title.
- Website (`website`, text): Their website.
- Address (`address`, text): Their street address.
- Address line 2 (`address2`, text): A suite or unit number.
- City (`city`, text): Their city.
- State (`state`, text): Their state or region as a code, such as CA.
- ZIP or postal code (`zip`, text): Their ZIP or postal code.
- Country (`country`, text): Their country as a two-letter code, such as US.
- Birthday (`birthday`, date): Their birthday.
- Owner (`owner`, text): The user who owns the record, or their ID.
- Tags (`tags`, list): Pick tags, or type a tag's name; a name that's new makes the tag.
- Custom fields (`custom_fields`, object): Fields your account added to contacts, by the name Ontraport shows, such as {"Lead score": 10}. A list field takes a list of its choices.

**Outputs**

- `address` (text): Their street address
- `address2` (text): The second line of their address
- `birthday` (text): Their birthday (YYYY-MM-DD); empty if unknown
- `city` (text): Their city
- `company` (text): Their company
- `country` (text): Their country, as a two-letter code such as US
- `created_at` (text): When they were added (ISO 8601)
- `custom_fields` (object): Fields your account added, by the name Ontraport shows (a list field's choices as a list)
- `email` (text): Their email
- `email_status` (text): Whether they get bulk email: Opted in, Double opt-in, Transactional only, Hard bounce or Under review
- `first_name` (text): Their first name
- `id` (text): The contact's ID
- `job_title` (text): Their job title
- `last_activity_at` (text): When they last filled in a form, visited your site or clicked an email (ISO 8601)
- `last_name` (text): Their last name
- `mobile_phone` (text): Their mobile phone
- `name` (text): Their full name
- `orders` (number): How many orders they have placed
- `owner_id` (text): The ID of the user who owns the contact
- `phone` (text): Their office phone
- `score` (number): Their lead score
- `sms_number` (text): The number they get texts at
- `sms_status` (text): Whether they get bulk texts, such as Opted in or Unsubscribed
- `state` (text): Their state or region, as a code such as CA
- `total_spent` (number): How much they have spent with you
- `unique_id` (text): Ontraport's unique code for the contact, such as D4GD000
- `updated_at` (text): When their record last changed (ISO 8601)
- `website` (text): Their website
- `zip` (text): Their ZIP or postal code

**Example output**

```json
{
  "address": "2040 Alameda Padre Serra",
  "address2": "Suite 220",
  "birthday": "1984-11-17",
  "city": "Santa Barbara",
  "company": "Ontraport",
  "country": "US",
  "created_at": "2018-07-11T23:45:01Z",
  "custom_fields": {},
  "email": "user@ontraport.com",
  "email_status": "Opted in",
  "first_name": "First",
  "id": "27",
  "job_title": "Employee",
  "last_activity_at": "2018-07-11T23:45:01Z",
  "last_name": "Last",
  "mobile_phone": "",
  "name": "First Last",
  "orders": 0,
  "owner_id": "1",
  "phone": "805-555-5555",
  "score": 0.0,
  "sms_number": "+18055555555",
  "sms_status": "One to one only",
  "state": "CA",
  "total_spent": 0.0,
  "unique_id": "D4GD000",
  "updated_at": "2018-07-11T23:45:17Z",
  "website": "www.ontraport.com",
  "zip": "93103"
}
```

### Create deal

Add a deal to your pipeline, with its value, stage and primary contact.

**Inputs**

- Name (`name`, text, required): What the deal is called.
- Value (`value`, number): How much it's worth, such as 4800. At least 0.
- Stage (`stage`, text): The deal's stage, picked from your pipeline or typed by name.
- Expected close date (`expected_close_date`, date): When it should close.
- Chance of winning (`win_percent`, number): The expected chance of winning it, in percent. From 0 to 100.
- Primary contact (`contact`, text): The contact's ID, such as 27, from another Ontraport step or the trigger.
- Owner (`owner`, text): The user who owns the record, or their ID.
- Custom fields (`custom_fields`, object): Fields your account added to deals, by the name Ontraport shows, such as {"Lead source": "Webinar"}. A list field takes a list of its choices.

**Outputs**

- `contact_id` (text): The ID of its primary contact
- `created_at` (text): When it was added (ISO 8601)
- `custom_fields` (object): Fields your account added, by the name Ontraport shows (a list field's choices as a list)
- `expected_close_date` (text): When it's expected to close (YYYY-MM-DD)
- `id` (text): The deal's ID
- `name` (text): What the deal is called
- `owner_id` (text): The ID of the user who owns it
- `stage` (text): Its stage, as Ontraport shows it
- `stage_id` (text): The ID of its stage
- `updated_at` (text): When it last changed (ISO 8601)
- `value` (number): How much it's worth
- `win_percent` (number): The expected chance of winning it, from 0 to 100

**Example output**

```json
{
  "contact_id": "27",
  "created_at": "2026-11-05T09:00:00Z",
  "custom_fields": {},
  "expected_close_date": "2026-12-15",
  "id": "12",
  "name": "Annual coaching package",
  "owner_id": "1",
  "stage": "Committed",
  "stage_id": "3",
  "updated_at": "2026-11-05T09:00:00Z",
  "value": 4800.0,
  "win_percent": 60.0
}
```

### Create or update contact

Update the contact with this email, or add one if nobody has it, such as for a form or sign-up. Fields left blank keep what they have.

**Inputs**

- Email (`email`, text, required): The email to match the contact on; they're added if nobody has it.
- First name (`first_name`, text): Their first name.
- Last name (`last_name`, text): Their last name.
- Phone (`phone`, text): Their office phone, such as +1 805 555 5555.
- Mobile phone (`mobile_phone`, text): Their mobile phone.
- SMS number (`sms_number`, text): The number they get texts at, with its country code.
- Company (`company`, text): Their company.
- Job title (`job_title`, text): Their job title.
- Website (`website`, text): Their website.
- Address (`address`, text): Their street address.
- Address line 2 (`address2`, text): A suite or unit number.
- City (`city`, text): Their city.
- State (`state`, text): Their state or region as a code, such as CA.
- ZIP or postal code (`zip`, text): Their ZIP or postal code.
- Country (`country`, text): Their country as a two-letter code, such as US.
- Birthday (`birthday`, date): Their birthday.
- Owner (`owner`, text): The user who owns the record, or their ID.
- Tags (`tags`, list): Pick tags, or type a tag's name; a name that's new makes the tag.
- Custom fields (`custom_fields`, object): Fields your account added to contacts, by the name Ontraport shows, such as {"Lead score": 10}. A list field takes a list of its choices.

**Outputs**

- `address` (text): Their street address
- `address2` (text): The second line of their address
- `birthday` (text): Their birthday (YYYY-MM-DD); empty if unknown
- `city` (text): Their city
- `company` (text): Their company
- `country` (text): Their country, as a two-letter code such as US
- `created` (true/false): True if the contact was added, false if one was updated
- `created_at` (text): When they were added (ISO 8601)
- `custom_fields` (object): Fields your account added, by the name Ontraport shows (a list field's choices as a list)
- `email` (text): Their email
- `email_status` (text): Whether they get bulk email: Opted in, Double opt-in, Transactional only, Hard bounce or Under review
- `first_name` (text): Their first name
- `id` (text): The contact's ID
- `job_title` (text): Their job title
- `last_activity_at` (text): When they last filled in a form, visited your site or clicked an email (ISO 8601)
- `last_name` (text): Their last name
- `mobile_phone` (text): Their mobile phone
- `name` (text): Their full name
- `orders` (number): How many orders they have placed
- `owner_id` (text): The ID of the user who owns the contact
- `phone` (text): Their office phone
- `score` (number): Their lead score
- `sms_number` (text): The number they get texts at
- `sms_status` (text): Whether they get bulk texts, such as Opted in or Unsubscribed
- `state` (text): Their state or region, as a code such as CA
- `total_spent` (number): How much they have spent with you
- `unique_id` (text): Ontraport's unique code for the contact, such as D4GD000
- `updated_at` (text): When their record last changed (ISO 8601)
- `website` (text): Their website
- `zip` (text): Their ZIP or postal code

**Example output**

```json
{
  "address": "2040 Alameda Padre Serra",
  "address2": "Suite 220",
  "birthday": "1984-11-17",
  "city": "Santa Barbara",
  "company": "Ontraport",
  "country": "US",
  "created": true,
  "created_at": "2018-07-11T23:45:01Z",
  "custom_fields": {},
  "email": "user@ontraport.com",
  "email_status": "Opted in",
  "first_name": "First",
  "id": "27",
  "job_title": "Employee",
  "last_activity_at": "2018-07-11T23:45:01Z",
  "last_name": "Last",
  "mobile_phone": "",
  "name": "First Last",
  "orders": 0,
  "owner_id": "1",
  "phone": "805-555-5555",
  "score": 0.0,
  "sms_number": "+18055555555",
  "sms_status": "One to one only",
  "state": "CA",
  "total_spent": 0.0,
  "unique_id": "D4GD000",
  "updated_at": "2018-07-11T23:45:17Z",
  "website": "www.ontraport.com",
  "zip": "93103"
}
```

### Create product

Add a product, to sell on Ontraport's order forms or log sales of.

**Inputs**

- Name (`name`, text, required): What the product is called.
- Price (`price`, number, required): What one costs, such as 49.99. At least 0.

**Outputs**

- `created_at` (text): When it was added (ISO 8601)
- `description` (text): Its description
- `id` (text): The product's ID
- `name` (text): Its name
- `price` (number): Its price
- `sku` (text): Its SKU
- `total_income` (number): How much it has earned
- `total_purchases` (number): How many times it has been bought
- `updated_at` (text): When it last changed (ISO 8601)

**Example output**

```json
{
  "created_at": "2018-08-06T20:35:32Z",
  "description": "",
  "id": "1",
  "name": "cheesecake",
  "price": 2.99,
  "sku": "",
  "total_income": 630.0,
  "total_purchases": 73,
  "updated_at": "2018-08-06T20:35:32Z"
}
```

### Create task

Give a user a task about a contact. Pick one of your task messages, or write a subject and details, which Ontraport keeps as a task message of their own.

**Inputs**

- Contact (`contact`, text, required): The contact's ID, such as 27, from another Ontraport step or the trigger.
- Subject (`subject`, text): What needs doing. Needed unless you pick a task message.
- Details (`details`, text): More about it. You can use merge fields such as [First Name].
- Task message (`task_message`, text): One of your task messages to use instead of a subject and details.
- Due date (`due_date`, date): When it's due. Left blank, it's due today, or when the task message says.
- Assigned to (`assignee`, text): The user who does the task, or their ID.

**Outputs**

- `assigned_at` (text): When it was assigned (ISO 8601)
- `assignee_id` (text): The ID of the user it's assigned to
- `completed_at` (text): When it was completed (ISO 8601); empty if not yet
- `contact_id` (text): The ID of the contact it's about
- `details` (text): The task's instructions
- `due_at` (text): When it's due (ISO 8601)
- `id` (text): The task's ID; empty if Ontraport hasn't listed it yet
- `status` (text): pending, complete or canceled
- `subject` (text): What the task is
- `task_message_created` (true/false): True if a task message was made for this task's subject
- `task_message_id` (text): The ID of the task message it was made from

**Example output**

```json
{
  "assigned_at": "2017-04-11T16:44:10Z",
  "assignee_id": "1",
  "completed_at": "",
  "contact_id": "32",
  "details": "Fred, please complete this task.",
  "due_at": "2018-03-29T16:44:10Z",
  "id": "1",
  "status": "pending",
  "subject": "Do this.",
  "task_message_created": true,
  "task_message_id": "7"
}
```

### Delete record

Delete a contact, deal, product or task message for good. Ontraport can't undo it.

**Inputs**

- Type (`record_type`, text, required): What kind of record it is. One of: `contact`, `deal`, `product`, `task_message` (Task message).
- Record (`record`, text, required): Its ID, such as 27, from another Ontraport step or the trigger.

**Outputs**

- `deleted` (true/false): True once it's deleted
- `id` (text): The ID of what was deleted
- `record_type` (text): contact, deal, product or task_message

**Example output**

```json
{
  "deleted": true,
  "id": "27",
  "record_type": "contact"
}
```

### Find contact by email

Look up the contact with an email. If several have it, the newest is given; 'Found' says whether anyone has it.

**Inputs**

- Email (`email`, text, required): The email to look for.

**Outputs**

- `address` (text): Their street address
- `address2` (text): The second line of their address
- `birthday` (text): Their birthday (YYYY-MM-DD); empty if unknown
- `city` (text): Their city
- `company` (text): Their company
- `country` (text): Their country, as a two-letter code such as US
- `created_at` (text): When they were added (ISO 8601)
- `custom_fields` (object): Fields your account added, by the name Ontraport shows (a list field's choices as a list)
- `email` (text): Their email
- `email_status` (text): Whether they get bulk email: Opted in, Double opt-in, Transactional only, Hard bounce or Under review
- `first_name` (text): Their first name
- `found` (true/false): Whether any contact has that email
- `id` (text): The contact's ID
- `job_title` (text): Their job title
- `last_activity_at` (text): When they last filled in a form, visited your site or clicked an email (ISO 8601)
- `last_name` (text): Their last name
- `matches` (number): How many contacts have that email
- `mobile_phone` (text): Their mobile phone
- `name` (text): Their full name
- `orders` (number): How many orders they have placed
- `owner_id` (text): The ID of the user who owns the contact
- `phone` (text): Their office phone
- `score` (number): Their lead score
- `sms_number` (text): The number they get texts at
- `sms_status` (text): Whether they get bulk texts, such as Opted in or Unsubscribed
- `state` (text): Their state or region, as a code such as CA
- `total_spent` (number): How much they have spent with you
- `unique_id` (text): Ontraport's unique code for the contact, such as D4GD000
- `updated_at` (text): When their record last changed (ISO 8601)
- `website` (text): Their website
- `zip` (text): Their ZIP or postal code

**Example output**

```json
{
  "address": "2040 Alameda Padre Serra",
  "address2": "Suite 220",
  "birthday": "1984-11-17",
  "city": "Santa Barbara",
  "company": "Ontraport",
  "country": "US",
  "created_at": "2018-07-11T23:45:01Z",
  "custom_fields": {},
  "email": "user@ontraport.com",
  "email_status": "Opted in",
  "first_name": "First",
  "found": true,
  "id": "27",
  "job_title": "Employee",
  "last_activity_at": "2018-07-11T23:45:01Z",
  "last_name": "Last",
  "matches": 1,
  "mobile_phone": "",
  "name": "First Last",
  "orders": 0,
  "owner_id": "1",
  "phone": "805-555-5555",
  "score": 0.0,
  "sms_number": "+18055555555",
  "sms_status": "One to one only",
  "state": "CA",
  "total_spent": 0.0,
  "unique_id": "D4GD000",
  "updated_at": "2018-07-11T23:45:17Z",
  "website": "www.ontraport.com",
  "zip": "93103"
}
```

### Get contact

Get a contact's details, including your custom fields.

**Inputs**

- Contact (`contact`, text, required): The contact's ID, such as 27, from another Ontraport step or the trigger.

**Outputs**

- `address` (text): Their street address
- `address2` (text): The second line of their address
- `birthday` (text): Their birthday (YYYY-MM-DD); empty if unknown
- `city` (text): Their city
- `company` (text): Their company
- `country` (text): Their country, as a two-letter code such as US
- `created_at` (text): When they were added (ISO 8601)
- `custom_fields` (object): Fields your account added, by the name Ontraport shows (a list field's choices as a list)
- `email` (text): Their email
- `email_status` (text): Whether they get bulk email: Opted in, Double opt-in, Transactional only, Hard bounce or Under review
- `first_name` (text): Their first name
- `id` (text): The contact's ID
- `job_title` (text): Their job title
- `last_activity_at` (text): When they last filled in a form, visited your site or clicked an email (ISO 8601)
- `last_name` (text): Their last name
- `mobile_phone` (text): Their mobile phone
- `name` (text): Their full name
- `orders` (number): How many orders they have placed
- `owner_id` (text): The ID of the user who owns the contact
- `phone` (text): Their office phone
- `score` (number): Their lead score
- `sms_number` (text): The number they get texts at
- `sms_status` (text): Whether they get bulk texts, such as Opted in or Unsubscribed
- `state` (text): Their state or region, as a code such as CA
- `total_spent` (number): How much they have spent with you
- `unique_id` (text): Ontraport's unique code for the contact, such as D4GD000
- `updated_at` (text): When their record last changed (ISO 8601)
- `website` (text): Their website
- `zip` (text): Their ZIP or postal code

**Example output**

```json
{
  "address": "2040 Alameda Padre Serra",
  "address2": "Suite 220",
  "birthday": "1984-11-17",
  "city": "Santa Barbara",
  "company": "Ontraport",
  "country": "US",
  "created_at": "2018-07-11T23:45:01Z",
  "custom_fields": {},
  "email": "user@ontraport.com",
  "email_status": "Opted in",
  "first_name": "First",
  "id": "27",
  "job_title": "Employee",
  "last_activity_at": "2018-07-11T23:45:01Z",
  "last_name": "Last",
  "mobile_phone": "",
  "name": "First Last",
  "orders": 0,
  "owner_id": "1",
  "phone": "805-555-5555",
  "score": 0.0,
  "sms_number": "+18055555555",
  "sms_status": "One to one only",
  "state": "CA",
  "total_spent": 0.0,
  "unique_id": "D4GD000",
  "updated_at": "2018-07-11T23:45:17Z",
  "website": "www.ontraport.com",
  "zip": "93103"
}
```

### List contacts

List contacts matching every filter you give: words to search for, a tag, an owner, a field's value, or when they were added or changed. Leave every filter blank to list the newest.

**Inputs**

- Search (`search`, text): Words to look for, such as a name or email.
- Tag (`tag`, text): Only contacts with this tag.
- Owner (`owner`, text): Only contacts this user owns.
- Field (`field`, text): Only contacts whose field has the value below. Pick the field.
- Field value (`field_value`, text): The value the field must have; a dropdown field's choice by name.
- Added after (`created_after`, date and time): Only contacts added after this.
- Changed after (`updated_after`, date and time): Only contacts changed after this.
- Order (`sort`, text): The order to list them in. One of: `newest` (Newest first), `recently_updated` (Recently changed first), `last_name` (Last name, A to Z). Default: `newest`.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 200.

**Outputs**

- `contacts` (list): The contacts found
- `count` (number): How many are listed

**Example output**

```json
{
  "contacts": [
    {
      "address": "2040 Alameda Padre Serra",
      "address2": "Suite 220",
      "birthday": "1984-11-17",
      "city": "Santa Barbara",
      "company": "Ontraport",
      "country": "US",
      "created_at": "2018-07-11T23:45:01Z",
      "custom_fields": {},
      "email": "user@ontraport.com",
      "email_status": "Opted in",
      "first_name": "First",
      "id": "27",
      "job_title": "Employee",
      "last_activity_at": "2018-07-11T23:45:01Z",
      "last_name": "Last",
      "mobile_phone": "",
      "name": "First Last",
      "orders": 0,
      "owner_id": "1",
      "phone": "805-555-5555",
      "score": 0.0,
      "sms_number": "+18055555555",
      "sms_status": "One to one only",
      "state": "CA",
      "total_spent": 0.0,
      "unique_id": "D4GD000",
      "updated_at": "2018-07-11T23:45:17Z",
      "website": "www.ontraport.com",
      "zip": "93103"
    }
  ],
  "count": 1
}
```

### List deals

List deals, newest first, by words in them, stage, primary contact or owner.

**Inputs**

- Search (`search`, text): Words to look for in the deal.
- Stage (`stage`, text): Only deals in this stage.
- Primary contact (`contact`, text): The contact's ID, such as 27, from another Ontraport step or the trigger.
- Owner (`owner`, text): Only deals this user owns.
- How many (`limit`, number): The most to list, newest first. Defaults to 25. From 1 to 200.

**Outputs**

- `count` (number): How many are listed
- `deals` (list): The deals found

**Example output**

```json
{
  "count": 1,
  "deals": [
    {
      "contact_id": "27",
      "created_at": "2026-11-05T09:00:00Z",
      "custom_fields": {},
      "expected_close_date": "2026-12-15",
      "id": "12",
      "name": "Annual coaching package",
      "owner_id": "1",
      "stage": "Committed",
      "stage_id": "3",
      "updated_at": "2026-11-05T09:00:00Z",
      "value": 4800.0,
      "win_percent": 60.0
    }
  ]
}
```

### List forms

List your forms, with how many times each was filled in.

**Inputs**

- Search (`search`, text): Words to look for in the name.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 50.

**Outputs**

- `count` (number): How many are listed
- `forms` (list): The forms found

**Example output**

```json
{
  "count": 1,
  "forms": [
    {
      "created_at": "2017-11-14T23:55:43Z",
      "id": "2",
      "name": "Test Form",
      "submissions": 0,
      "thank_you_page": "",
      "type": "ONTRAform",
      "unique_visits": 0,
      "updated_at": "2017-11-14T23:55:43Z",
      "visits": 0
    }
  ]
}
```

### List products

List your products, newest first.

**Inputs**

- Search (`search`, text): Words to look for in the name.
- How many (`limit`, number): The most to list, newest first. Defaults to 25. From 1 to 200.

**Outputs**

- `count` (number): How many are listed
- `products` (list): The products found

**Example output**

```json
{
  "count": 1,
  "products": [
    {
      "created_at": "2018-08-06T20:35:32Z",
      "description": "",
      "id": "1",
      "name": "cheesecake",
      "price": 2.99,
      "sku": "",
      "total_income": 630.0,
      "total_purchases": 73,
      "updated_at": "2018-08-06T20:35:32Z"
    }
  ]
}
```

### List tasks

List tasks, newest first: a contact's, those in a status, or a user's.

**Inputs**

- Contact (`contact`, text): The contact's ID, such as 27, from another Ontraport step or the trigger.
- Status (`status`, text): Only tasks in this status. One of: `pending`, `complete`, `canceled`.
- Assigned to (`assignee`, text): Only tasks this user does.
- How many (`limit`, number): The most to list, newest first. Defaults to 25. From 1 to 200.

**Outputs**

- `count` (number): How many are listed
- `tasks` (list): The tasks found

**Example output**

```json
{
  "count": 1,
  "tasks": [
    {
      "assigned_at": "2017-04-11T16:44:10Z",
      "assignee_id": "1",
      "completed_at": "",
      "contact_id": "32",
      "details": "Fred, please complete this task.",
      "due_at": "2018-03-29T16:44:10Z",
      "id": "1",
      "status": "pending",
      "subject": "Do this.",
      "task_message_id": "7"
    }
  ]
}
```

### List transactions

List transactions (invoices), newest first: a contact's, those in a status, or those made after a time.

**Inputs**

- Contact (`contact`, text): The contact's ID, such as 27, from another Ontraport step or the trigger.
- Status (`status`, text): Only transactions in this status. One of: `paid`, `pending`, `unpaid`, `draft`, `collections`, `declined`, `refunded`, `partially_refunded` (Partially refunded), `voided`, `written_off` (Written off), `closed`.
- Made after (`created_after`, date and time): Only transactions made after this.
- How many (`limit`, number): The most to list, newest first. Defaults to 25. From 1 to 200.

**Outputs**

- `count` (number): How many are listed
- `transactions` (list): The transactions found

**Example output**

```json
{
  "count": 1,
  "transactions": [
    {
      "contact_id": "1",
      "contact_name": "Mary Smith",
      "created_at": "2017-04-19T17:58:20Z",
      "external_order_id": "",
      "form_id": "0",
      "id": "1",
      "order_id": "0",
      "products": [
        {
          "id": "5",
          "name": "Lambas Bread",
          "price": 20.0,
          "quantity": 20,
          "total": 400.0
        }
      ],
      "shipping": 0.0,
      "status": "written_off",
      "subtotal": 400.0,
      "tax": 0.0,
      "total": 400.0
    }
  ]
}
```

### Log transaction

Record a sale of a product that was paid somewhere else, such as in another shop. Nobody is charged, and no invoice is emailed unless you ask for one.

**Inputs**

- Contact (`contact`, text, required): The contact's ID, such as 27, from another Ontraport step or the trigger.
- Product (`product`, text, required): The product sold, or its ID.
- Quantity (`quantity`, number): How many were sold. Defaults to 1. At least 1.
- Price (`price`, number): What one sold for. Leave blank for the product's price. At least 0.
- Date (`transaction_date`, date and time): When it sold. Leave blank for now.
- Email an invoice (`send_invoice`, true/false): Email the contact Ontraport's invoice for it. Default: `false`.
- Order number (`external_order_id`, text): The order's number in the other shop, kept on the transaction.

**Outputs**

- `contact_id` (text): The ID of the contact who bought
- `contact_name` (text): Their full name
- `created_at` (text): When it was made (ISO 8601)
- `external_order_id` (text): The order's ID in another system, if given
- `form_id` (text): The order form it came from; 0 if none
- `id` (text): The transaction's (invoice's) ID
- `order_id` (text): The subscription order it belongs to; 0 if none
- `products` (list): What was bought
- `shipping` (number): The shipping
- `status` (text): paid, pending, unpaid, draft, collections, declined, refunded, partially_refunded, voided, written_off or closed
- `subtotal` (number): The amount before tax and shipping
- `tax` (number): The tax
- `total` (number): The total

**Example output**

```json
{
  "contact_id": "1",
  "contact_name": "Mary Smith",
  "created_at": "2017-04-19T17:58:20Z",
  "external_order_id": "",
  "form_id": "0",
  "id": "1",
  "order_id": "0",
  "products": [
    {
      "id": "5",
      "name": "Lambas Bread",
      "price": 20.0,
      "quantity": 20,
      "total": 400.0
    }
  ],
  "shipping": 0.0,
  "status": "written_off",
  "subtotal": 400.0,
  "tax": 0.0,
  "total": 400.0
}
```

### Remove contact from automation

Take a contact out of automations or sequences, so they stop running for them. Pick at least one.

**Inputs**

- Contact (`contact`, text, required): The contact's ID, such as 27, from another Ontraport step or the trigger.
- Automations (`automations`, list): Automations from your account, picked from the list or by their ID.
- Sequences (`sequences`, list): Sequences, the older kind of automation, if your account has any.

**Outputs**

- `automation_ids` (list): The IDs of the automations
- `contact_id` (text): The contact's ID
- `message` (text): What Ontraport said, such as 'The subscription is now being processed.'
- `sequence_ids` (list): The IDs of the sequences

**Example output**

```json
{
  "automation_ids": [
    "3"
  ],
  "contact_id": "27",
  "message": "The subscription is now being processed.",
  "sequence_ids": []
}
```

### Remove tags from contact

Take tags off a contact, picked from your account or typed by name. A tag the contact doesn't have is skipped.

**Inputs**

- Contact (`contact`, text, required): The contact's ID, such as 27, from another Ontraport step or the trigger.
- Tags (`tags`, list, required): Pick tags, or type a tag's name.

**Outputs**

- `contact_id` (text): The contact's ID
- `message` (text): What Ontraport said, such as 'The tag is now being processed.'
- `tag_ids` (list): The IDs of the tags picked from the list
- `tag_names` (list): The tag names typed in

**Example output**

```json
{
  "contact_id": "27",
  "message": "The tag is now being processed.",
  "tag_ids": [
    "2"
  ],
  "tag_names": [
    "Webinar attendee"
  ]
}
```

### Update contact

Change a contact's details. Fields left blank keep what they have.

**Inputs**

- Contact (`contact`, text, required): The contact's ID, such as 27, from another Ontraport step or the trigger.
- First name (`first_name`, text): Their first name.
- Last name (`last_name`, text): Their last name.
- Email (`email`, text): Their email.
- Phone (`phone`, text): Their office phone, such as +1 805 555 5555.
- Mobile phone (`mobile_phone`, text): Their mobile phone.
- SMS number (`sms_number`, text): The number they get texts at, with its country code.
- Company (`company`, text): Their company.
- Job title (`job_title`, text): Their job title.
- Website (`website`, text): Their website.
- Address (`address`, text): Their street address.
- Address line 2 (`address2`, text): A suite or unit number.
- City (`city`, text): Their city.
- State (`state`, text): Their state or region as a code, such as CA.
- ZIP or postal code (`zip`, text): Their ZIP or postal code.
- Country (`country`, text): Their country as a two-letter code, such as US.
- Birthday (`birthday`, date): Their birthday.
- Owner (`owner`, text): The user who owns the record, or their ID.
- Custom fields (`custom_fields`, object): Fields your account added to contacts, by the name Ontraport shows, such as {"Lead score": 10}. A list field takes a list of its choices.

**Outputs**

- `address` (text): Their street address
- `address2` (text): The second line of their address
- `birthday` (text): Their birthday (YYYY-MM-DD); empty if unknown
- `city` (text): Their city
- `company` (text): Their company
- `country` (text): Their country, as a two-letter code such as US
- `created_at` (text): When they were added (ISO 8601)
- `custom_fields` (object): Fields your account added, by the name Ontraport shows (a list field's choices as a list)
- `email` (text): Their email
- `email_status` (text): Whether they get bulk email: Opted in, Double opt-in, Transactional only, Hard bounce or Under review
- `first_name` (text): Their first name
- `id` (text): The contact's ID
- `job_title` (text): Their job title
- `last_activity_at` (text): When they last filled in a form, visited your site or clicked an email (ISO 8601)
- `last_name` (text): Their last name
- `mobile_phone` (text): Their mobile phone
- `name` (text): Their full name
- `orders` (number): How many orders they have placed
- `owner_id` (text): The ID of the user who owns the contact
- `phone` (text): Their office phone
- `score` (number): Their lead score
- `sms_number` (text): The number they get texts at
- `sms_status` (text): Whether they get bulk texts, such as Opted in or Unsubscribed
- `state` (text): Their state or region, as a code such as CA
- `total_spent` (number): How much they have spent with you
- `unique_id` (text): Ontraport's unique code for the contact, such as D4GD000
- `updated_at` (text): When their record last changed (ISO 8601)
- `website` (text): Their website
- `zip` (text): Their ZIP or postal code

**Example output**

```json
{
  "address": "2040 Alameda Padre Serra",
  "address2": "Suite 220",
  "birthday": "1984-11-17",
  "city": "Santa Barbara",
  "company": "Ontraport",
  "country": "US",
  "created_at": "2018-07-11T23:45:01Z",
  "custom_fields": {},
  "email": "user@ontraport.com",
  "email_status": "Opted in",
  "first_name": "First",
  "id": "27",
  "job_title": "Employee",
  "last_activity_at": "2018-07-11T23:45:01Z",
  "last_name": "Last",
  "mobile_phone": "",
  "name": "First Last",
  "orders": 0,
  "owner_id": "1",
  "phone": "805-555-5555",
  "score": 0.0,
  "sms_number": "+18055555555",
  "sms_status": "One to one only",
  "state": "CA",
  "total_spent": 0.0,
  "unique_id": "D4GD000",
  "updated_at": "2018-07-11T23:45:17Z",
  "website": "www.ontraport.com",
  "zip": "93103"
}
```

### Update deal

Change a deal, such as moving it to another stage. Fields left blank keep what they have.

**Inputs**

- Deal (`deal`, text, required): The deal's ID, such as 27, from another Ontraport step or the trigger.
- Name (`name`, text): A new name. Leave blank to keep it.
- Value (`value`, number): How much it's worth, such as 4800. At least 0.
- Stage (`stage`, text): The deal's stage, picked from your pipeline or typed by name.
- Expected close date (`expected_close_date`, date): When it should close.
- Chance of winning (`win_percent`, number): The expected chance of winning it, in percent. From 0 to 100.
- Primary contact (`contact`, text): The contact's ID, such as 27, from another Ontraport step or the trigger.
- Owner (`owner`, text): The user who owns the record, or their ID.
- Custom fields (`custom_fields`, object): Fields your account added to deals, by the name Ontraport shows, such as {"Lead source": "Webinar"}. A list field takes a list of its choices.

**Outputs**

- `contact_id` (text): The ID of its primary contact
- `created_at` (text): When it was added (ISO 8601)
- `custom_fields` (object): Fields your account added, by the name Ontraport shows (a list field's choices as a list)
- `expected_close_date` (text): When it's expected to close (YYYY-MM-DD)
- `id` (text): The deal's ID
- `name` (text): What the deal is called
- `owner_id` (text): The ID of the user who owns it
- `stage` (text): Its stage, as Ontraport shows it
- `stage_id` (text): The ID of its stage
- `updated_at` (text): When it last changed (ISO 8601)
- `value` (number): How much it's worth
- `win_percent` (number): The expected chance of winning it, from 0 to 100

**Example output**

```json
{
  "contact_id": "27",
  "created_at": "2026-11-05T09:00:00Z",
  "custom_fields": {},
  "expected_close_date": "2026-12-15",
  "id": "12",
  "name": "Annual coaching package",
  "owner_id": "1",
  "stage": "Committed",
  "stage_id": "3",
  "updated_at": "2026-11-05T09:00:00Z",
  "value": 4800.0,
  "win_percent": 60.0
}
```

### Update task

Reassign a task, change when it's due, or cancel it. Fields left blank keep what they have; use 'Complete task' to finish one with an outcome.

**Inputs**

- Task (`task`, text, required): The task's ID, such as 27, from another Ontraport step or the trigger.
- Assigned to (`assignee`, text): The user who does the task, or their ID.
- Due (`due_at`, date and time): When it's due.
- Status (`status`, text): Where it stands. One of: `pending`, `complete`, `canceled`.

**Outputs**

- `assigned_at` (text): When it was assigned (ISO 8601)
- `assignee_id` (text): The ID of the user it's assigned to
- `completed_at` (text): When it was completed (ISO 8601); empty if not yet
- `contact_id` (text): The ID of the contact it's about
- `details` (text): The task's instructions
- `due_at` (text): When it's due (ISO 8601)
- `id` (text): The task's ID; empty if Ontraport hasn't listed it yet
- `status` (text): pending, complete or canceled
- `subject` (text): What the task is
- `task_message_id` (text): The ID of the task message it was made from

**Example output**

```json
{
  "assigned_at": "2017-04-11T16:44:10Z",
  "assignee_id": "1",
  "completed_at": "",
  "contact_id": "32",
  "details": "Fred, please complete this task.",
  "due_at": "2018-03-29T16:44:10Z",
  "id": "1",
  "status": "pending",
  "subject": "Do this.",
  "task_message_id": "7"
}
```
