Redtail CRM

App · 25 actions

Run your advisory practice's Redtail CRM from workflows: find, add and update contacts with their emails, phones and addresses, log notes, schedule and complete activities, track opportunities, start workflows and complete their tasks, and start a workflow when a contact, note, activity, opportunity or workflow changes.

Actions

ActionWhat it does
Add contact addressAdd a postal address to a contact, and make it their primary one if you like.
Add contact emailAdd an email address to a contact, and make it their primary one if you like.
Add contact phoneAdd a phone number to a contact, and make it their primary one if you like.
Add contact to tag groupAdd a contact to one of your tag groups (Redtail's lists of contacts).
Add noteAdd a note to a contact's record, in a category, pinned if you like, and tell a user about it.
Complete activityMark an activity as completed.
Complete workflow taskComplete a task in a workflow, by its name or id.
Create activityPut a task, appointment or call on the calendar, linked to a contact, with attendees.
Create contactAdd a person or business to Redtail CRM, with an email, phone and address, a status, category, source and advisors.
Create householdGroup contacts into a household (Redtail's family): a head of household, a spouse, children and others.
Create opportunityAdd an opportunity for a contact, with its stage, type, source, amount, probability and close date.
Delete recordDelete a contact, activity, opportunity, workflow or household.
Get activityGet one activity with its time, linked contacts and attendees.
Get contactGet one contact with their emails, phones, addresses, household, tag groups and important information.
Get database listRead one of your Redtail database lists (statuses, categories, sources, activity types, opportunity stages and types, advisors, users), or your tag groups or workflow templates, as ids and names.
Get workflowGet one workflow with its steps and every task, done or open.
List activitiesList calendar activities (tasks, appointments and calls) by date, contact, attendee or whether they are done, or the ones changed since a time.
List contact notesList a contact's notes, newest first, as text.
List opportunitiesList opportunities, for one contact or at one stage, with their amount and linked contacts.
List workflowsList open or completed workflows, or one contact's, with their steps and tasks.
Search contactsFind contacts by name, email, phone, status, category, type, tag group or account number, or the ones changed since a time, with their emails, phones and addresses.
Start workflowStart a workflow from one of your templates, for a contact, with a due date and the user it is assigned to.
Update activityChange an activity's subject, type, time, category, description or location.
Update contactChange a contact's name, job title, dates, status, category, source or advisors.
Update opportunityMove an opportunity to another stage, or change its amount, probability, close date or other details.

Add contact address

Add a postal address to a contact, and make it their primary one if you like.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'Search contacts', an earlier step or a trigger. A link to the contact in Redtail works too.
Street addressstreet_addresstextRequired
The street address, such as 1234 Main St.
Address line 2secondary_addresstext
Apartment, suite or unit, if any.
Citycitytext
The city.
Statestatetext
The state, such as CA.
ZIP codezip_codetext
The ZIP or postal code.
Countrycountrytext
The country, such as US. Leave empty for the US.
Address typeaddress_typetext
What kind of address it is.One of: 1 (Home (default)), 2 (Work), 3 (Mailing), 4 (Other). Default: 1.
Make primaryprimarytrue/false
Make it the contact's primary one, in place of the current primary.Default: false.

Outputs

The address added

addressobject
The address added
Example output
{
  "address": {
    "city": "Sacramento",
    "contact_id": 31,
    "country": "US",
    "id": 19,
    "is_primary": false,
    "secondary_address": "",
    "state": "CA",
    "street_address": "3131 Fite Cir.",
    "type": "Home",
    "zip": "95827"
  }
}

Add contact email

Add an email address to a contact, and make it their primary one if you like.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'Search contacts', an earlier step or a trigger. A link to the contact in Redtail works too.
EmailemailtextRequired
The email address to add.
Email typeemail_typetext
What kind of address it is.One of: 1 (Home (default)), 2 (Work), 3 (Other). Default: 1.
Make primaryprimarytrue/false
Make it the contact's primary one, in place of the current primary.Default: false.

Outputs

The email address added

emailobject
The email address added
Example output
{
  "email": {
    "address": "margaret@example.com",
    "contact_id": 31,
    "id": 55558,
    "is_primary": false,
    "type": "Home"
  }
}

Add contact phone

Add a phone number to a contact, and make it their primary one if you like.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'Search contacts', an earlier step or a trigger. A link to the contact in Redtail works too.
PhonephonetextRequired
The number to add, such as (555) 981-5634 or +44 20 7946 0958.
Phone typephone_typetext
What kind of number it is.One of: 3 (Mobile (default)), 1 (Home), 2 (Work), 6 (Direct dial), 4 (Fax), 7 (Toll free), 5 (Other). Default: 3.
Extensionextensiontext
The extension, if any.
Make primaryprimarytrue/false
Make it the contact's primary one, in place of the current primary.Default: false.

Outputs

The phone number added

phoneobject
The phone number added
Example output
{
  "phone": {
    "contact_id": 31,
    "country_code": 1,
    "extension": "",
    "id": 37,
    "is_primary": false,
    "number": "5559815634",
    "type": "Mobile"
  }
}

Add contact to tag group

Add a contact to one of your tag groups (Redtail's lists of contacts).

Inputs

Tag grouptag_grouptextRequired
The tag group. Pick one, or type its id or name.
Contact IDcontact_idtextRequired
The contact's id, from 'Search contacts', an earlier step or a trigger. A link to the contact in Redtail works too.

Outputs

The contact added to the tag group

membershipobject
The contact's place in the tag group
Example output
{
  "membership": {
    "contact_id": 31,
    "id": 13,
    "tag_group_id": 2
  }
}

Add note

Add a note to a contact's record, in a category, pinned if you like, and tell a user about it.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'Search contacts', an earlier step or a trigger. A link to the contact in Redtail works too.
NotenotetextRequired
What to write. Line breaks are kept.
Categorycategorytext
The note's category. Leave empty for General Information.
Pin itpinnedtrue/false
Pin the note to the top of the contact's notes.Default: false.
Notify usernotify_usertext
A user Redtail tells about the note. Pick one, or type the user's id.

Outputs

The new note

noteobject
A note
Example output
{
  "note": {
    "added_by": 280717,
    "body": "Called about the 401k rollover.<br>She&#39;ll send the statements.",
    "category": "General Information",
    "category_id": 2,
    "contact_id": 31,
    "created_at": "2026-10-21T23:32:31.000Z",
    "id": 6,
    "note_type": "Note",
    "pinned": false,
    "text": "Called about the 401k rollover.\nShe'll send the statements.",
    "updated_at": "2026-10-21T23:32:31.000Z"
  }
}

Complete activity

Mark an activity as completed.

Inputs

Activity IDactivity_idtextRequired
The activity's id, from 'List activities', an earlier step or a trigger.

Outputs

The completed activity

activityobject
An activity (a task, appointment or call on the calendar)
Example output
{
  "activity": {
    "activity_type": "Appointment",
    "activity_type_id": 2,
    "added_by": 280717,
    "all_day": false,
    "attendees": [
      {
        "email": "jordan@example.com",
        "guest": false,
        "name": "Jordan Advisor",
        "user_id": 280717
      }
    ],
    "category_id": 2,
    "completed": true,
    "completed_at": "2026-11-03T10:31:00.000-07:00",
    "contacts": [
      {
        "contact_id": 31,
        "name": "Margaret Investor"
      }
    ],
    "created_at": "2026-10-21T11:13:47.000-07:00",
    "description": "Bring the updated plan.",
    "end": "2026-11-03T10:30:00.000-07:00",
    "id": 315,
    "location": "Conference Room 1",
    "private": false,
    "start": "2026-11-03T09:30:00.000-07:00",
    "subject": "Annual review",
    "updated_at": "2026-10-21T11:13:47.000-07:00"
  }
}

Complete workflow task

Complete a task in a workflow, by its name or id. When it is the last task of a step that needs an outcome, the step finishes with the outcome given.

Inputs

Workflow IDworkflowtextRequired
The workflow's id, from 'Start workflow', 'List workflows' or a trigger.
TasktasktextRequired
The task's exact name, such as Send the account forms, or its id from 'Get workflow'.
Outcomeoutcometext
The step's outcome, by name or id, for when this task finishes a step that needs one.
Step notestep_notetext
A note kept with the step when it finishes with an outcome.

Outputs

The task completed

outcometext
The outcome the step finished with, empty when none
step_completedtrue/false
Whether completing it finished its step (with an outcome)
taskobject
A workflow task
was_already_completetrue/false
Whether the task was already complete, so nothing changed
workflow_idnumber
The workflow it is in
Example output
{
  "outcome": "",
  "step_completed": false,
  "task": {
    "assigned_user_id": 280717,
    "completed": true,
    "completion_date": "2026-10-22T18:23:45.000Z",
    "due_date": "",
    "id": 185,
    "name": "Send the account forms",
    "step": "Paperwork",
    "step_id": 94
  },
  "was_already_complete": false,
  "workflow_id": 34
}

Create activity

Put a task, appointment or call on the calendar, linked to a contact, with attendees.

Inputs

SubjectsubjecttextRequired
What it is, such as Annual review.
Activity typeactivity_typetext
Task, Appointment, Phone Call or one of your own types. Pick one, or type its id or name.
Whentimingtext
Whether it is at a set time or lasts all day.One of: timed (At a set time (default)), all_day (All day). Default: timed.
Startstartdate and time
When it starts. Needed unless it lasts all day.Only when When is At a set time (default).
Endenddate and time
When it ends. Leave empty for an hour after the start.Only when When is At a set time (default).
Daydaydate
The day it falls on, for an all-day activity.Only when When is All day.
Contact IDcontact_idtext
The contact it is about.
Attendeesattendeeslist
Users who attend. Pick them, or type user ids.
Categorycategorytext
The category, such as General Information. Pick one, or type its id or name.
Descriptiondescriptiontext
More about it.
Locationlocationtext
Where it is.
Who can see itvisibilitytext
Everyone in the database, just you, or only its attendees.One of: 0 (Everyone (default)), 1 (Just me), 2 (Attendees only). Default: 0.

Outputs

The new activity

activityobject
An activity (a task, appointment or call on the calendar)
Example output
{
  "activity": {
    "activity_type": "Appointment",
    "activity_type_id": 2,
    "added_by": 280717,
    "all_day": false,
    "attendees": [
      {
        "email": "jordan@example.com",
        "guest": false,
        "name": "Jordan Advisor",
        "user_id": 280717
      }
    ],
    "category_id": 2,
    "completed": false,
    "completed_at": "",
    "contacts": [
      {
        "contact_id": 31,
        "name": "Margaret Investor"
      }
    ],
    "created_at": "2026-10-21T11:13:47.000-07:00",
    "description": "Bring the updated plan.",
    "end": "2026-11-03T10:30:00.000-07:00",
    "id": 315,
    "location": "Conference Room 1",
    "private": false,
    "start": "2026-11-03T09:30:00.000-07:00",
    "subject": "Annual review",
    "updated_at": "2026-10-21T11:13:47.000-07:00"
  }
}

Create contact

Add a person or business to Redtail CRM, with an email, phone and address, a status, category, source and advisors.

Inputs

Contact typecontact_typetext
A person, or a business, association, trust or union.One of: Individual (Individual (a person) (default)), Business, Association, Trust, Union. Default: Individual.
First namefirst_nametext
The person's first name.Only when Contact type is Individual (a person) (default).
Middle namemiddle_nametext
The person's middle name.Only when Contact type is Individual (a person) (default).
Last namelast_nametext
The person's last name. Needed for a person, unless a first name is given.Only when Contact type is Individual (a person) (default).
Business namecompany_nametext
The name of the business, trust, association or union. Needed for anything but a person.Only when Contact type is Business, Association, Trust or Union.
Nicknamenicknametext
What the person likes to be called.
Job titlejob_titletext
The contact's job title.
Date of birthdate_of_birthdate
The person's date of birth.Only when Contact type is Individual (a person) (default).
Client sinceclient_sincedate
When they became a client.
Statusstatustext
The contact's status, such as Active Client. Pick one, or type its id or name.
Categorycategorytext
The contact's category, such as A Client. Pick one, or type its id or name.
Sourcesourcetext
Where the contact came from. Pick one, or type its id or name.
Servicing advisorservicing_advisortext
Pick one, or type the advisor's id or name.
Writing advisorwriting_advisortext
Pick one, or type the advisor's id or name.
Emailemailtext
Their email address, made the primary one.
Email typeemail_typetext
What kind of address it is.One of: 1 (Home (default)), 2 (Work), 3 (Other). Default: 1.
Phonephonetext
Their phone number, made the primary one, such as (555) 981-5634 or +44 20 7946 0958.
Phone typephone_typetext
What kind of number it is.One of: 3 (Mobile (default)), 1 (Home), 2 (Work), 6 (Direct dial), 4 (Fax), 7 (Toll free), 5 (Other). Default: 3.
Street addressstreet_addresstext
The street address, such as 1234 Main St.
Address line 2secondary_addresstext
Apartment, suite or unit, if any.
Citycitytext
The city.
Statestatetext
The state, such as CA.
ZIP codezip_codetext
The ZIP or postal code.
Countrycountrytext
The country, such as US. Leave empty for the US.
Address typeaddress_typetext
What kind of address it is.One of: 1 (Home (default)), 2 (Work), 3 (Mailing), 4 (Other). Default: 1.

Outputs

The new contact

contactobject
A contact
Example output
{
  "contact": {
    "addresses": [
      {
        "city": "Sacramento",
        "country": "US",
        "id": 4,
        "is_primary": true,
        "secondary_address": "",
        "state": "CA",
        "street_address": "1234 Main St.",
        "type": "Home",
        "zip": "95814"
      }
    ],
    "category": "AAA Client",
    "category_id": 5,
    "client_since": "2006-05-16",
    "company_name": "",
    "created_at": "2026-10-20T21:38:32.000Z",
    "date_of_birth": "1983-04-12",
    "deleted": false,
    "email": "margaret@example.com",
    "emails": [
      {
        "address": "margaret@example.com",
        "id": 8,
        "is_primary": true,
        "type": "Home"
      }
    ],
    "favorite": false,
    "first_name": "Margaret",
    "id": 31,
    "job_title": "Attorney",
    "last_name": "Investor",
    "link": "https://crm.redtailtechnology.com/contacts/31",
    "middle_name": "",
    "name": "Margaret Investor",
    "nickname": "Mary",
    "phone": "5559815634",
    "phones": [
      {
        "country_code": 1,
        "extension": "",
        "id": 10,
        "is_primary": true,
        "number": "5559815634",
        "type": "Mobile"
      }
    ],
    "servicing_advisor": "Jordan Advisor",
    "servicing_advisor_id": 2,
    "source": "Internet Advertisment",
    "source_id": 2,
    "status": "Active Client",
    "status_id": 2,
    "type": "Individual",
    "updated_at": "2026-10-21T17:01:54.000Z",
    "writing_advisor": "Jordan Advisor",
    "writing_advisor_id": 2
  }
}

Create household

Group contacts into a household (Redtail's family): a head of household, a spouse, children and others.

Inputs

NamenametextRequired
The household's name, such as The Investor Family.
Head of householdhead_contact_idtextRequired
The contact id of the head of household.
Spousespouse_contact_idtext
The spouse's contact id.
Childrenchildren_contact_idslist
The children's contact ids.
Other membersother_contact_idslist
Other members' contact ids.

Outputs

The new household

householdobject
A household (Redtail's family)
Example output
{
  "household": {
    "id": 1,
    "members": [
      {
        "contact_id": 31,
        "head_of_household": true,
        "name": "Margaret Investor",
        "relationship": "Head of household"
      },
      {
        "contact_id": 32,
        "head_of_household": false,
        "name": "",
        "relationship": "Spouse"
      }
    ],
    "name": "The Investor Family"
  }
}

Create opportunity

Add an opportunity for a contact, with its stage, type, source, amount, probability and close date.

Inputs

NamenametextRequired
What it is, such as 401k rollover.
Contact IDcontact_idtext
The contact it is for.
Stagestagetext
The pipeline stage. Pick one, or type its id or name.
Opportunity typeopportunity_typetext
Such as New Business. Pick one, or type its id or name.
Sourcesourcetext
Where it came from. Pick one, or type its id or name.
Amountamountnumber
The amount, such as 200000.At least 0.
Probabilityprobabilitynumber
The chance of winning it, in percent (0 to 100).From 0 to 100.
Close dateclose_datedate
When you expect it to close.
Next stepnext_steptext
What happens next.
Assigned toassigned_totext
The user it is assigned to. Pick one, or type the user's id.
Descriptiondescriptiontext
More about it.

Outputs

The new opportunity

opportunityobject
An opportunity
Example output
{
  "opportunity": {
    "actual_revenue": 0.0,
    "amount": 200000.0,
    "assigned_to": 280717,
    "close_date": "2026-12-15T07:00:00.000Z",
    "contacts": [
      {
        "contact_id": 31,
        "name": "Margaret Investor"
      }
    ],
    "created_at": "2026-10-21T00:08:12.000Z",
    "description": "Rolling over a previous employer's plan.",
    "id": 7,
    "name": "401k rollover",
    "next_step": "Send the transfer forms",
    "opportunity_type": "New Business",
    "opportunity_type_id": 1,
    "probability": 50,
    "projected_revenue": 2000.0,
    "source": "Internet Lead",
    "source_id": 3,
    "stage": "First meeting",
    "stage_id": 11,
    "updated_at": "2026-10-21T00:46:39.000Z"
  }
}

Delete record

Delete a contact, activity, opportunity, workflow or household. There is no undo.

Inputs

Record typerecord_typetextRequired
What kind of record to delete. Check it matches the id.One of: contact, activity, opportunity, workflow, household.
Record IDrecord_idtextRequired
The id of the record to delete.

Outputs

What was deleted

deletedtrue/false
Always true
record_idnumber
Id of the deleted record
record_typetext
contact, activity, opportunity, workflow or household
Example output
{
  "deleted": true,
  "record_id": 31,
  "record_type": "contact"
}

Get activity

Get one activity with its time, linked contacts and attendees.

Inputs

Activity IDactivity_idtextRequired
The activity's id, from 'List activities', an earlier step or a trigger.

Outputs

The activity

activityobject
An activity (a task, appointment or call on the calendar)
Example output
{
  "activity": {
    "activity_type": "Appointment",
    "activity_type_id": 2,
    "added_by": 280717,
    "all_day": false,
    "attendees": [
      {
        "email": "jordan@example.com",
        "guest": false,
        "name": "Jordan Advisor",
        "user_id": 280717
      }
    ],
    "category_id": 2,
    "completed": false,
    "completed_at": "",
    "contacts": [
      {
        "contact_id": 31,
        "name": "Margaret Investor"
      }
    ],
    "created_at": "2026-10-21T11:13:47.000-07:00",
    "description": "Bring the updated plan.",
    "end": "2026-11-03T10:30:00.000-07:00",
    "id": 315,
    "location": "Conference Room 1",
    "private": false,
    "start": "2026-11-03T09:30:00.000-07:00",
    "subject": "Annual review",
    "updated_at": "2026-10-21T11:13:47.000-07:00"
  }
}

Get contact

Get one contact with their emails, phones, addresses, household, tag groups and important information.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'Search contacts', an earlier step or a trigger. A link to the contact in Redtail works too.

Outputs

The contact

contactobject
A contact, with its household, tag groups and important information
Example output
{
  "contact": {
    "addresses": [
      {
        "city": "Sacramento",
        "country": "US",
        "id": 4,
        "is_primary": true,
        "secondary_address": "",
        "state": "CA",
        "street_address": "1234 Main St.",
        "type": "Home",
        "zip": "95814"
      }
    ],
    "category": "AAA Client",
    "category_id": 5,
    "client_since": "2006-05-16",
    "company_name": "",
    "created_at": "2026-10-20T21:38:32.000Z",
    "date_of_birth": "1983-04-12",
    "deleted": false,
    "email": "margaret@example.com",
    "emails": [
      {
        "address": "margaret@example.com",
        "id": 8,
        "is_primary": true,
        "type": "Home"
      }
    ],
    "favorite": false,
    "first_name": "Margaret",
    "household": {
      "id": 1,
      "members": [
        {
          "contact_id": 31,
          "head_of_household": true,
          "name": "Margaret Investor",
          "relationship": "Head of household"
        },
        {
          "contact_id": 32,
          "head_of_household": false,
          "name": "",
          "relationship": "Spouse"
        }
      ],
      "name": "The Investor Family"
    },
    "id": 31,
    "important_information": "She prefers to be called Mary.\nDo not call after 7:00PM",
    "job_title": "Attorney",
    "last_name": "Investor",
    "link": "https://crm.redtailtechnology.com/contacts/31",
    "middle_name": "",
    "name": "Margaret Investor",
    "nickname": "Mary",
    "phone": "5559815634",
    "phones": [
      {
        "country_code": 1,
        "extension": "",
        "id": 10,
        "is_primary": true,
        "number": "5559815634",
        "type": "Mobile"
      }
    ],
    "servicing_advisor": "Jordan Advisor",
    "servicing_advisor_id": 2,
    "source": "Internet Advertisment",
    "source_id": 2,
    "status": "Active Client",
    "status_id": 2,
    "tag_groups": [
      {
        "id": 2,
        "name": "Annual review"
      }
    ],
    "type": "Individual",
    "updated_at": "2026-10-21T17:01:54.000Z",
    "writing_advisor": "Jordan Advisor",
    "writing_advisor_id": 2
  }
}

Get database list

Read one of your Redtail database lists (statuses, categories, sources, activity types, opportunity stages and types, advisors, users), or your tag groups or workflow templates, as ids and names.

Inputs

Listlist_nametextRequired
Which list to read.One of: contact_statuses (Contact statuses), contact_categories (Contact categories), sources (Contact sources), categories (Note, activity and workflow categories), activity_types (Activity types), opportunity_stages (Opportunity stages), opportunity_types (Opportunity types), servicing_advisors (Servicing advisors), writing_advisors (Writing advisors), users (Users (needs a Redtail admin)), tag_groups (Tag groups), workflow_templates (Workflow templates).

Outputs

One of Redtail's database lists

countnumber
How many are returned
list_nametext
Which list was read
valueslist
The list's values
Example output
{
  "count": 1,
  "list_name": "contact_statuses",
  "values": [
    {
      "id": 2,
      "name": "Active Client"
    }
  ]
}

Get workflow

Get one workflow with its steps and every task, done or open.

Inputs

Workflow IDworkflowtextRequired
The workflow's id, from 'Start workflow', 'List workflows' or a trigger.

Outputs

The workflow

workflowobject
A workflow (a process started from a template)
Example output
{
  "workflow": {
    "assigned_user_id": 280717,
    "category": "Technical Support",
    "category_id": 6,
    "completed": false,
    "completion_date": "",
    "contacts": [
      {
        "contact_id": 31,
        "name": "Margaret Investor"
      }
    ],
    "created_at": "2026-10-21T22:30:26.000Z",
    "current_step": "Paperwork",
    "current_step_id": 94,
    "description": "Open the accounts and send the welcome kit.",
    "due_date": "2026-11-30T00:00:00.000Z",
    "id": 34,
    "name": "New client onboarding",
    "open_tasks": 1,
    "steps": [
      {
        "completed": false,
        "completion_date": "",
        "id": 94,
        "name": "Paperwork",
        "position": 1
      }
    ],
    "tasks": [
      {
        "assigned_user_id": 280717,
        "completed": false,
        "completion_date": "",
        "due_date": "",
        "id": 185,
        "name": "Send the account forms",
        "step": "Paperwork",
        "step_id": 94
      }
    ],
    "template_id": "7",
    "updated_at": "2026-10-21T22:30:30.000Z"
  }
}

List activities

List calendar activities (tasks, appointments and calls) by date, contact, attendee or whether they are done, or the ones changed since a time.

Inputs

Fromstart_datedate
Only activities from this day on.
Toend_datedate
Only activities up to this day.
Changed sinceupdated_sincedate and time
Only activities changed after this time.
Contact IDcontact_idtext
Only activities linked to this contact.
Attendeesattendeeslist
Only activities these users attend. Pick them, or type user ids.
Statusstatetext
Open activities, completed ones, or both.One of: all (Open and completed (default)), open (Open only), completed (Completed only). Default: all.
Limitlimitnumber
The most activities to return, up to 1000.From 1 to 1000. Default: 50.

Outputs

The activities found

activitieslist
The activities found
countnumber
How many are returned
totalnumber
How many Redtail CRM has in all
Example output
{
  "activities": [
    {
      "activity_type": "Appointment",
      "activity_type_id": 2,
      "added_by": 280717,
      "all_day": false,
      "attendees": [
        {
          "email": "jordan@example.com",
          "guest": false,
          "name": "Jordan Advisor",
          "user_id": 280717
        }
      ],
      "category_id": 2,
      "completed": false,
      "completed_at": "",
      "contacts": [
        {
          "contact_id": 31,
          "name": "Margaret Investor"
        }
      ],
      "created_at": "2026-10-21T11:13:47.000-07:00",
      "description": "Bring the updated plan.",
      "end": "2026-11-03T10:30:00.000-07:00",
      "id": 315,
      "location": "Conference Room 1",
      "private": false,
      "start": "2026-11-03T09:30:00.000-07:00",
      "subject": "Annual review",
      "updated_at": "2026-10-21T11:13:47.000-07:00"
    }
  ],
  "count": 1,
  "total": 1
}

List contact notes

List a contact's notes, newest first, as text.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'Search contacts', an earlier step or a trigger. A link to the contact in Redtail works too.
Limitlimitnumber
The most notes to return, up to 1000.From 1 to 1000. Default: 50.

Outputs

The contact's notes

countnumber
How many are returned
noteslist
The contact's notes
totalnumber
How many Redtail CRM has in all
Example output
{
  "count": 1,
  "notes": [
    {
      "added_by": 280717,
      "body": "Called about the 401k rollover.<br>She&#39;ll send the statements.",
      "category": "General Information",
      "category_id": 2,
      "contact_id": 31,
      "created_at": "2026-10-21T23:32:31.000Z",
      "id": 6,
      "note_type": "Note",
      "pinned": false,
      "text": "Called about the 401k rollover.\nShe'll send the statements.",
      "updated_at": "2026-10-21T23:32:31.000Z"
    }
  ],
  "total": 1
}

List opportunities

List opportunities, for one contact or at one stage, with their amount and linked contacts.

Inputs

Contact IDcontact_idtext
Only this contact's opportunities.
Stagestagetext
Only opportunities at this stage. Pick one, or type its id or name.
Limitlimitnumber
The most opportunities to return, up to 1000.From 1 to 1000. Default: 50.

Outputs

The opportunities found

countnumber
How many are returned
opportunitieslist
The opportunities found
totalnumber
How many Redtail CRM has in all
Example output
{
  "count": 1,
  "opportunities": [
    {
      "actual_revenue": 0.0,
      "amount": 200000.0,
      "assigned_to": 280717,
      "close_date": "2026-12-15T07:00:00.000Z",
      "contacts": [
        {
          "contact_id": 31,
          "name": "Margaret Investor"
        }
      ],
      "created_at": "2026-10-21T00:08:12.000Z",
      "description": "Rolling over a previous employer's plan.",
      "id": 7,
      "name": "401k rollover",
      "next_step": "Send the transfer forms",
      "opportunity_type": "New Business",
      "opportunity_type_id": 1,
      "probability": 50,
      "projected_revenue": 2000.0,
      "source": "Internet Lead",
      "source_id": 3,
      "stage": "First meeting",
      "stage_id": 11,
      "updated_at": "2026-10-21T00:46:39.000Z"
    }
  ],
  "total": 1
}

List workflows

List open or completed workflows, or one contact's, with their steps and tasks.

Inputs

Statusstatetext
Open workflows, completed ones, or both.One of: open (Open (default)), completed, all (Open and completed). Default: open.
Contact IDcontact_idtext
Only this contact's workflows.
Limitlimitnumber
The most workflows to return, up to 1000.From 1 to 1000. Default: 50.

Outputs

The workflows found

countnumber
How many are returned
totalnumber
How many Redtail CRM has in all
workflowslist
The workflows found
Example output
{
  "count": 1,
  "total": 1,
  "workflows": [
    {
      "assigned_user_id": 280717,
      "category": "Technical Support",
      "category_id": 6,
      "completed": false,
      "completion_date": "",
      "contacts": [
        {
          "contact_id": 31,
          "name": "Margaret Investor"
        }
      ],
      "created_at": "2026-10-21T22:30:26.000Z",
      "current_step": "Paperwork",
      "current_step_id": 94,
      "description": "Open the accounts and send the welcome kit.",
      "due_date": "2026-11-30T00:00:00.000Z",
      "id": 34,
      "name": "New client onboarding",
      "open_tasks": 1,
      "steps": [
        {
          "completed": false,
          "completion_date": "",
          "id": 94,
          "name": "Paperwork",
          "position": 1
        }
      ],
      "tasks": [
        {
          "assigned_user_id": 280717,
          "completed": false,
          "completion_date": "",
          "due_date": "",
          "id": 185,
          "name": "Send the account forms",
          "step": "Paperwork",
          "step_id": 94
        }
      ],
      "template_id": "7",
      "updated_at": "2026-10-21T22:30:30.000Z"
    }
  ]
}

Search contacts

Find contacts by name, email, phone, status, category, type, tag group or account number, or the ones changed since a time, with their emails, phones and addresses.

Inputs

Namenametext
Matches a person's first and last name, or a business's name.
Emailemailtext
Matches an email address.
Phonephonetext
Matches a phone number, however it is written.
Statusesstatuseslist
Only contacts with one of these statuses.
Categoriescategorieslist
Only contacts in one of these categories.
Contact typescontact_typeslist
Only these kinds of contact. Leave empty for every kind.One or more of: Individual (Individual (a person)), Business, Association, Trust, Union.
Tag grouptag_grouptext
Only contacts in this tag group. Pick one, or type its id or name.
Account numberaccount_numbertext
Matches one of the contact's account numbers.
Changed sinceupdated_sincedate and time
Only contacts changed after this time.
Limitlimitnumber
The most contacts to return, up to 1000.From 1 to 1000. Default: 50.

Outputs

The contacts found

contactslist
The contacts found
countnumber
How many are returned
totalnumber
How many Redtail CRM has in all
Example output
{
  "contacts": [
    {
      "addresses": [
        {
          "city": "Sacramento",
          "country": "US",
          "id": 4,
          "is_primary": true,
          "secondary_address": "",
          "state": "CA",
          "street_address": "1234 Main St.",
          "type": "Home",
          "zip": "95814"
        }
      ],
      "category": "AAA Client",
      "category_id": 5,
      "client_since": "2006-05-16",
      "company_name": "",
      "created_at": "2026-10-20T21:38:32.000Z",
      "date_of_birth": "1983-04-12",
      "deleted": false,
      "email": "margaret@example.com",
      "emails": [
        {
          "address": "margaret@example.com",
          "id": 8,
          "is_primary": true,
          "type": "Home"
        }
      ],
      "favorite": false,
      "first_name": "Margaret",
      "id": 31,
      "job_title": "Attorney",
      "last_name": "Investor",
      "link": "https://crm.redtailtechnology.com/contacts/31",
      "middle_name": "",
      "name": "Margaret Investor",
      "nickname": "Mary",
      "phone": "5559815634",
      "phones": [
        {
          "country_code": 1,
          "extension": "",
          "id": 10,
          "is_primary": true,
          "number": "5559815634",
          "type": "Mobile"
        }
      ],
      "servicing_advisor": "Jordan Advisor",
      "servicing_advisor_id": 2,
      "source": "Internet Advertisment",
      "source_id": 2,
      "status": "Active Client",
      "status_id": 2,
      "type": "Individual",
      "updated_at": "2026-10-21T17:01:54.000Z",
      "writing_advisor": "Jordan Advisor",
      "writing_advisor_id": 2
    }
  ],
  "count": 1,
  "total": 1
}

Start workflow

Start a workflow from one of your templates, for a contact, with a due date and the user it is assigned to.

Inputs

TemplatetemplatetextRequired
The workflow template. Pick one, or type its id or name.
Contact IDcontact_idtext
The contact it is for.
Namenametext
Its name. Leave empty for the template's name.
Due datedue_datedate
When it is due.
Assigned toassigned_usertext
The user it is assigned to. Pick one, or type the user's id.
Categorycategorytext
The category, such as General Information. Pick one, or type its id or name.
Descriptiondescriptiontext
More about it.
Skip weekendsskip_weekendstrue/false
Count due dates on weekdays only.Default: false.

Outputs

The new workflow

workflowobject
A workflow (a process started from a template)
Example output
{
  "workflow": {
    "assigned_user_id": 280717,
    "category": "Technical Support",
    "category_id": 6,
    "completed": false,
    "completion_date": "",
    "contacts": [
      {
        "contact_id": 31,
        "name": "Margaret Investor"
      }
    ],
    "created_at": "2026-10-21T22:30:26.000Z",
    "current_step": "Paperwork",
    "current_step_id": 94,
    "description": "Open the accounts and send the welcome kit.",
    "due_date": "2026-11-30T00:00:00.000Z",
    "id": 34,
    "name": "New client onboarding",
    "open_tasks": 1,
    "steps": [
      {
        "completed": false,
        "completion_date": "",
        "id": 94,
        "name": "Paperwork",
        "position": 1
      }
    ],
    "tasks": [
      {
        "assigned_user_id": 280717,
        "completed": false,
        "completion_date": "",
        "due_date": "",
        "id": 185,
        "name": "Send the account forms",
        "step": "Paperwork",
        "step_id": 94
      }
    ],
    "template_id": "7",
    "updated_at": "2026-10-21T22:30:30.000Z"
  }
}

Update activity

Change an activity's subject, type, time, category, description or location. Fields left empty keep their value.

Inputs

Activity IDactivity_idtextRequired
The activity's id, from 'List activities', an earlier step or a trigger.
Subjectsubjecttext
A new subject.
Activity typeactivity_typetext
Task, Appointment, Phone Call or one of your own types. Pick one, or type its id or name.
Whentimingtext
Whether it is at a set time or lasts all day.One of: timed (At a set time (default)), all_day (All day). Default: timed.
Startstartdate and time
A new start. The activity keeps its length unless an end is given too.Only when When is At a set time (default).
Endenddate and time
A new end.Only when When is At a set time (default).
Daydaydate
The day it falls on, for an all-day activity.Only when When is All day.
Categorycategorytext
The category, such as General Information. Pick one, or type its id or name.
Descriptiondescriptiontext
A new description.
Locationlocationtext
A new location.

Outputs

The activity as it is now

activityobject
An activity (a task, appointment or call on the calendar)
Example output
{
  "activity": {
    "activity_type": "Appointment",
    "activity_type_id": 2,
    "added_by": 280717,
    "all_day": false,
    "attendees": [
      {
        "email": "jordan@example.com",
        "guest": false,
        "name": "Jordan Advisor",
        "user_id": 280717
      }
    ],
    "category_id": 2,
    "completed": false,
    "completed_at": "",
    "contacts": [
      {
        "contact_id": 31,
        "name": "Margaret Investor"
      }
    ],
    "created_at": "2026-10-21T11:13:47.000-07:00",
    "description": "Bring the updated plan.",
    "end": "2026-11-03T10:30:00.000-07:00",
    "id": 315,
    "location": "Conference Room 1",
    "private": false,
    "start": "2026-11-03T09:30:00.000-07:00",
    "subject": "Annual review",
    "updated_at": "2026-10-21T11:13:47.000-07:00"
  }
}

Update contact

Change a contact's name, job title, dates, status, category, source or advisors. Fields left empty keep their value.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'Search contacts', an earlier step or a trigger. A link to the contact in Redtail works too.
First namefirst_nametext
The person's first name.
Middle namemiddle_nametext
The person's middle name.
Last namelast_nametext
The person's last name. Needed for a person, unless a first name is given.
Business namecompany_nametext
The name of the business, trust, association or union. Needed for anything but a person.
Nicknamenicknametext
What the person likes to be called.
Job titlejob_titletext
The contact's job title.
Date of birthdate_of_birthdate
The person's date of birth.
Client sinceclient_sincedate
When they became a client.
Statusstatustext
The contact's status, such as Active Client. Pick one, or type its id or name.
Categorycategorytext
The contact's category, such as A Client. Pick one, or type its id or name.
Sourcesourcetext
Where the contact came from. Pick one, or type its id or name.
Servicing advisorservicing_advisortext
Pick one, or type the advisor's id or name.
Writing advisorwriting_advisortext
Pick one, or type the advisor's id or name.

Outputs

The contact as it is now

contactobject
A contact
Example output
{
  "contact": {
    "addresses": [
      {
        "city": "Sacramento",
        "country": "US",
        "id": 4,
        "is_primary": true,
        "secondary_address": "",
        "state": "CA",
        "street_address": "1234 Main St.",
        "type": "Home",
        "zip": "95814"
      }
    ],
    "category": "AAA Client",
    "category_id": 5,
    "client_since": "2006-05-16",
    "company_name": "",
    "created_at": "2026-10-20T21:38:32.000Z",
    "date_of_birth": "1983-04-12",
    "deleted": false,
    "email": "margaret@example.com",
    "emails": [
      {
        "address": "margaret@example.com",
        "id": 8,
        "is_primary": true,
        "type": "Home"
      }
    ],
    "favorite": false,
    "first_name": "Margaret",
    "id": 31,
    "job_title": "Attorney",
    "last_name": "Investor",
    "link": "https://crm.redtailtechnology.com/contacts/31",
    "middle_name": "",
    "name": "Margaret Investor",
    "nickname": "Mary",
    "phone": "5559815634",
    "phones": [
      {
        "country_code": 1,
        "extension": "",
        "id": 10,
        "is_primary": true,
        "number": "5559815634",
        "type": "Mobile"
      }
    ],
    "servicing_advisor": "Jordan Advisor",
    "servicing_advisor_id": 2,
    "source": "Internet Advertisment",
    "source_id": 2,
    "status": "Active Client",
    "status_id": 2,
    "type": "Individual",
    "updated_at": "2026-10-21T17:01:54.000Z",
    "writing_advisor": "Jordan Advisor",
    "writing_advisor_id": 2
  }
}

Update opportunity

Move an opportunity to another stage, or change its amount, probability, close date or other details. Fields left empty keep their value.

Inputs

Opportunity IDopportunity_idtextRequired
The opportunity's id, from 'List opportunities', 'Create opportunity' or a trigger.
Namenametext
A new name.
Stagestagetext
The pipeline stage. Pick one, or type its id or name.
Opportunity typeopportunity_typetext
Such as New Business. Pick one, or type its id or name.
Sourcesourcetext
Where it came from. Pick one, or type its id or name.
Amountamountnumber
The amount, such as 200000.At least 0.
Probabilityprobabilitynumber
The chance of winning it, in percent (0 to 100).From 0 to 100.
Close dateclose_datedate
When you expect it to close.
Next stepnext_steptext
What happens next.
Assigned toassigned_totext
The user it is assigned to. Pick one, or type the user's id.
Descriptiondescriptiontext
More about it.
Contact IDcontact_idtext
Link this contact to it too.

Outputs

The opportunity as it is now

opportunityobject
An opportunity
Example output
{
  "opportunity": {
    "actual_revenue": 0.0,
    "amount": 200000.0,
    "assigned_to": 280717,
    "close_date": "2026-12-15T07:00:00.000Z",
    "contacts": [
      {
        "contact_id": 31,
        "name": "Margaret Investor"
      }
    ],
    "created_at": "2026-10-21T00:08:12.000Z",
    "description": "Rolling over a previous employer's plan.",
    "id": 7,
    "name": "401k rollover",
    "next_step": "Send the transfer forms",
    "opportunity_type": "New Business",
    "opportunity_type_id": 1,
    "probability": 50,
    "projected_revenue": 2000.0,
    "source": "Internet Lead",
    "source_id": 3,
    "stage": "First meeting",
    "stage_id": 11,
    "updated_at": "2026-10-21T00:46:39.000Z"
  }
}

On this page