Assemble Developer Portal

Documentation Powered by ReDoc

Users (3.0)

Download OpenAPI specification:Download

This documentation describes how to retrieve and update information relating to users.

User

User listing

Retrieve a paginated response of users.

The users in the response will be limited by your permissions and position within the organisation hierarchy.

Authorizations:
JWT
query Parameters
q
string
Example: q=John

Search by display name, email, unique custom fields and id

team
string
Example: team=123,421,421

Filter by team id (comma separated list)

teamlist
string

Filter by a team list

userlist
string

Filter by a user list

manager
string
Example: manager=53543,53151,42121

Filter by manager id (comma separated list)

supervisor
string

Filter by supervisor id (comma separated list)

age
string
Enum: "organisation" "senior"

Filter by age

geojson_id
string
Example: geojson_id=65568

Search by a geojson id

lat
number
Example: lat=51.500947

Search by latitude (requires long)

long
number
Example: long=-0.124619

Search by longitude (requires lat)

distance
string
Default: "20"
Example: distance=50

Filter by distance (requires lat and long)

view
string
Enum: "volunteers" "non-volunteers" "applicants" "on-call"

Filter by a specific view (default volunteer and non-volunteer)

sids
string
Example: sids=1,2

Filter by status ids (comma separated list)

roles
string
Example: roles=66554,7786

Filter by role profile ids (comma separated list)

skills
string
Example: skills=45,565,88

Filter by skill ids (comma separated list)

langs
string
Example: langs=654,163,35

Filter by language ids (comma separated list)

has_email
boolean
Example: has_email=true

Filter by users who have an email address

has_logged_in
boolean

Filter by users who have logged into the system

exclude_ids
string
Example: exclude_ids=123,456

Comma separated list of user ids to exclude from the search

include_inactive
boolean
Default: "false"

Determine if inactive users should be included in the search

include_upcoming
boolean
Default: "false"

Determine if users who haven't started their primary role should be included

active_on
string <date>

Filter by users who are starting a role on or before a specific date

logins
string
Enum: "alltime" "recent" "period"

Include login information against the users

logins_only
string
Enum: "alltime" "recent"

Filter by logins only

s
string
Default: "d"
Enum: "a" "d"
Example: s=a

Sort the results

ids
string
Example: ids=123123,65464,423432,87876

Filter by a comma separated list of user ids

include
string
Enum: "roles" "logins" "tasks" "recognitions" "favourites" "permissions" "permissionsDenied" "hasResponsibilities" "skills" "interests" "languages" "addresses" "phoneNumbers" "emergencyContacts" "emailAddresses" "attributes" "supervisors" "recruitmentApplications" "parentalConsent" "barcodes" "files"
Example: include=roles

Available includes for a user (comma separated list)

Responses

Response Schema: application/json
Array of UserBase (object) or User (object)
object

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": 46485,
      • "display_name": "John Smith",
      • "title": "Mr",
      • "profile_photo_url": "http://example.com",
      • "can_manage": true,
      • "role_name": "Volunteer",
      • "team_name": "Kent",
      • "status": {
        • "id": "1",
        • "name": "Active",
        • "contactable": true
        }
      }
    ],
  • "meta": {
    • "pagination": {
      • "total": "string",
      • "count": "string",
      • "per_page": "string",
      • "current_page": "string",
      • "total_pages": "string",
      • "links": {
        • "next": "string",
        • "previous": "string"
        }
      }
    }
}

Create new user

Create a new user

Authorizations:
JWT
Request Body schema: application/json
first_name
required
string

The users first name

last_name
required
string

The users last name

dob
string

The users date of birth (required if confirm_age is not present)

password
string^(?=.*[a-z])(?=.*[A-Z])(?=.*\d).+$
required
Array of objects
Array of objects
Array of objects
send_password_reset_email
boolean

Determine if we should send the password reset email to the user

attributes
object

User custom fields

confirm_age
boolean

Determine if the users age has been confirmed (if dob is not present)

Responses

Response Schema: application/json
id
integer

The users unique identifier

display_name
string

Users preferred display name

title
string

Title of the user

profile_photo_url
string <uri>

Profile photo URL (signed url)

can_manage
boolean

Determine if the authenticated user can manage this user

role_name
string Nullable

The name of the users primary role

team_name
string Nullable

The teams name of the users primary role

object
about_me
string Nullable

The users bio

facebook
string Nullable

Facebook name

twitter
string Nullable

Twitter name

website
string <uri> Nullable

The users website link

on_hold
string
Enum: "with-contact" "without-contact" "access-suspended"

On hold status

appear_in_directory
boolean

Determines if the user appears in the directory

appear_in_near_me
boolean

Determines if the user appears on the "near me" map

is_volunteer
boolean

Determine if the user has a volunteer role

is_non_volunteer
boolean

Determine if the user has a non-volunteer role

is_system
boolean

Determine if the user is a system user

anonymised
string <date-time> Nullable

The date/time the user was anonymised

volunteer_for
string

The amount of time the user has been a volunteer

on_call
boolean

Determine if the volunteer is on call

on_call_end
string <date-time> Nullable

The date and time the users is no longer on call

first_name
string

Users first name

last_name
string

Users last name

username
string

The users username

dob
string <date>

The users date of birth

preferred_name
string

The users preferred name

on_hold_start
string Nullable
on_hold_end
string
is_minor
boolean

Determine if the user is a minor

start_date
string <date>

The users start date

2fa_enabled
boolean
2fa_disabled
boolean
internal_email
string

The users internal email address

flags
object

User flags

accessibility_info
string

The users accessibility and special requirements

Request samples

Content type
application/json
{
  • "first_name": "John",
  • "last_name": "Smith",
  • "dob": "1995-06-26",
  • "password": "SpaceApolloRocket1969",
  • "roleProfiles": [
    • {
      • "id": 65423,
      • "team": {
        • "id": 12321
        },
      • "manager": {
        • "id": 5325
        },
      • "start": "2005-05-05",
      • "end": "string",
      • "custom_title": "string"
      }
    ],
  • "phoneNumbers": [
    • {
      • "phone_number": "string",
      • "primary": true,
      • "type": "string"
      }
    ],
  • "emailAddresses": [
    • {
      • "email": "string",
      • "primary": true
      }
    ],
  • "send_password_reset_email": true,
  • "attributes": { },
  • "confirm_age": true
}

Response samples

Content type
application/json
{
  • "id": 46485,
  • "display_name": "John Smith",
  • "title": "Mr",
  • "profile_photo_url": "http://example.com",
  • "can_manage": true,
  • "role_name": "Volunteer",
  • "team_name": "Kent",
  • "status": {
    • "id": "1",
    • "name": "Active",
    • "contactable": true
    },
  • "about_me": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Laoreet suspendisse interdum consectetur libero id faucibus nisl tincidunt eget.",
  • "facebook": "john.smith",
  • "twitter": "john.smith",
  • "website": "https://www.google.com/",
  • "on_hold": "with-contact",
  • "appear_in_directory": true,
  • "appear_in_near_me": true,
  • "is_volunteer": true,
  • "is_non_volunteer": true,
  • "is_system": true,
  • "anonymised": null,
  • "volunteer_for": "2 years",
  • "on_call": true,
  • "on_call_end": "2019-08-24T14:15:22Z",
  • "first_name": "John",
  • "last_name": "Smith",
  • "username": "john.smith",
  • "dob": "1985-01-01",
  • "preferred_name": "string",
  • "on_hold_start": "string",
  • "on_hold_end": "string",
  • "is_minor": true,
  • "start_date": "2020-01-01",
  • "2fa_enabled": true,
  • "2fa_disabled": true,
  • "internal_email": "string",
  • "flags": { },
  • "accessibility_info": "string"
}

Show existing user

Retrieve detailed information for a specific user

Authorizations:
JWT
path Parameters
userId
required
string
Example: 234523

Users ID

query Parameters
include
string
Enum: "roles" "logins" "tasks" "recognitions" "favourites" "permissions" "permissionsDenied" "hasResponsibilities" "skills" "interests" "languages" "addresses" "phoneNumbers" "emergencyContacts" "emailAddresses" "attributes" "supervisors" "recruitmentApplications" "parentalConsent" "barcodes" "files"
Example: include=roles

Available includes for a user (comma separated list)

Responses

Response Schema: application/json
id
integer

The users unique identifier

display_name
string

Users preferred display name

title
string

Title of the user

profile_photo_url
string <uri>

Profile photo URL (signed url)

can_manage
boolean

Determine if the authenticated user can manage this user

role_name
string Nullable

The name of the users primary role

team_name
string Nullable

The teams name of the users primary role

object
about_me
string Nullable

The users bio

facebook
string Nullable

Facebook name

twitter
string Nullable

Twitter name

website
string <uri> Nullable

The users website link

on_hold
string
Enum: "with-contact" "without-contact" "access-suspended"

On hold status

appear_in_directory
boolean

Determines if the user appears in the directory

appear_in_near_me
boolean

Determines if the user appears on the "near me" map

is_volunteer
boolean

Determine if the user has a volunteer role

is_non_volunteer
boolean

Determine if the user has a non-volunteer role

is_system
boolean

Determine if the user is a system user

anonymised
string <date-time> Nullable

The date/time the user was anonymised

volunteer_for
string

The amount of time the user has been a volunteer

on_call
boolean

Determine if the volunteer is on call

on_call_end
string <date-time> Nullable

The date and time the users is no longer on call

first_name
string

Users first name

last_name
string

Users last name

username
string

The users username

dob
string <date>

The users date of birth

preferred_name
string

The users preferred name

on_hold_start
string Nullable
on_hold_end
string
is_minor
boolean

Determine if the user is a minor

start_date
string <date>

The users start date

2fa_enabled
boolean
2fa_disabled
boolean
internal_email
string

The users internal email address

flags
object

User flags

accessibility_info
string

The users accessibility and special requirements

Response samples

Content type
application/json
{
  • "id": 46485,
  • "display_name": "John Smith",
  • "title": "Mr",
  • "profile_photo_url": "http://example.com",
  • "can_manage": true,
  • "role_name": "Volunteer",
  • "team_name": "Kent",
  • "status": {
    • "id": "1",
    • "name": "Active",
    • "contactable": true
    },
  • "about_me": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Laoreet suspendisse interdum consectetur libero id faucibus nisl tincidunt eget.",
  • "facebook": "john.smith",
  • "twitter": "john.smith",
  • "website": "https://www.google.com/",
  • "on_hold": "with-contact",
  • "appear_in_directory": true,
  • "appear_in_near_me": true,
  • "is_volunteer": true,
  • "is_non_volunteer": true,
  • "is_system": true,
  • "anonymised": null,
  • "volunteer_for": "2 years",
  • "on_call": true,
  • "on_call_end": "2019-08-24T14:15:22Z",
  • "first_name": "John",
  • "last_name": "Smith",
  • "username": "john.smith",
  • "dob": "1985-01-01",
  • "preferred_name": "string",
  • "on_hold_start": "string",
  • "on_hold_end": "string",
  • "is_minor": true,
  • "start_date": "2020-01-01",
  • "2fa_enabled": true,
  • "2fa_disabled": true,
  • "internal_email": "string",
  • "flags": { },
  • "accessibility_info": "string"
}

Update a user

Update an existings users information

Authorizations:
JWT
path Parameters
userId
required
string
Example: 234523

Users ID

Request Body schema: application/json
title
string

Title of the user

can_manage
boolean

Determine if the authenticated user can manage this user

object
about_me
string Nullable

The users bio

facebook
string Nullable

Facebook name

twitter
string Nullable

Twitter name

website
string <uri> Nullable

The users website link

appear_in_directory
boolean

Determines if the user appears in the directory

appear_in_near_me
boolean

Determines if the user appears on the "near me" map

on_call
boolean

Determine if the volunteer is on call

on_call_end
string <date-time> Nullable

The date and time the users is no longer on call

first_name
string

Users first name

last_name
string

Users last name

dob
string <date>

The users date of birth

preferred_name
string

The users preferred name

on_hold_start
string Nullable
on_hold_end
string
start_date
string <date>

The users start date

2fa_disabled
boolean
accessibility_info
string

The users accessibility and special requirements

object

User attributes (custom fields)

Responses

Response Schema: application/json
id
integer

The users unique identifier

display_name
string

Users preferred display name

title
string

Title of the user

profile_photo_url
string <uri>

Profile photo URL (signed url)

can_manage
boolean

Determine if the authenticated user can manage this user

role_name
string Nullable

The name of the users primary role

team_name
string Nullable

The teams name of the users primary role

object
about_me
string Nullable

The users bio

facebook
string Nullable

Facebook name

twitter
string Nullable

Twitter name

website
string <uri> Nullable

The users website link

on_hold
string
Enum: "with-contact" "without-contact" "access-suspended"

On hold status

appear_in_directory
boolean

Determines if the user appears in the directory

appear_in_near_me
boolean

Determines if the user appears on the "near me" map

is_volunteer
boolean

Determine if the user has a volunteer role

is_non_volunteer
boolean

Determine if the user has a non-volunteer role

is_system
boolean

Determine if the user is a system user

anonymised
string <date-time> Nullable

The date/time the user was anonymised

volunteer_for
string

The amount of time the user has been a volunteer

on_call
boolean

Determine if the volunteer is on call

on_call_end
string <date-time> Nullable

The date and time the users is no longer on call

first_name
string

Users first name

last_name
string

Users last name

username
string

The users username

dob
string <date>

The users date of birth

preferred_name
string

The users preferred name

on_hold_start
string Nullable
on_hold_end
string
is_minor
boolean

Determine if the user is a minor

start_date
string <date>

The users start date

2fa_enabled
boolean
2fa_disabled
boolean
internal_email
string

The users internal email address

flags
object

User flags

accessibility_info
string

The users accessibility and special requirements

Request samples

Content type
application/json
{
  • "title": "Mr",
  • "can_manage": true,
  • "status": { },
  • "about_me": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Laoreet suspendisse interdum consectetur libero id faucibus nisl tincidunt eget.",
  • "facebook": "john.smith",
  • "twitter": "john.smith",
  • "website": "https://www.google.com/",
  • "appear_in_directory": true,
  • "appear_in_near_me": true,
  • "on_call": true,
  • "on_call_end": "2019-08-24T14:15:22Z",
  • "first_name": "John",
  • "last_name": "Smith",
  • "dob": "1985-01-01",
  • "preferred_name": "string",
  • "on_hold_start": "string",
  • "on_hold_end": "string",
  • "start_date": "2020-01-01",
  • "2fa_disabled": true,
  • "accessibility_info": "string",
  • "attributes": {
    • "example-custom-field-text": {
      • "value": "string"
      },
    • "example-custom-field-dropdown": {
      • "value": "string"
      }
    }
}

Response samples

Content type
application/json
{
  • "id": 46485,
  • "display_name": "John Smith",
  • "title": "Mr",
  • "profile_photo_url": "http://example.com",
  • "can_manage": true,
  • "role_name": "Volunteer",
  • "team_name": "Kent",
  • "status": {
    • "id": "1",
    • "name": "Active",
    • "contactable": true
    },
  • "about_me": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Laoreet suspendisse interdum consectetur libero id faucibus nisl tincidunt eget.",
  • "facebook": "john.smith",
  • "twitter": "john.smith",
  • "website": "https://www.google.com/",
  • "on_hold": "with-contact",
  • "appear_in_directory": true,
  • "appear_in_near_me": true,
  • "is_volunteer": true,
  • "is_non_volunteer": true,
  • "is_system": true,
  • "anonymised": null,
  • "volunteer_for": "2 years",
  • "on_call": true,
  • "on_call_end": "2019-08-24T14:15:22Z",
  • "first_name": "John",
  • "last_name": "Smith",
  • "username": "john.smith",
  • "dob": "1985-01-01",
  • "preferred_name": "string",
  • "on_hold_start": "string",
  • "on_hold_end": "string",
  • "is_minor": true,
  • "start_date": "2020-01-01",
  • "2fa_enabled": true,
  • "2fa_disabled": true,
  • "internal_email": "string",
  • "flags": { },
  • "accessibility_info": "string"
}

User Roles

A user can be associated with many roles. Their role will determine a lot about them such as their type (i.e volunteer or non-volunteer), permission group and training.

A role association will also contain extra information about their role such as the start date, manager, team and custom title.

User role associations listing

Retrieve a paginated response of role associations

Authorizations:
JWT
path Parameters
userId
required
string

User ID

Responses

Response Schema: application/json
Array of objects (UserRoleAssociation)
object

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": 3253,
      • "name": "Volunteer v1",
      • "display_name": "Volunteer",
      • "primary": true,
      • "team": {
        • "id": "3521",
        • "display_name": "Headquarters",
        • "parent_id": 0,
        • "name": "string",
        • "description": "string",
        • "geo_location": "string",
        • "catchment_area_id": "string",
        • "icon": "string",
        • "show_on_public_site": true,
        • "ceiling_enabled": true,
        • "public_url": "http://example.com",
        • "hidden": true,
        • "disabled": true,
        • "external_reference": "string"
        },
      • "type": "volunteer",
      • "leaving_form_required": true,
      • "review_submitted_at": "2019-08-24T14:15:22Z",
      • "left_org": true,
      • "would_you_like_to_have_back": true,
      • "would_you_recommend_to_organisation": true,
      • "reference": "string",
      • "leaving_reason": {
        • "id": 242,
        • "reason": "Volunteer role ended",
        • "volunteer_selectable": true
        },
      • "feedback": "string",
      • "recommend_organisation": true,
      • "custom_title": "Volunteer Champion",
      • "start": "2020-01-06",
      • "end": "string",
      • "risks_pdf": "http://example.com",
      • "role_pdf": "http://example.com",
      • "manager": {
        • "id": 46485,
        • "display_name": "John Smith",
        • "title": "Mr",
        • "profile_photo_url": "http://example.com",
        • "can_manage": true,
        • "role_name": "Volunteer",
        • "team_name": "Kent",
        • "status": {
          • "id": "1",
          • "name": "Active",
          • "contactable": true
          }
        },
      • "vetting": {
        • "id": 0
        },
      • "recruitment_category": {
        • "id": 12412,
        • "name": "Full",
        • "stages": [
          • {
            • "id": 21412,
            • "name": "Application",
            • "display_name": "Applied",
            • "actions": [
              • {
                • "id": 421421,
                • "name": "string",
                • "action_stage_id": 0,
                • "settings": { }
                }
              ]
            }
          ]
        },
      • "permission_group": {
        • "id": 0,
        • "name": "string",
        • "description": "string"
        }
      }
    ],
  • "meta": {
    • "pagination": {
      • "total": "string",
      • "count": "string",
      • "per_page": "string",
      • "current_page": "string",
      • "total_pages": "string",
      • "links": {
        • "next": "string",
        • "previous": "string"
        }
      }
    }
}

Associate a role with a user

Associate an existing role profile with a user

Authorizations:
JWT
path Parameters
userId
required
string

User ID

Request Body schema: application/json
object
object
object
start
string <date>

Role start date

end
string <date> Nullable

Role end date

primary
boolean

Determine if this role is the users primary role

custom_title
string

Role custom title

Responses

Response Schema:
application/json
application/json
application/xml
object (UserRoleAssociation)

Request samples

Content type
application/json
{
  • "role": {
    • "id": 241
    },
  • "team": {
    • "id": 45541
    },
  • "manager": {
    • "id": 222432
    },
  • "start": "2020-01-01",
  • "end": "2019-08-24",
  • "primary": true,
  • "custom_title": "Volunteer Champion"
}

Response samples

Content type
application/json
application/json
application/xml
{
  • "data": {
    • "id": 3253,
    • "name": "Volunteer v1",
    • "display_name": "Volunteer",
    • "primary": true,
    • "team": {
      • "id": "3521",
      • "display_name": "Headquarters",
      • "parent_id": 0,
      • "name": "string",
      • "description": "string",
      • "geo_location": "string",
      • "catchment_area_id": "string",
      • "icon": "string",
      • "show_on_public_site": true,
      • "ceiling_enabled": true,
      • "public_url": "http://example.com",
      • "hidden": true,
      • "disabled": true,
      • "external_reference": "string"
      },
    • "type": "volunteer",
    • "leaving_form_required": true,
    • "review_submitted_at": "2019-08-24T14:15:22Z",
    • "left_org": true,
    • "would_you_like_to_have_back": true,
    • "would_you_recommend_to_organisation": true,
    • "reference": "string",
    • "leaving_reason": {
      • "id": 242,
      • "reason": "Volunteer role ended",
      • "volunteer_selectable": true
      },
    • "feedback": "string",
    • "recommend_organisation": true,
    • "custom_title": "Volunteer Champion",
    • "start": "2020-01-06",
    • "end": "string",
    • "risks_pdf": "http://example.com",
    • "role_pdf": "http://example.com",
    • "manager": {
      • "id": 46485,
      • "display_name": "John Smith",
      • "title": "Mr",
      • "profile_photo_url": "http://example.com",
      • "can_manage": true,
      • "role_name": "Volunteer",
      • "team_name": "Kent",
      • "status": {
        • "id": "1",
        • "name": "Active",
        • "contactable": true
        }
      },
    • "vetting": {
      • "id": 0
      },
    • "recruitment_category": {
      • "id": 12412,
      • "name": "Full",
      • "stages": [
        • {
          • "id": 21412,
          • "name": "Application",
          • "display_name": "Applied",
          • "actions": [
            • {
              • "id": 421421,
              • "name": "string",
              • "action_stage_id": 0,
              • "settings": { }
              }
            ]
          }
        ]
      },
    • "permission_group": {
      • "id": 0,
      • "name": "string",
      • "description": "string"
      }
    }
}

Update a users role association

Update a users role association

Authorizations:
JWT
path Parameters
userId
required
string

User ID

associationId
required
string

Role association ID

Request Body schema: application/json
object
feedback
string
recommend_organisation
integer
notify_manager
boolean
unsuitable
boolean
object
primary
integer

Determine if this is the users primary role

object
start
string

Role start date

end
string

Role end date

object
custom_title
string

Role custom title

Responses

Response Schema: application/json
object (UserRoleAssociation)

Request samples

Content type
application/json
{
  • "leaving_reason": {
    • "id": 0
    },
  • "feedback": "string",
  • "recommend_organisation": 0,
  • "notify_manager": true,
  • "unsuitable": true,
  • "vetting": {
    • "id": 0
    },
  • "primary": 0,
  • "team": {
    • "id": 0
    },
  • "start": "string",
  • "end": "string",
  • "manager": {
    • "id": 0
    },
  • "custom_title": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 3253,
    • "name": "Volunteer v1",
    • "display_name": "Volunteer",
    • "primary": true,
    • "team": {
      • "id": "3521",
      • "display_name": "Headquarters",
      • "parent_id": 0,
      • "name": "string",
      • "description": "string",
      • "geo_location": "string",
      • "catchment_area_id": "string",
      • "icon": "string",
      • "show_on_public_site": true,
      • "ceiling_enabled": true,
      • "public_url": "http://example.com",
      • "hidden": true,
      • "disabled": true,
      • "external_reference": "string"
      },
    • "type": "volunteer",
    • "leaving_form_required": true,
    • "review_submitted_at": "2019-08-24T14:15:22Z",
    • "left_org": true,
    • "would_you_like_to_have_back": true,
    • "would_you_recommend_to_organisation": true,
    • "reference": "string",
    • "leaving_reason": {
      • "id": 242,
      • "reason": "Volunteer role ended",
      • "volunteer_selectable": true
      },
    • "feedback": "string",
    • "recommend_organisation": true,
    • "custom_title": "Volunteer Champion",
    • "start": "2020-01-06",
    • "end": "string",
    • "risks_pdf": "http://example.com",
    • "role_pdf": "http://example.com",
    • "manager": {
      • "id": 46485,
      • "display_name": "John Smith",
      • "title": "Mr",
      • "profile_photo_url": "http://example.com",
      • "can_manage": true,
      • "role_name": "Volunteer",
      • "team_name": "Kent",
      • "status": {
        • "id": "1",
        • "name": "Active",
        • "contactable": true
        }
      },
    • "vetting": {
      • "id": 0
      },
    • "recruitment_category": {
      • "id": 12412,
      • "name": "Full",
      • "stages": [
        • {
          • "id": 21412,
          • "name": "Application",
          • "display_name": "Applied",
          • "actions": [
            • {
              • "id": 421421,
              • "name": "string",
              • "action_stage_id": 0,
              • "settings": { }
              }
            ]
          }
        ]
      },
    • "permission_group": {
      • "id": 0,
      • "name": "string",
      • "description": "string"
      }
    }
}

Delete a users role association

Delete a users role association.

You cannot delete the last role assocation from a user.

Authorizations:
JWT
path Parameters
userId
required
string

User ID

associationId
required
string

Role association ID

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthorized action",
  • "status_code": "403"
}

User Email Addresses

User email address listing

Retrieve a paginated response of user email addresses

Authorizations:
JWT
path Parameters
userId
required
string

User ID

Responses

Response Schema: application/json
Array of objects (UserEmailAddress)
object

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": 534,
      • "user_id": 435,
      • "primary": true,
      • "email": "john.smith@example.com",
      • "soft_bounces": 0,
      • "hard_bounces": 0,
      • "complaints": 0,
      • "created_at": "2019-08-24T14:15:22Z",
      • "updated_at": "2019-08-24T14:15:22Z"
      }
    ],
  • "meta": {
    • "pagination": {
      • "total": "string",
      • "count": "string",
      • "per_page": "string",
      • "current_page": "string",
      • "total_pages": "string",
      • "links": {
        • "next": "string",
        • "previous": "string"
        }
      }
    }
}

Create a new user email address

Create a new email address for a user

Authorizations:
JWT
path Parameters
userId
required
string

User ID

Request Body schema: application/json
id
integer

User email address unique id

primary
required
boolean

Determine if this is the users primary email address

email
required
string

The email address

soft_bounces
integer
Default: 0

Amount of times this email has soft bounced

hard_bounces
integer
Default: 0

Amount of times this email has hard bounced

complaints
integer
Default: 0

Amount of times this email has complained

Responses

Response Schema: application/json
object (UserEmailAddress)

Request samples

Content type
application/json
{
  • "id": 534,
  • "primary": true,
  • "email": "john.smith@example.com",
  • "soft_bounces": 0,
  • "hard_bounces": 0,
  • "complaints": 0
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 534,
    • "user_id": 435,
    • "primary": true,
    • "email": "john.smith@example.com",
    • "soft_bounces": 0,
    • "hard_bounces": 0,
    • "complaints": 0,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    }
}

Show a user email address

Retrieve a specific user email address information

Authorizations:
JWT
path Parameters
userId
required
string

User ID

addressId
required
string

Email address ID

Responses

Response Schema: application/json
object (UserEmailAddress)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 534,
    • "user_id": 435,
    • "primary": true,
    • "email": "john.smith@example.com",
    • "soft_bounces": 0,
    • "hard_bounces": 0,
    • "complaints": 0,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    }
}

Update a users email address

Update a specific email address

Authorizations:
JWT
path Parameters
userId
required
string

User ID

addressId
required
string

Email address ID

Request Body schema: application/json
id
integer

User email address unique id

primary
required
boolean

Determine if this is the users primary email address

email
required
string

The email address

soft_bounces
integer
Default: 0

Amount of times this email has soft bounced

hard_bounces
integer
Default: 0

Amount of times this email has hard bounced

complaints
integer
Default: 0

Amount of times this email has complained

Responses

Response Schema: application/json
object (UserEmailAddress)

Request samples

Content type
application/json
{
  • "id": 534,
  • "primary": true,
  • "email": "john.smith@example.com",
  • "soft_bounces": 0,
  • "hard_bounces": 0,
  • "complaints": 0
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 534,
    • "user_id": 435,
    • "primary": true,
    • "email": "john.smith@example.com",
    • "soft_bounces": 0,
    • "hard_bounces": 0,
    • "complaints": 0,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    }
}

Delete a users email address

Delete a users email address.

You cannot delete a primary email address.

Authorizations:
JWT
path Parameters
userId
required
string

User ID

addressId
required
string

Email address ID

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthorized action",
  • "status_code": "403"
}

User Addresses

User postal addresses listing

Retrieve a paginated response of postal addresses

Authorizations:
JWT
path Parameters
userId
required
string
query Parameters
primary
boolean

Filter by primary address

trashed
boolean

Include deleted addresses

Responses

Response Schema: application/json
Array of objects (UserAddress)
object

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": 353,
      • "user_id": "32532",
      • "type": "Work",
      • "primary": true,
      • "from_date": "2019-08-24",
      • "company_name": "string",
      • "street": "11 Downing St",
      • "street_second": "string",
      • "street_third": "string",
      • "city": "London",
      • "county": "Westminster",
      • "postcode": "SW1A 2AB",
      • "country": "United Kingdom",
      • "address": "11 Downing St, Westminster, London SW1A 2AB",
      • "lat": 51.503274,
      • "long": -0.127822,
      • "created_at": "string",
      • "updated_at": "string"
      }
    ],
  • "meta": {
    • "pagination": {
      • "total": "string",
      • "count": "string",
      • "per_page": "string",
      • "current_page": "string",
      • "total_pages": "string",
      • "links": {
        • "next": "string",
        • "previous": "string"
        }
      }
    }
}

Create a new postal address

Create a new postal address for a user

Authorizations:
JWT
path Parameters
userId
required
string
Request Body schema: application/json
type
required
string
Enum: "Home" "Work" "Other" "Additional address"
primary
required
boolean

Determine if this address is the users primary address

from_date
string <date> Nullable

The date the user started living at this address

company_name
string
street
required
string

Address line 1

street_second
string

Address line 2

street_third
string

Address line 3

city
required
string

Address city

county
string

Address county

postcode
required
string

Address postcode

country
required
string

Address country

address
string

Full address details

lat
number

Latitude

long
number

Longitude

created_at
string
updated_at
string

Responses

Response Schema: application/json
object (UserAddress)

Request samples

Content type
application/json
{
  • "type": "Work",
  • "primary": true,
  • "from_date": "2019-08-24",
  • "company_name": "string",
  • "street": "11 Downing St",
  • "street_second": "string",
  • "street_third": "string",
  • "city": "London",
  • "county": "Westminster",
  • "postcode": "SW1A 2AB",
  • "country": "United Kingdom",
  • "address": "11 Downing St, Westminster, London SW1A 2AB",
  • "lat": 51.503274,
  • "long": -0.127822,
  • "created_at": "string",
  • "updated_at": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 353,
    • "user_id": "32532",
    • "type": "Work",
    • "primary": true,
    • "from_date": "2019-08-24",
    • "company_name": "string",
    • "street": "11 Downing St",
    • "street_second": "string",
    • "street_third": "string",
    • "city": "London",
    • "county": "Westminster",
    • "postcode": "SW1A 2AB",
    • "country": "United Kingdom",
    • "address": "11 Downing St, Westminster, London SW1A 2AB",
    • "lat": 51.503274,
    • "long": -0.127822,
    • "created_at": "string",
    • "updated_at": "string"
    }
}

Show a users postal address

Retrieve a specific postal address information

Authorizations:
JWT
path Parameters
userId
required
string

User ID

postalAddressId
required
string

Postal address ID

Responses

Response Schema: application/json
object (UserAddress)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 353,
    • "user_id": "32532",
    • "type": "Work",
    • "primary": true,
    • "from_date": "2019-08-24",
    • "company_name": "string",
    • "street": "11 Downing St",
    • "street_second": "string",
    • "street_third": "string",
    • "city": "London",
    • "county": "Westminster",
    • "postcode": "SW1A 2AB",
    • "country": "United Kingdom",
    • "address": "11 Downing St, Westminster, London SW1A 2AB",
    • "lat": 51.503274,
    • "long": -0.127822,
    • "created_at": "string",
    • "updated_at": "string"
    }
}

Update a postal address

Update an existing postal address information

Authorizations:
JWT
path Parameters
userId
required
string

User ID

postalAddressId
required
string

Postal address ID

Request Body schema: application/json
type
required
string
Enum: "Home" "Work" "Other" "Additional address"
primary
required
boolean

Determine if this address is the users primary address

from_date
string <date> Nullable

The date the user started living at this address

company_name
string
street
required
string

Address line 1

street_second
string

Address line 2

street_third
string

Address line 3

city
required
string

Address city

county
string

Address county

postcode
required
string

Address postcode

country
required
string

Address country

address
string

Full address details

lat
number

Latitude

long
number

Longitude

created_at
string
updated_at
string

Responses

Response Schema: application/json
object (UserAddress)

Request samples

Content type
application/json
{
  • "type": "Work",
  • "primary": true,
  • "from_date": "2019-08-24",
  • "company_name": "string",
  • "street": "11 Downing St",
  • "street_second": "string",
  • "street_third": "string",
  • "city": "London",
  • "county": "Westminster",
  • "postcode": "SW1A 2AB",
  • "country": "United Kingdom",
  • "address": "11 Downing St, Westminster, London SW1A 2AB",
  • "lat": 51.503274,
  • "long": -0.127822,
  • "created_at": "string",
  • "updated_at": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 353,
    • "user_id": "32532",
    • "type": "Work",
    • "primary": true,
    • "from_date": "2019-08-24",
    • "company_name": "string",
    • "street": "11 Downing St",
    • "street_second": "string",
    • "street_third": "string",
    • "city": "London",
    • "county": "Westminster",
    • "postcode": "SW1A 2AB",
    • "country": "United Kingdom",
    • "address": "11 Downing St, Westminster, London SW1A 2AB",
    • "lat": 51.503274,
    • "long": -0.127822,
    • "created_at": "string",
    • "updated_at": "string"
    }
}

Delete a postal address

Delete a postal address.

You cannot delete a primary postal address.

Authorizations:
JWT
path Parameters
userId
required
string

User ID

postalAddressId
required
string

Postal address ID

Responses

Response samples

Content type
application/json
{
  • "message": "404 Not found",
  • "status_code": "404"
}

User Emergency Contacts

User emergency contacts listing

Retrieve a paginated response of user emergency contacts

Authorizations:
JWT
path Parameters
userId
required
string
query Parameters
primary
boolean

Filter by primary emergency contact

Responses

Response Schema: application/json
Array of objects (UserEmergencyContact)
object

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": 3213,
      • "user_id": 53252,
      • "first_name": "John",
      • "last_name": "Smith",
      • "contact_number": "+447700900077",
      • "relationship": "Husband",
      • "primary": true
      }
    ],
  • "meta": {
    • "pagination": {
      • "total": "string",
      • "count": "string",
      • "per_page": "string",
      • "current_page": "string",
      • "total_pages": "string",
      • "links": {
        • "next": "string",
        • "previous": "string"
        }
      }
    }
}

Create a new emergency contact

Create a new emergency contact for a user

Authorizations:
JWT
path Parameters
userId
required
string
Request Body schema: application/json
first_name
required
string

Emergency contact first name

last_name
required
string

Emergency contact last name

contact_number
required
string

Emergency contact phone number

relationship
required
string

Emergency contact relationship

primary
required
boolean

Determine if this is the users primary emergency contact

Responses

Response Schema: application/json
object (UserEmergencyContact)

Request samples

Content type
application/json
{
  • "first_name": "John",
  • "last_name": "Smith",
  • "contact_number": "+447700900077",
  • "relationship": "Husband",
  • "primary": true
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 3213,
    • "user_id": 53252,
    • "first_name": "John",
    • "last_name": "Smith",
    • "contact_number": "+447700900077",
    • "relationship": "Husband",
    • "primary": true
    }
}

Show a users emergency contact

Retrieve a specific emergency contact information

Authorizations:
JWT
path Parameters
userId
required
string

User ID

contactId
required
string

Emergency contact ID

Responses

Response Schema: application/json
object (UserEmergencyContact)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 3213,
    • "user_id": 53252,
    • "first_name": "John",
    • "last_name": "Smith",
    • "contact_number": "+447700900077",
    • "relationship": "Husband",
    • "primary": true
    }
}

Update emergency contact

Update an existing emergency contact information

Authorizations:
JWT
path Parameters
userId
required
string

User ID

contactId
required
string

Emergency contact ID

Request Body schema: application/json
first_name
required
string

Emergency contact first name

last_name
required
string

Emergency contact last name

contact_number
required
string

Emergency contact phone number

relationship
required
string

Emergency contact relationship

primary
required
boolean

Determine if this is the users primary emergency contact

Responses

Response Schema: application/json
object (UserEmergencyContact)

Request samples

Content type
application/json
{
  • "first_name": "John",
  • "last_name": "Smith",
  • "contact_number": "+447700900077",
  • "relationship": "Husband",
  • "primary": true
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 3213,
    • "user_id": 53252,
    • "first_name": "John",
    • "last_name": "Smith",
    • "contact_number": "+447700900077",
    • "relationship": "Husband",
    • "primary": true
    }
}

Delete an emergency contact

Delete a users emergency contact.

You cannot delete the last remaining emergency contact from a user.

Authorizations:
JWT
path Parameters
userId
required
string

User ID

contactId
required
string

Emergency contact ID

Responses

Response samples

Content type
application/json
application/json
application/xml
{
  • "message": "Unauthorized action",
  • "status_code": "403"
}

User Phone Numbers

User phone numbers listing

Retrieve a paginated response of user phone numbers

Authorizations:
JWT
path Parameters
userId
required
string

User ID

query Parameters
primary
boolean

Filter by primary phone number

Responses

Response Schema: application/json
Array of objects (UserPhoneNumber)
object

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": 12312,
      • "phone_number": "+447700900077",
      • "type": "Mobile",
      • "primary": true,
      • "default_sms": true,
      • "user_id": 0,
      • "created_at": "2019-08-24T14:15:22Z",
      • "updated_at": "2019-08-24T14:15:22Z"
      }
    ],
  • "meta": {
    • "pagination": {
      • "total": "string",
      • "count": "string",
      • "per_page": "string",
      • "current_page": "string",
      • "total_pages": "string",
      • "links": {
        • "next": "string",
        • "previous": "string"
        }
      }
    }
}

Create a new phone number

Create a new phone number for a user

Authorizations:
JWT
path Parameters
userId
required
string

User ID

Request Body schema: application/json
phone_number
required
string

The phone number

type
required
string
Enum: "Alternative Phone Number" "Home" "Mobile" "Work"

The type of phone number

primary
required
boolean

Determine if this is the users primary phone number

default_sms
required
boolean

Determine if this is the users default SMS mobile number

created_at
string <date-time>
updated_at
string <date-time>

Responses

Response Schema: application/json
object (UserPhoneNumber)

Request samples

Content type
application/json
{
  • "phone_number": "+447700900077",
  • "type": "Mobile",
  • "primary": true,
  • "default_sms": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 12312,
    • "phone_number": "+447700900077",
    • "type": "Mobile",
    • "primary": true,
    • "default_sms": true,
    • "user_id": 0,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    }
}

Show a users phone number

Retrieve a specific user phone number

Authorizations:
JWT
path Parameters
userId
required
string

User ID

phoneNumberId
required
string

Phone number ID

Responses

Response Schema: application/json
object (UserPhoneNumber)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 12312,
    • "phone_number": "+447700900077",
    • "type": "Mobile",
    • "primary": true,
    • "default_sms": true,
    • "user_id": 0,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    }
}

Update a users phone number

Update an users phone number information

Authorizations:
JWT
path Parameters
userId
required
string

User ID

phoneNumberId
required
string

Phone number ID

Request Body schema: application/json
phone_number
required
string

The phone number

type
required
string
Enum: "Alternative Phone Number" "Home" "Mobile" "Work"

The type of phone number

primary
required
boolean

Determine if this is the users primary phone number

default_sms
required
boolean

Determine if this is the users default SMS mobile number

created_at
string <date-time>
updated_at
string <date-time>

Responses

Response Schema: application/json
object (UserPhoneNumber)

Request samples

Content type
application/json
{
  • "phone_number": "+447700900077",
  • "type": "Mobile",
  • "primary": true,
  • "default_sms": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 12312,
    • "phone_number": "+447700900077",
    • "type": "Mobile",
    • "primary": true,
    • "default_sms": true,
    • "user_id": 0,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    }
}

Delete a users phone number

Delete a users phone number

Authorizations:
JWT
path Parameters
userId
required
string

User ID

phoneNumberId
required
string

Phone number ID

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthorized action",
  • "status_code": "403"
}

User Skills

User skills listing

Retrieve a paginated response of user skills/interests/languages

Authorizations:
JWT
path Parameters
userId
required
string

User ID

Responses

Response Schema: application/json
Array of objects (UserSkill)

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": 3242,
      • "user_id": 532,
      • "name": "Excel"
      }
    ]
}

Update user skills

Update the users skills

Authorizations:
JWT
path Parameters
userId
required
string

User ID

Request Body schema: application/json
skills
Array of integers

Array of skill/interest/language ids

Responses

Response Schema: application/json
Array of objects (UserSkill)
object

Request samples

Content type
application/json
{
  • "skills": [
    • 123,
    • 5353,
    • 213,
    • 66,
    • 235,
    • 242
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": 3242,
      • "user_id": 532,
      • "name": "Excel"
      }
    ],
  • "meta": {
    • "pagination": {
      • "total": "string",
      • "count": "string",
      • "per_page": "string",
      • "current_page": "string",
      • "total_pages": "string",
      • "links": {
        • "next": "string",
        • "previous": "string"
        }
      }
    }
}

User Supervisors

User supervisor listing

Retrieve a paginated response of the users supervisors.

Authorizations:
JWT
path Parameters
userId
required
string

Responses

Response Schema: application/json
Array of objects (UserSupervisor)
object

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": 431,
      • "primary": true,
      • "supervisor": {
        • "id": 46485,
        • "display_name": "John Smith",
        • "title": "Mr",
        • "profile_photo_url": "http://example.com",
        • "can_manage": true,
        • "role_name": "Volunteer",
        • "team_name": "Kent",
        • "status": {
          • "id": "1",
          • "name": "Active",
          • "contactable": true
          }
        }
      }
    ],
  • "meta": {
    • "pagination": {
      • "total": "string",
      • "count": "string",
      • "per_page": "string",
      • "current_page": "string",
      • "total_pages": "string",
      • "links": {
        • "next": "string",
        • "previous": "string"
        }
      }
    }
}

Associate a new supervisor

Associate an existing user as a supervisor

Authorizations:
JWT
path Parameters
userId
required
string
Request Body schema: application/json
object

Supervisor user

primary
boolean
Default: false

Determine if this is the users primary supervisor

Responses

Response Schema: application/json
object (UserSupervisor)

Request samples

Content type
application/json
{
  • "user": {
    • "id": "1232"
    },
  • "primary": false
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 431,
    • "primary": true,
    • "supervisor": {
      • "id": 46485,
      • "display_name": "John Smith",
      • "title": "Mr",
      • "profile_photo_url": "http://example.com",
      • "can_manage": true,
      • "role_name": "Volunteer",
      • "team_name": "Kent",
      • "status": {
        • "id": "1",
        • "name": "Active",
        • "contactable": true
        }
      }
    }
}

Show a user supervisor

Retrieve a specific supervisors information

Authorizations:
JWT
path Parameters
userId
required
string

Users ID

supervisorId
required
string

Supervisor Pivot ID

Responses

Response Schema: application/json
object (UserSupervisor)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 431,
    • "primary": true,
    • "supervisor": {
      • "id": 46485,
      • "display_name": "John Smith",
      • "title": "Mr",
      • "profile_photo_url": "http://example.com",
      • "can_manage": true,
      • "role_name": "Volunteer",
      • "team_name": "Kent",
      • "status": {
        • "id": "1",
        • "name": "Active",
        • "contactable": true
        }
      }
    }
}

Update a user supervisor

Update an existing user supervisor

Authorizations:
JWT
path Parameters
userId
required
string

Users ID

supervisorId
required
string

Supervisor Pivot ID

Request Body schema: application/json
primary
boolean

Determine if this is the users primary supervisor

Responses

Response Schema: application/json
object (UserSupervisor)

Request samples

Content type
application/json
{
  • "primary": true
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 431,
    • "primary": true,
    • "supervisor": {
      • "id": 46485,
      • "display_name": "John Smith",
      • "title": "Mr",
      • "profile_photo_url": "http://example.com",
      • "can_manage": true,
      • "role_name": "Volunteer",
      • "team_name": "Kent",
      • "status": {
        • "id": "1",
        • "name": "Active",
        • "contactable": true
        }
      }
    }
}

Remove an associated supervisor

Remove an existing user as a supervisor

Authorizations:
JWT
path Parameters
userId
required
string

Users ID

supervisorId
required
string

Supervisor Pivot ID

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthorized action",
  • "status_code": "403"
}

User Notes

Note listing

Retrieve a pagianted response of user notes.

Authorizations:
JWT
path Parameters
userId
required
string
query Parameters
q
string

Search notes by title and content

Responses

Response Schema: application/json
Array of objects (UserNote)
object

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": 53253,
      • "subject": "Nunc id cursus metus aliquam eleifend mi",
      • "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Id ornare arcu odio ut sem nulla pharetra. Posuere urna nec tincidunt praesent. Quam nulla porttitor massa id neque. Arcu bibendum at varius vel pharetra vel. Sed nisi lacus sed viverra tellus in hac habitasse. Nunc id cursus metus aliquam eleifend mi. Nisl purus in mollis nunc sed id semper. Vitae proin sagittis nisl rhoncus mattis rhoncus urna neque viverra. Dolor morbi non arcu risus quis varius quam quisque id. Malesuada pellentesque elit eget gravida cum sociis natoque penatibus et. At varius vel pharetra vel. Sed vulputate odio ut enim. Amet mauris commodo quis imperdiet massa. Condimentum lacinia quis vel eros. Scelerisque eleifend donec pretium vulputate sapien. Morbi non arcu risus quis varius. Amet commodo nulla facilisi nullam vehicula.",
      • "private": true,
      • "pinned": true,
      • "created_by": {
        • "id": 46485,
        • "display_name": "John Smith",
        • "title": "Mr",
        • "profile_photo_url": "http://example.com",
        • "can_manage": true,
        • "role_name": "Volunteer",
        • "team_name": "Kent",
        • "status": {
          • "id": "1",
          • "name": "Active",
          • "contactable": true
          }
        },
      • "user": {
        • "id": 46485,
        • "display_name": "John Smith",
        • "title": "Mr",
        • "profile_photo_url": "http://example.com",
        • "can_manage": true,
        • "role_name": "Volunteer",
        • "team_name": "Kent",
        • "status": {
          • "id": "1",
          • "name": "Active",
          • "contactable": true
          }
        },
      • "category": {
        • "id": 432,
        • "name": "General / Other"
        },
      • "team": {
        • "id": "3521",
        • "display_name": "Headquarters"
        },
      • "sub_notes": [
        • {
          • "id": 3214,
          • "body": "Ac odio tempor orci dapibus ultrices in. Sed nisi lacus sed viverra tellus in. Sem viverra aliquet eget sit amet tellus cras adipiscing enim. Pellentesque adipiscing commodo elit at",
          • "user": {
            • "id": 46485,
            • "display_name": "John Smith",
            • "title": "Mr",
            • "profile_photo_url": "http://example.com",
            • "can_manage": true,
            • "role_name": "Volunteer",
            • "team_name": "Kent",
            • "status": {
              • "id": "1",
              • "name": "Active",
              • "contactable": true
              }
            },
          • "created_at": "2019-08-24T14:15:22Z",
          • "updated_at": "2019-08-24T14:15:22Z",
          • "deleted_at": "2019-08-24T14:15:22Z"
          }
        ],
      • "reminder": {
        • "date": "2019-08-24T14:15:22Z"
        },
      • "created_at": "2019-08-24T14:15:22Z",
      • "updated_at": "2019-08-24T14:15:22Z",
      • "deleted_at": "2019-08-24T14:15:22Z"
      }
    ],
  • "meta": {
    • "pagination": {
      • "total": "string",
      • "count": "string",
      • "per_page": "string",
      • "current_page": "string",
      • "total_pages": "string",
      • "links": {
        • "next": "string",
        • "previous": "string"
        }
      }
    }
}

Create a new note

Create a new note against a specific user.

Authorizations:
JWT
path Parameters
userId
required
string
Request Body schema: application/json
subject
string

The notes subject

body
string

The notes content

private
boolean

Determine if this note is marked as private

pinned
boolean

Determine if this note is pinned

object (UserBase)
object (UserBase)
object (UserNoteCategory)
object (TeamBase)

Basic team information

object

Responses

Response Schema: application/json
object (UserNote)

Request samples

Content type
application/json
{
  • "subject": "Nunc id cursus metus aliquam eleifend mi",
  • "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Id ornare arcu odio ut sem nulla pharetra. Posuere urna nec tincidunt praesent. Quam nulla porttitor massa id neque. Arcu bibendum at varius vel pharetra vel. Sed nisi lacus sed viverra tellus in hac habitasse. Nunc id cursus metus aliquam eleifend mi. Nisl purus in mollis nunc sed id semper. Vitae proin sagittis nisl rhoncus mattis rhoncus urna neque viverra. Dolor morbi non arcu risus quis varius quam quisque id. Malesuada pellentesque elit eget gravida cum sociis natoque penatibus et. At varius vel pharetra vel. Sed vulputate odio ut enim. Amet mauris commodo quis imperdiet massa. Condimentum lacinia quis vel eros. Scelerisque eleifend donec pretium vulputate sapien. Morbi non arcu risus quis varius. Amet commodo nulla facilisi nullam vehicula.",
  • "private": true,
  • "pinned": true,
  • "created_by": {
    • "title": "Mr",
    • "can_manage": true,
    • "status": { }
    },
  • "user": {
    • "title": "Mr",
    • "can_manage": true,
    • "status": { }
    },
  • "category": {
    • "name": "General / Other"
    },
  • "team": { },
  • "reminder": {
    • "date": "2019-08-24T14:15:22Z"
    }
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 53253,
    • "subject": "Nunc id cursus metus aliquam eleifend mi",
    • "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Id ornare arcu odio ut sem nulla pharetra. Posuere urna nec tincidunt praesent. Quam nulla porttitor massa id neque. Arcu bibendum at varius vel pharetra vel. Sed nisi lacus sed viverra tellus in hac habitasse. Nunc id cursus metus aliquam eleifend mi. Nisl purus in mollis nunc sed id semper. Vitae proin sagittis nisl rhoncus mattis rhoncus urna neque viverra. Dolor morbi non arcu risus quis varius quam quisque id. Malesuada pellentesque elit eget gravida cum sociis natoque penatibus et. At varius vel pharetra vel. Sed vulputate odio ut enim. Amet mauris commodo quis imperdiet massa. Condimentum lacinia quis vel eros. Scelerisque eleifend donec pretium vulputate sapien. Morbi non arcu risus quis varius. Amet commodo nulla facilisi nullam vehicula.",
    • "private": true,
    • "pinned": true,
    • "created_by": {
      • "id": 46485,
      • "display_name": "John Smith",
      • "title": "Mr",
      • "profile_photo_url": "http://example.com",
      • "can_manage": true,
      • "role_name": "Volunteer",
      • "team_name": "Kent",
      • "status": {
        • "id": "1",
        • "name": "Active",
        • "contactable": true
        }
      },
    • "user": {
      • "id": 46485,
      • "display_name": "John Smith",
      • "title": "Mr",
      • "profile_photo_url": "http://example.com",
      • "can_manage": true,
      • "role_name": "Volunteer",
      • "team_name": "Kent",
      • "status": {
        • "id": "1",
        • "name": "Active",
        • "contactable": true
        }
      },
    • "category": {
      • "id": 432,
      • "name": "General / Other"
      },
    • "team": {
      • "id": "3521",
      • "display_name": "Headquarters"
      },
    • "sub_notes": [
      • {
        • "id": 3214,
        • "body": "Ac odio tempor orci dapibus ultrices in. Sed nisi lacus sed viverra tellus in. Sem viverra aliquet eget sit amet tellus cras adipiscing enim. Pellentesque adipiscing commodo elit at",
        • "user": {
          • "id": 46485,
          • "display_name": "John Smith",
          • "title": "Mr",
          • "profile_photo_url": "http://example.com",
          • "can_manage": true,
          • "role_name": "Volunteer",
          • "team_name": "Kent",
          • "status": {
            • "id": "1",
            • "name": "Active",
            • "contactable": true
            }
          },
        • "created_at": "2019-08-24T14:15:22Z",
        • "updated_at": "2019-08-24T14:15:22Z",
        • "deleted_at": "2019-08-24T14:15:22Z"
        }
      ],
    • "reminder": {
      • "date": "2019-08-24T14:15:22Z"
      },
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "deleted_at": "2019-08-24T14:15:22Z"
    }
}

Show a note

Retrieve information for a specific user note.

Authorizations:
JWT
path Parameters
userId
required
string
noteId
required
string

Responses

Response Schema: application/json
object (UserNote)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 53253,
    • "subject": "Nunc id cursus metus aliquam eleifend mi",
    • "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Id ornare arcu odio ut sem nulla pharetra. Posuere urna nec tincidunt praesent. Quam nulla porttitor massa id neque. Arcu bibendum at varius vel pharetra vel. Sed nisi lacus sed viverra tellus in hac habitasse. Nunc id cursus metus aliquam eleifend mi. Nisl purus in mollis nunc sed id semper. Vitae proin sagittis nisl rhoncus mattis rhoncus urna neque viverra. Dolor morbi non arcu risus quis varius quam quisque id. Malesuada pellentesque elit eget gravida cum sociis natoque penatibus et. At varius vel pharetra vel. Sed vulputate odio ut enim. Amet mauris commodo quis imperdiet massa. Condimentum lacinia quis vel eros. Scelerisque eleifend donec pretium vulputate sapien. Morbi non arcu risus quis varius. Amet commodo nulla facilisi nullam vehicula.",
    • "private": true,
    • "pinned": true,
    • "created_by": {
      • "id": 46485,
      • "display_name": "John Smith",
      • "title": "Mr",
      • "profile_photo_url": "http://example.com",
      • "can_manage": true,
      • "role_name": "Volunteer",
      • "team_name": "Kent",
      • "status": {
        • "id": "1",
        • "name": "Active",
        • "contactable": true
        }
      },
    • "user": {
      • "id": 46485,
      • "display_name": "John Smith",
      • "title": "Mr",
      • "profile_photo_url": "http://example.com",
      • "can_manage": true,
      • "role_name": "Volunteer",
      • "team_name": "Kent",
      • "status": {
        • "id": "1",
        • "name": "Active",
        • "contactable": true
        }
      },
    • "category": {
      • "id": 432,
      • "name": "General / Other"
      },
    • "team": {
      • "id": "3521",
      • "display_name": "Headquarters"
      },
    • "sub_notes": [
      • {
        • "id": 3214,
        • "body": "Ac odio tempor orci dapibus ultrices in. Sed nisi lacus sed viverra tellus in. Sem viverra aliquet eget sit amet tellus cras adipiscing enim. Pellentesque adipiscing commodo elit at",
        • "user": {
          • "id": 46485,
          • "display_name": "John Smith",
          • "title": "Mr",
          • "profile_photo_url": "http://example.com",
          • "can_manage": true,
          • "role_name": "Volunteer",
          • "team_name": "Kent",
          • "status": {
            • "id": "1",
            • "name": "Active",
            • "contactable": true
            }
          },
        • "created_at": "2019-08-24T14:15:22Z",
        • "updated_at": "2019-08-24T14:15:22Z",
        • "deleted_at": "2019-08-24T14:15:22Z"
        }
      ],
    • "reminder": {
      • "date": "2019-08-24T14:15:22Z"
      },
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "deleted_at": "2019-08-24T14:15:22Z"
    }
}

Update a note

Update a user note.

Authorizations:
JWT
path Parameters
userId
required
string
noteId
required
string
Request Body schema: application/json
subject
string

The notes subject

body
string

The notes content

private
boolean

Determine if this note is marked as private

pinned
boolean

Determine if this note is pinned

object (UserBase)
object (UserBase)
object (UserNoteCategory)
object (TeamBase)

Basic team information

object

Responses

Response Schema: application/json
object (UserNote)

Request samples

Content type
application/json
{
  • "subject": "Nunc id cursus metus aliquam eleifend mi",
  • "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Id ornare arcu odio ut sem nulla pharetra. Posuere urna nec tincidunt praesent. Quam nulla porttitor massa id neque. Arcu bibendum at varius vel pharetra vel. Sed nisi lacus sed viverra tellus in hac habitasse. Nunc id cursus metus aliquam eleifend mi. Nisl purus in mollis nunc sed id semper. Vitae proin sagittis nisl rhoncus mattis rhoncus urna neque viverra. Dolor morbi non arcu risus quis varius quam quisque id. Malesuada pellentesque elit eget gravida cum sociis natoque penatibus et. At varius vel pharetra vel. Sed vulputate odio ut enim. Amet mauris commodo quis imperdiet massa. Condimentum lacinia quis vel eros. Scelerisque eleifend donec pretium vulputate sapien. Morbi non arcu risus quis varius. Amet commodo nulla facilisi nullam vehicula.",
  • "private": true,
  • "pinned": true,
  • "created_by": {
    • "title": "Mr",
    • "can_manage": true,
    • "status": { }
    },
  • "user": {
    • "title": "Mr",
    • "can_manage": true,
    • "status": { }
    },
  • "category": {
    • "name": "General / Other"
    },
  • "team": { },
  • "reminder": {
    • "date": "2019-08-24T14:15:22Z"
    }
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 53253,
    • "subject": "Nunc id cursus metus aliquam eleifend mi",
    • "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Id ornare arcu odio ut sem nulla pharetra. Posuere urna nec tincidunt praesent. Quam nulla porttitor massa id neque. Arcu bibendum at varius vel pharetra vel. Sed nisi lacus sed viverra tellus in hac habitasse. Nunc id cursus metus aliquam eleifend mi. Nisl purus in mollis nunc sed id semper. Vitae proin sagittis nisl rhoncus mattis rhoncus urna neque viverra. Dolor morbi non arcu risus quis varius quam quisque id. Malesuada pellentesque elit eget gravida cum sociis natoque penatibus et. At varius vel pharetra vel. Sed vulputate odio ut enim. Amet mauris commodo quis imperdiet massa. Condimentum lacinia quis vel eros. Scelerisque eleifend donec pretium vulputate sapien. Morbi non arcu risus quis varius. Amet commodo nulla facilisi nullam vehicula.",
    • "private": true,
    • "pinned": true,
    • "created_by": {
      • "id": 46485,
      • "display_name": "John Smith",
      • "title": "Mr",
      • "profile_photo_url": "http://example.com",
      • "can_manage": true,
      • "role_name": "Volunteer",
      • "team_name": "Kent",
      • "status": {
        • "id": "1",
        • "name": "Active",
        • "contactable": true
        }
      },
    • "user": {
      • "id": 46485,
      • "display_name": "John Smith",
      • "title": "Mr",
      • "profile_photo_url": "http://example.com",
      • "can_manage": true,
      • "role_name": "Volunteer",
      • "team_name": "Kent",
      • "status": {
        • "id": "1",
        • "name": "Active",
        • "contactable": true
        }
      },
    • "category": {
      • "id": 432,
      • "name": "General / Other"
      },
    • "team": {
      • "id": "3521",
      • "display_name": "Headquarters"
      },
    • "sub_notes": [
      • {
        • "id": 3214,
        • "body": "Ac odio tempor orci dapibus ultrices in. Sed nisi lacus sed viverra tellus in. Sem viverra aliquet eget sit amet tellus cras adipiscing enim. Pellentesque adipiscing commodo elit at",
        • "user": {
          • "id": 46485,
          • "display_name": "John Smith",
          • "title": "Mr",
          • "profile_photo_url": "http://example.com",
          • "can_manage": true,
          • "role_name": "Volunteer",
          • "team_name": "Kent",
          • "status": {
            • "id": "1",
            • "name": "Active",
            • "contactable": true
            }
          },
        • "created_at": "2019-08-24T14:15:22Z",
        • "updated_at": "2019-08-24T14:15:22Z",
        • "deleted_at": "2019-08-24T14:15:22Z"
        }
      ],
    • "reminder": {
      • "date": "2019-08-24T14:15:22Z"
      },
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "deleted_at": "2019-08-24T14:15:22Z"
    }
}

Delete a note

Delete an existing note

Authorizations:
JWT
path Parameters
userId
required
string
noteId
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthorized action",
  • "status_code": "403"
}

Create a sub note

Create a sub note against an existing note

Authorizations:
JWT
path Parameters
userId
required
string
noteId
required
string
Request Body schema: application/json
body
string

The sub note content

object (UserBase)

Responses

Response Schema: application/json
object (UserSubNote)

Request samples

Content type
application/json
{
  • "body": "Ac odio tempor orci dapibus ultrices in. Sed nisi lacus sed viverra tellus in. Sem viverra aliquet eget sit amet tellus cras adipiscing enim. Pellentesque adipiscing commodo elit at",
  • "user": {
    • "title": "Mr",
    • "can_manage": true,
    • "status": { }
    }
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 3214,
    • "body": "Ac odio tempor orci dapibus ultrices in. Sed nisi lacus sed viverra tellus in. Sem viverra aliquet eget sit amet tellus cras adipiscing enim. Pellentesque adipiscing commodo elit at",
    • "user": {
      • "id": 46485,
      • "display_name": "John Smith",
      • "title": "Mr",
      • "profile_photo_url": "http://example.com",
      • "can_manage": true,
      • "role_name": "Volunteer",
      • "team_name": "Kent",
      • "status": {
        • "id": "1",
        • "name": "Active",
        • "contactable": true
        }
      },
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "deleted_at": "2019-08-24T14:15:22Z"
    }
}

Delete a sub note

Delete an existing sub note

Authorizations:
JWT
path Parameters
userId
required
string
noteId
required
string
subNoteId
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthorized action",
  • "status_code": "403"
}

User Touchpoints

Touchpoint listing

Retrieve a pagainted response of touchpoints for a specific user.

Authorizations:
JWT
path Parameters
userId
required
string
query Parameters
q
string
Example: q=Training

Search by subject and body

type
string
Example: type=42,634,13

Filter by touchpoint type id (comma separated list)

archived
boolean

Filter by archived touchpoints

from
string

Filter by a start date

to
string

Filter by an end date

o
string
Default: "d"
Enum: "a" "d"
Example: o=a

Order the results

s
string
Default: "date"
Value: "date"
Example: s=date

Sort the results

Responses

Response Schema: application/json
Array of objects (Touchpoint)
object

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": 0,
      • "subject": "Eget mi proin sed libero enim sed faucibus",
      • "body": "Urna cursus eget nunc scelerisque viverra mauris in aliquam. Id diam vel quam elementum. Ultrices sagittis orci a scelerisque purus semper.",
      • "archived": true,
      • "private": true,
      • "start": "2019-08-24",
      • "end": "2019-08-24",
      • "duration": 60,
      • "follow_up_date": "2019-08-24T14:15:22Z",
      • "created_by": {
        • "id": 46485,
        • "display_name": "John Smith",
        • "title": "Mr",
        • "profile_photo_url": "http://example.com",
        • "can_manage": true,
        • "role_name": "Volunteer",
        • "team_name": "Kent",
        • "status": {
          • "id": "1",
          • "name": "Active",
          • "contactable": true
          }
        },
      • "user": {
        • "id": 46485,
        • "display_name": "John Smith",
        • "title": "Mr",
        • "profile_photo_url": "http://example.com",
        • "can_manage": true,
        • "role_name": "Volunteer",
        • "team_name": "Kent",
        • "status": {
          • "id": "1",
          • "name": "Active",
          • "contactable": true
          }
        },
      • "team": {
        • "id": "3521",
        • "display_name": "Headquarters"
        },
      • "type": {
        • "id": 0,
        • "name": "string",
        • "icon": "string",
        • "filterable": true,
        • "has_file_upload": true,
        • "has_duration": true,
        • "has_subject": true,
        • "has_comments": true,
        • "has_date": true,
        • "has_time": true,
        • "has_follow_up_date": true,
        • "has_team_checkbox": true,
        • "created_at": "2019-08-24T14:15:22Z",
        • "updated_at": "2019-08-24T14:15:22Z"
        },
      • "sub_touchpoints": [
        • {
          • "id": 0,
          • "body": "string",
          • "created_at": "2019-08-24T14:15:22Z",
          • "updated_at": "2019-08-24T14:15:22Z"
          }
        ],
      • "attachments": [
        • { }
        ],
      • "reminder": {
        • "date": "2019-08-24T14:15:22Z"
        },
      • "created_at": "2019-08-24T14:15:22Z",
      • "updated_at": "2019-08-24T14:15:22Z"
      }
    ],
  • "meta": {
    • "pagination": {
      • "total": "string",
      • "count": "string",
      • "per_page": "string",
      • "current_page": "string",
      • "total_pages": "string",
      • "links": {
        • "next": "string",
        • "previous": "string"
        }
      }
    }
}

Create a new touchpoint

Add a new touchpoint against a user

Authorizations:
JWT
path Parameters
userId
required
string
Request Body schema: application/json
subject
string

The touchpoints subject

body
string

The touchpoints content

archived
boolean

Determine if the touchpoint is archived

private
boolean

Determine if the touchpoint is private

start
string <date>

The touchpoints start date

end
string <date>

The touchpoints end date

duration
integer

The touchpoints duration (in minutes)

follow_up_date
string <date-time>

Follow up date and time

object (UserBase)
object (UserBase)
object (TeamBase)

Basic team information

object (TouchpointType)
Array of objects (SubTouchpoint)
attachments
Array of objects
object

Responses

Response Schema: application/json
object (Touchpoint)

Request samples

Content type
application/json
{
  • "subject": "Eget mi proin sed libero enim sed faucibus",
  • "body": "Urna cursus eget nunc scelerisque viverra mauris in aliquam. Id diam vel quam elementum. Ultrices sagittis orci a scelerisque purus semper.",
  • "archived": true,
  • "private": true,
  • "start": "2019-08-24",
  • "end": "2019-08-24",
  • "duration": 60,
  • "follow_up_date": "2019-08-24T14:15:22Z",
  • "created_by": {
    • "title": "Mr",
    • "can_manage": true,
    • "status": { }
    },
  • "user": {
    • "title": "Mr",
    • "can_manage": true,
    • "status": { }
    },
  • "team": { },
  • "type": { },
  • "sub_touchpoints": [
    • {
      • "body": "string"
      }
    ],
  • "attachments": [
    • { }
    ],
  • "reminder": {
    • "date": "2019-08-24T14:15:22Z"
    }
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "subject": "Eget mi proin sed libero enim sed faucibus",
    • "body": "Urna cursus eget nunc scelerisque viverra mauris in aliquam. Id diam vel quam elementum. Ultrices sagittis orci a scelerisque purus semper.",
    • "archived": true,
    • "private": true,
    • "start": "2019-08-24",
    • "end": "2019-08-24",
    • "duration": 60,
    • "follow_up_date": "2019-08-24T14:15:22Z",
    • "created_by": {
      • "id": 46485,
      • "display_name": "John Smith",
      • "title": "Mr",
      • "profile_photo_url": "http://example.com",
      • "can_manage": true,
      • "role_name": "Volunteer",
      • "team_name": "Kent",
      • "status": {
        • "id": "1",
        • "name": "Active",
        • "contactable": true
        }
      },
    • "user": {
      • "id": 46485,
      • "display_name": "John Smith",
      • "title": "Mr",
      • "profile_photo_url": "http://example.com",
      • "can_manage": true,
      • "role_name": "Volunteer",
      • "team_name": "Kent",
      • "status": {
        • "id": "1",
        • "name": "Active",
        • "contactable": true
        }
      },
    • "team": {
      • "id": "3521",
      • "display_name": "Headquarters"
      },
    • "type": {
      • "id": 0,
      • "name": "string",
      • "icon": "string",
      • "filterable": true,
      • "has_file_upload": true,
      • "has_duration": true,
      • "has_subject": true,
      • "has_comments": true,
      • "has_date": true,
      • "has_time": true,
      • "has_follow_up_date": true,
      • "has_team_checkbox": true,
      • "created_at": "2019-08-24T14:15:22Z",
      • "updated_at": "2019-08-24T14:15:22Z"
      },
    • "sub_touchpoints": [
      • {
        • "id": 0,
        • "body": "string",
        • "created_at": "2019-08-24T14:15:22Z",
        • "updated_at": "2019-08-24T14:15:22Z"
        }
      ],
    • "attachments": [
      • { }
      ],
    • "reminder": {
      • "date": "2019-08-24T14:15:22Z"
      },
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    }
}

Show a touchpoint

Retrieve information for a specific touchpoint

Authorizations:
JWT
path Parameters
userId
required
string
touchpointId
required
string

Responses

Response Schema: application/json
object (Touchpoint)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "subject": "Eget mi proin sed libero enim sed faucibus",
    • "body": "Urna cursus eget nunc scelerisque viverra mauris in aliquam. Id diam vel quam elementum. Ultrices sagittis orci a scelerisque purus semper.",
    • "archived": true,
    • "private": true,
    • "start": "2019-08-24",
    • "end": "2019-08-24",
    • "duration": 60,
    • "follow_up_date": "2019-08-24T14:15:22Z",
    • "created_by": {
      • "id": 46485,
      • "display_name": "John Smith",
      • "title": "Mr",
      • "profile_photo_url": "http://example.com",
      • "can_manage": true,
      • "role_name": "Volunteer",
      • "team_name": "Kent",
      • "status": {
        • "id": "1",
        • "name": "Active",
        • "contactable": true
        }
      },
    • "user": {
      • "id": 46485,
      • "display_name": "John Smith",
      • "title": "Mr",
      • "profile_photo_url": "http://example.com",
      • "can_manage": true,
      • "role_name": "Volunteer",
      • "team_name": "Kent",
      • "status": {
        • "id": "1",
        • "name": "Active",
        • "contactable": true
        }
      },
    • "team": {
      • "id": "3521",
      • "display_name": "Headquarters"
      },
    • "type": {
      • "id": 0,
      • "name": "string",
      • "icon": "string",
      • "filterable": true,
      • "has_file_upload": true,
      • "has_duration": true,
      • "has_subject": true,
      • "has_comments": true,
      • "has_date": true,
      • "has_time": true,
      • "has_follow_up_date": true,
      • "has_team_checkbox": true,
      • "created_at": "2019-08-24T14:15:22Z",
      • "updated_at": "2019-08-24T14:15:22Z"
      },
    • "sub_touchpoints": [
      • {
        • "id": 0,
        • "body": "string",
        • "created_at": "2019-08-24T14:15:22Z",
        • "updated_at": "2019-08-24T14:15:22Z"
        }
      ],
    • "attachments": [
      • { }
      ],
    • "reminder": {
      • "date": "2019-08-24T14:15:22Z"
      },
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    }
}

Update a touchpoint

Update a touchpoints information

Authorizations:
JWT
path Parameters
userId
required
string
touchpointId
required
string
Request Body schema: application/json
subject
string

The touchpoints subject

body
string

The touchpoints content

archived
boolean

Determine if the touchpoint is archived

private
boolean

Determine if the touchpoint is private

start
string <date>

The touchpoints start date

end
string <date>

The touchpoints end date

duration
integer

The touchpoints duration (in minutes)

follow_up_date
string <date-time>

Follow up date and time

object (UserBase)
object (UserBase)
object (TeamBase)

Basic team information

object (TouchpointType)
Array of objects (SubTouchpoint)
attachments
Array of objects
object

Responses

Response Schema: application/json
object (Touchpoint)

Request samples

Content type
application/json
{
  • "subject": "Eget mi proin sed libero enim sed faucibus",
  • "body": "Urna cursus eget nunc scelerisque viverra mauris in aliquam. Id diam vel quam elementum. Ultrices sagittis orci a scelerisque purus semper.",
  • "archived": true,
  • "private": true,
  • "start": "2019-08-24",
  • "end": "2019-08-24",
  • "duration": 60,
  • "follow_up_date": "2019-08-24T14:15:22Z",
  • "created_by": {
    • "title": "Mr",
    • "can_manage": true,
    • "status": { }
    },
  • "user": {
    • "title": "Mr",
    • "can_manage": true,
    • "status": { }
    },
  • "team": { },
  • "type": { },
  • "sub_touchpoints": [
    • {
      • "body": "string"
      }
    ],
  • "attachments": [
    • { }
    ],
  • "reminder": {
    • "date": "2019-08-24T14:15:22Z"
    }
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "subject": "Eget mi proin sed libero enim sed faucibus",
    • "body": "Urna cursus eget nunc scelerisque viverra mauris in aliquam. Id diam vel quam elementum. Ultrices sagittis orci a scelerisque purus semper.",
    • "archived": true,
    • "private": true,
    • "start": "2019-08-24",
    • "end": "2019-08-24",
    • "duration": 60,
    • "follow_up_date": "2019-08-24T14:15:22Z",
    • "created_by": {
      • "id": 46485,
      • "display_name": "John Smith",
      • "title": "Mr",
      • "profile_photo_url": "http://example.com",
      • "can_manage": true,
      • "role_name": "Volunteer",
      • "team_name": "Kent",
      • "status": {
        • "id": "1",
        • "name": "Active",
        • "contactable": true
        }
      },
    • "user": {
      • "id": 46485,
      • "display_name": "John Smith",
      • "title": "Mr",
      • "profile_photo_url": "http://example.com",
      • "can_manage": true,
      • "role_name": "Volunteer",
      • "team_name": "Kent",
      • "status": {
        • "id": "1",
        • "name": "Active",
        • "contactable": true
        }
      },
    • "team": {
      • "id": "3521",
      • "display_name": "Headquarters"
      },
    • "type": {
      • "id": 0,
      • "name": "string",
      • "icon": "string",
      • "filterable": true,
      • "has_file_upload": true,
      • "has_duration": true,
      • "has_subject": true,
      • "has_comments": true,
      • "has_date": true,
      • "has_time": true,
      • "has_follow_up_date": true,
      • "has_team_checkbox": true,
      • "created_at": "2019-08-24T14:15:22Z",
      • "updated_at": "2019-08-24T14:15:22Z"
      },
    • "sub_touchpoints": [
      • {
        • "id": 0,
        • "body": "string",
        • "created_at": "2019-08-24T14:15:22Z",
        • "updated_at": "2019-08-24T14:15:22Z"
        }
      ],
    • "attachments": [
      • { }
      ],
    • "reminder": {
      • "date": "2019-08-24T14:15:22Z"
      },
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    }
}

Delete a touchpoint

Delete a touchpoint

Authorizations:
JWT
path Parameters
userId
required
string
touchpointId
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthorized action",
  • "status_code": "403"
}

Create a sub touchpoint

Create a sub touchpoint against an existing touchpoint

Authorizations:
JWT
path Parameters
userId
required
string
touchpointId
required
string
Request Body schema: application/json
body
string

Responses

Response Schema: application/json
object (SubTouchpoint)

Request samples

Content type
application/json
{
  • "body": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 0,
    • "body": "string",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    }
}