1. Tasks
  2. Get Contact

Tasks

Get Contact

The Get Contact task retrieves a contact from your Org's contacts directory.

The contact's contactuuid is required for this task.

Basic usage

Get the contact details of the person who ran the action with this task.

{
tasktype
:
get_contact
params
:
{
contactuuid
:
~~actioningContact.contactuuid

Parameters

contactuuid
optional
string

The contactuuid of the contact to retrieve from the Org's contacts directory.

Result

{
success
:
true
payload
:
{
contact
:
{
avatar
:
{
link
:
https://ui-avatars.com/api/?name=Abrie%20%40%26%25_(%40%20Cronje&background=53e632&color=fff
type
:
default
basic
:
{
descname
:
John Paul Doe
firstname
:
John
middlenames
:
Paul
lastname
:
Doe
icon_color
:
53e632
parent_of
:
[
0 items  
contactpoints
:
[
4 items  
0
:
{
contact
:
john
type
:
stubberhandle
label
:
stubberhandle
uuid
:
d151b736-08a7-5823-9572-9de75abbcdd9
1
:
{
contact
:
john@myorg.com
type
:
email
label
:
email
uuid
:
e8b6386a-2081-501f-82d2-e69beb38dce2
2
:
{
contact
:
+27712345678
type
:
mobile
label
:
mobile
uuid
:
2c0a21fb-0b67-5e81-881c-e61c921973b9
3
:
{
contact
:
Stubber:someid
type
:
slack
label
:
slack
uuid
:
46b6c5d9-9d1f-52d0-81c1-adc5b4f0c5da
contactuuid
:
3a73f88f-690f-5131-97fb-749aba7c7b90
orguuid
:
aa9f5a3a-bf87-5232-ba44-f66f8ea40b3e
type
:
individual
createdAt
:
2023-02-23T15:27:58.646Z
updatedAt
:
2024-09-04T14:38:55.587Z

Properties

contact
object

The contact that was retrieved.

Show child attributes
avatar
object

The contact's avatar.

Show child attributes

The link to the contact's avatar.

type
string

The type of avatar.

basic
object
Show child attributes
descname
string

A descriptive name for the contact. This is the combination of the contact's first name, middle names, and last name.

firstname
string

The contact's first name.

middlenames
string

The contact's middle names.

lastname
string

The contact's last name.

contactpoints
array of objects
Show child attributes
contact
string

The contact "value" of the contactpoint. This could be an email address, mobile number, or a handle.

type
string

The type of contactpoint. This could be:

  • email
  • stubberhandle
  • mobile
  • slack

etc.

uuid
string

The unique identifier of the contactpoint.

contactuuid
string

The contact's unique identifier.

orguuid
string

The unique identifier of the Org the contact belongs to.

type
string

The type of contact. This could be individual or group.

createdAt
string

The date and time the contact was created.

updatedAt
string

The date and time the contact was last updated.