Assemble Developer Portal

API docs by Redocly

Activities (3.0)

Download OpenAPI specification:Download

This documentation describes how to retrieve, store and update activities and activity settings.

Activities

Activity listing

Retrieve a paginated response of activities

Note: endpoint is available with "Activities" feature

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

Search by activity description

category
string
Example: category=23,532,676

Filter by activity category id (comma separated list)

start_date
string <date>

Filter by activity start date

end_date
string <date>

Filter by activity end date

user
string
Example: user=4234,4536,112

Filter by user id (comma separated list)

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

Order the results. 'a' for ascending, 'd' for descending

s
string
Default: "start_date"
Enum: "description" "category" "start_date" "updated"
Example: s=category

Sort the results

updated_after
string
Example: updated_after=2023-03-01 09:00:00

Filter by activity 'updated after' datetime. Filter also includes the current datetime, consider the longer version of the logic as 'updated at or after'

updated_before
string
Example: updated_before=2023-04-01 15:00:00

Filter by activity 'updated before' datetime. Filter also includes the current datetime, consider the longer version of the logic as 'updated at or before'

Responses

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

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": 2432,
      • "description": "Training at HQ",
      • "start_date": "2019-08-24",
      • "start_time": "14:15:22Z",
      • "end_date": "2019-08-24",
      • "end_time": "14:15:22Z",
      • "duration": 250,
      • "final": true,
      • "pending_outcomes": true,
      • "type": "Event",
      • "type_id": "231312",
      • "url": "http://example.com",
      • "can_edit": true,
      • "can_delete": true,
      • "category": {
        • "id": 442,
        • "name": "Training",
        • "default_duration": 30,
        • "types": {
          • "ad_hoc": true,
          • "rota": true,
          • "events": true,
          • "opportunities": true,
          • "tasks": true
          },
        • "sensitive": true,
        • "require_description": true,
        • "require_date_time": true,
        • "allow_future": true,
        • "created_at": "2019-08-24T14:15:22Z",
        • "updated_at": "2019-08-24T14:15:22Z",
        • "children": [
          • { }
          ]
        },
      • "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
          }
        },
      • "roleProfile": {
        • "id": 3253,
        • "name": "Volunteer v1",
        • "display_name": "Volunteer",
        • "primary": true,
        • "team": {
          • "id": "3521",
          • "display_name": "Headquarters",
          • "parent_id": 1424,
          • "name": "Headquarters",
          • "description": "string",
          • "geo_location": "string",
          • "catchment_area_id": "string",
          • "icon": "fa fa-building",
          • "show_on_public_site": false,
          • "show_on_near_me_map": false,
          • "ceiling_enabled": false,
          • "public_url": "http://example.com",
          • "hidden": false,
          • "disabled": false,
          • "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"
          }
        },
      • "outcomes": {
        • "example-custom-field-text": {
          • "value": "string"
          },
        • "example-custom-field-dropdown": {
          • "value": "string"
          }
        }
      }
    ],
  • "meta": {
    • "pagination": {
      • "total": "string",
      • "count": "string",
      • "per_page": "string",
      • "current_page": "string",
      • "total_pages": "string",
      • "links": {
        • "next": "string",
        • "previous": "string"
        }
      }
    }
}

Create a new activity

Create a new activity

Note: endpoint is available with "Activities" feature

Authorizations:
JWT
Request Body schema: application/json
description
string

The activity description

start_date
required
string <date>

Activity start date

start_time
string <time>

Activity start time

end_date
string <date>

Activity end date

end_time
string <time>

Activity end time

object

Activity category outcomes

activity_category_id
required
integer

Activity category id

duration
integer

Activity duration (in minutes)

object
object

Responses

Response Schema: application/json
object (Activity)

Request samples

Content type
application/json
{
  • "description": "Training at HQ",
  • "start_date": "2019-08-24",
  • "start_time": "14:15:22Z",
  • "end_date": "2019-08-24",
  • "end_time": "14:15:22Z",
  • "outcomes": {
    • "example-custom-field-text": {
      • "value": "string"
      },
    • "example-custom-field-dropdown": {
      • "value": "string"
      }
    },
  • "activity_category_id": 0,
  • "duration": 0,
  • "user": {
    • "id": 24242
    },
  • "roleProfile": {
    • "id": 0
    }
}

Response samples

Content type
application/json
No sample

Show an activity

Retrieve a specific activities information

Note: endpoint is available with "Activities" feature

Authorizations:
JWT
path Parameters
id
required
string

Responses

Response Schema: application/json
object (Activity)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 2432,
    • "description": "Training at HQ",
    • "start_date": "2019-08-24",
    • "start_time": "14:15:22Z",
    • "end_date": "2019-08-24",
    • "end_time": "14:15:22Z",
    • "duration": 250,
    • "final": true,
    • "pending_outcomes": true,
    • "type": "Event",
    • "type_id": "231312",
    • "url": "http://example.com",
    • "can_edit": true,
    • "can_delete": true,
    • "category": {
      • "id": 442,
      • "name": "Training",
      • "default_duration": 30,
      • "types": {
        • "ad_hoc": true,
        • "rota": true,
        • "events": true,
        • "opportunities": true,
        • "tasks": true
        },
      • "sensitive": true,
      • "require_description": true,
      • "require_date_time": true,
      • "allow_future": true,
      • "created_at": "2019-08-24T14:15:22Z",
      • "updated_at": "2019-08-24T14:15:22Z",
      • "children": [
        • { }
        ]
      },
    • "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
        }
      },
    • "roleProfile": {
      • "id": 3253,
      • "name": "Volunteer v1",
      • "display_name": "Volunteer",
      • "primary": true,
      • "team": {
        • "id": "3521",
        • "display_name": "Headquarters",
        • "parent_id": 1424,
        • "name": "Headquarters",
        • "description": "string",
        • "geo_location": "string",
        • "catchment_area_id": "string",
        • "icon": "fa fa-building",
        • "show_on_public_site": false,
        • "show_on_near_me_map": false,
        • "ceiling_enabled": false,
        • "public_url": "http://example.com",
        • "hidden": false,
        • "disabled": false,
        • "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"
        }
      },
    • "outcomes": {
      • "example-custom-field-text": {
        • "value": "string"
        },
      • "example-custom-field-dropdown": {
        • "value": "string"
        }
      }
    }
}

Update an activity

Update an existing activities details

Note: endpoint is available with "Activities" feature

Authorizations:
JWT
path Parameters
id
required
string
Request Body schema: application/json
description
string

The activity description

start_date
required
string <date>

Activity start date

start_time
string <time>

Activity start time

end_date
string <date>

Activity end date

end_time
string <time>

Activity end time

object

Activity category outcomes

activity_category_id
required
integer

Activity category id

duration
integer

Activity duration (in minutes)

object
object

Responses

Response Schema: application/json
object (Activity)

Request samples

Content type
application/json
{
  • "description": "Training at HQ",
  • "start_date": "2019-08-24",
  • "start_time": "14:15:22Z",
  • "end_date": "2019-08-24",
  • "end_time": "14:15:22Z",
  • "outcomes": {
    • "example-custom-field-text": {
      • "value": "string"
      },
    • "example-custom-field-dropdown": {
      • "value": "string"
      }
    },
  • "activity_category_id": 0,
  • "duration": 0,
  • "user": {
    • "id": 24242
    },
  • "roleProfile": {
    • "id": 0
    }
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 2432,
    • "description": "Training at HQ",
    • "start_date": "2019-08-24",
    • "start_time": "14:15:22Z",
    • "end_date": "2019-08-24",
    • "end_time": "14:15:22Z",
    • "duration": 250,
    • "final": true,
    • "pending_outcomes": true,
    • "type": "Event",
    • "type_id": "231312",
    • "url": "http://example.com",
    • "can_edit": true,
    • "can_delete": true,
    • "category": {
      • "id": 442,
      • "name": "Training",
      • "default_duration": 30,
      • "types": {
        • "ad_hoc": true,
        • "rota": true,
        • "events": true,
        • "opportunities": true,
        • "tasks": true
        },
      • "sensitive": true,
      • "require_description": true,
      • "require_date_time": true,
      • "allow_future": true,
      • "created_at": "2019-08-24T14:15:22Z",
      • "updated_at": "2019-08-24T14:15:22Z",
      • "children": [
        • { }
        ]
      },
    • "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
        }
      },
    • "roleProfile": {
      • "id": 3253,
      • "name": "Volunteer v1",
      • "display_name": "Volunteer",
      • "primary": true,
      • "team": {
        • "id": "3521",
        • "display_name": "Headquarters",
        • "parent_id": 1424,
        • "name": "Headquarters",
        • "description": "string",
        • "geo_location": "string",
        • "catchment_area_id": "string",
        • "icon": "fa fa-building",
        • "show_on_public_site": false,
        • "show_on_near_me_map": false,
        • "ceiling_enabled": false,
        • "public_url": "http://example.com",
        • "hidden": false,
        • "disabled": false,
        • "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"
        }
      },
    • "outcomes": {
      • "example-custom-field-text": {
        • "value": "string"
        },
      • "example-custom-field-dropdown": {
        • "value": "string"
        }
      }
    }
}

Delete an activity

Delete an existing activity

Note: endpoint is available with "Activities" feature

Authorizations:
JWT
path Parameters
id
required
string

Responses

Response samples

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

User Activities

Activity listing

Retrieve a paginated response of activities for a specific user

Note: endpoint is available with "Activities" feature

Authorizations:
JWT
path Parameters
userId
required
string

Responses

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

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": 2432,
      • "description": "Training at HQ",
      • "start_date": "2019-08-24",
      • "start_time": "14:15:22Z",
      • "end_date": "2019-08-24",
      • "end_time": "14:15:22Z",
      • "duration": 250,
      • "final": true,
      • "pending_outcomes": true,
      • "type": "Event",
      • "type_id": "231312",
      • "url": "http://example.com",
      • "can_edit": true,
      • "can_delete": true,
      • "category": {
        • "id": 442,
        • "name": "Training",
        • "default_duration": 30,
        • "types": {
          • "ad_hoc": true,
          • "rota": true,
          • "events": true,
          • "opportunities": true,
          • "tasks": true
          },
        • "sensitive": true,
        • "require_description": true,
        • "require_date_time": true,
        • "allow_future": true,
        • "created_at": "2019-08-24T14:15:22Z",
        • "updated_at": "2019-08-24T14:15:22Z",
        • "children": [
          • { }
          ]
        },
      • "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
          }
        },
      • "roleProfile": {
        • "id": 3253,
        • "name": "Volunteer v1",
        • "display_name": "Volunteer",
        • "primary": true,
        • "team": {
          • "id": "3521",
          • "display_name": "Headquarters",
          • "parent_id": 1424,
          • "name": "Headquarters",
          • "description": "string",
          • "geo_location": "string",
          • "catchment_area_id": "string",
          • "icon": "fa fa-building",
          • "show_on_public_site": false,
          • "show_on_near_me_map": false,
          • "ceiling_enabled": false,
          • "public_url": "http://example.com",
          • "hidden": false,
          • "disabled": false,
          • "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"
          }
        },
      • "outcomes": {
        • "example-custom-field-text": {
          • "value": "string"
          },
        • "example-custom-field-dropdown": {
          • "value": "string"
          }
        }
      }
    ],
  • "meta": {
    • "pagination": {
      • "total": "string",
      • "count": "string",
      • "per_page": "string",
      • "current_page": "string",
      • "total_pages": "string",
      • "links": {
        • "next": "string",
        • "previous": "string"
        }
      }
    }
}

Show an activity

Retrieve a specific activities information for a user

Note: endpoint is available with "Activities" feature

Authorizations:
JWT
path Parameters
userId
required
string
activityId
required
string

Responses

Response Schema: application/json
object (Activity)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 2432,
    • "description": "Training at HQ",
    • "start_date": "2019-08-24",
    • "start_time": "14:15:22Z",
    • "end_date": "2019-08-24",
    • "end_time": "14:15:22Z",
    • "duration": 250,
    • "final": true,
    • "pending_outcomes": true,
    • "type": "Event",
    • "type_id": "231312",
    • "url": "http://example.com",
    • "can_edit": true,
    • "can_delete": true,
    • "category": {
      • "id": 442,
      • "name": "Training",
      • "default_duration": 30,
      • "types": {
        • "ad_hoc": true,
        • "rota": true,
        • "events": true,
        • "opportunities": true,
        • "tasks": true
        },
      • "sensitive": true,
      • "require_description": true,
      • "require_date_time": true,
      • "allow_future": true,
      • "created_at": "2019-08-24T14:15:22Z",
      • "updated_at": "2019-08-24T14:15:22Z",
      • "children": [
        • { }
        ]
      },
    • "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
        }
      },
    • "roleProfile": {
      • "id": 3253,
      • "name": "Volunteer v1",
      • "display_name": "Volunteer",
      • "primary": true,
      • "team": {
        • "id": "3521",
        • "display_name": "Headquarters",
        • "parent_id": 1424,
        • "name": "Headquarters",
        • "description": "string",
        • "geo_location": "string",
        • "catchment_area_id": "string",
        • "icon": "fa fa-building",
        • "show_on_public_site": false,
        • "show_on_near_me_map": false,
        • "ceiling_enabled": false,
        • "public_url": "http://example.com",
        • "hidden": false,
        • "disabled": false,
        • "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"
        }
      },
    • "outcomes": {
      • "example-custom-field-text": {
        • "value": "string"
        },
      • "example-custom-field-dropdown": {
        • "value": "string"
        }
      }
    }
}

Activity Categories

Activity category listing

Retrieve a paginated response of activity categories

Authorizations:
JWT
query Parameters
types
string
Enum: "ad_hoc" "rota" "events" "opportunities" "tasks"
Example: types=rota

Filter by activity category type (comma separated list)

user_id
integer
Example: user_id=21441

View categories as a specific user

Responses

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

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": 442,
      • "name": "Training",
      • "default_duration": 30,
      • "types": {
        • "ad_hoc": true,
        • "rota": true,
        • "events": true,
        • "opportunities": true,
        • "tasks": true
        },
      • "sensitive": true,
      • "require_description": true,
      • "require_date_time": true,
      • "allow_future": true,
      • "created_at": "2019-08-24T14:15:22Z",
      • "updated_at": "2019-08-24T14:15:22Z",
      • "children": [
        • { }
        ]
      }
    ],
  • "meta": {
    • "pagination": {
      • "total": "string",
      • "count": "string",
      • "per_page": "string",
      • "current_page": "string",
      • "total_pages": "string",
      • "links": {
        • "next": "string",
        • "previous": "string"
        }
      }
    }
}

Create a new activity category

Create a new activity category

Authorizations:
JWT
Request Body schema: application/json
id
integer

The unique id for this ActivityCategory record

name
string

The name of the activity category

default_duration
integer
Default: 0

Default activity duration

object
sensitive
boolean

Determine if this activity category should be treated as sensitive

require_description
boolean

Determine if activities associated with the category require a description

require_date_time
boolean

Determine if activities associated with the category require a date and time

allow_future
boolean

Determine if activities associated with the category can have a future start date

object
Array of objects

Responses

Response Schema: application/json
object (ActivityCategory)

Request samples

Content type
application/json
{
  • "id": 442,
  • "name": "Training",
  • "default_duration": 30,
  • "types": {
    • "ad_hoc": true,
    • "rota": true,
    • "events": true,
    • "opportunities": true,
    • "tasks": true
    },
  • "sensitive": true,
  • "require_description": true,
  • "require_date_time": true,
  • "allow_future": true,
  • "parent": {
    • "id": 0
    },
  • "outcomes": [
    • {
      • "id": 0,
      • "order_id": 0
      }
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 442,
    • "name": "Training",
    • "default_duration": 30,
    • "types": {
      • "ad_hoc": true,
      • "rota": true,
      • "events": true,
      • "opportunities": true,
      • "tasks": true
      },
    • "sensitive": true,
    • "require_description": true,
    • "require_date_time": true,
    • "allow_future": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "children": [
      • { }
      ]
    }
}

Show an activity category

Retrieve a specific activity categories information

Authorizations:
JWT
path Parameters
categoryId
required
string

Responses

Response Schema: application/json
object (ActivityCategory)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 442,
    • "name": "Training",
    • "default_duration": 30,
    • "types": {
      • "ad_hoc": true,
      • "rota": true,
      • "events": true,
      • "opportunities": true,
      • "tasks": true
      },
    • "sensitive": true,
    • "require_description": true,
    • "require_date_time": true,
    • "allow_future": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "children": [
      • { }
      ]
    }
}

Update an activity category

Update an existing activity category

Authorizations:
JWT
path Parameters
categoryId
required
string
Request Body schema: application/json
id
integer

The unique id for this ActivityCategory record

name
string

The name of the activity category

default_duration
integer
Default: 0

Default activity duration

object
sensitive
boolean

Determine if this activity category should be treated as sensitive

require_description
boolean

Determine if activities associated with the category require a description

require_date_time
boolean

Determine if activities associated with the category require a date and time

allow_future
boolean

Determine if activities associated with the category can have a future start date

object
Array of objects

Responses

Response Schema: application/json
object (ActivityCategory)

Request samples

Content type
application/json
{
  • "id": 442,
  • "name": "Training",
  • "default_duration": 30,
  • "types": {
    • "ad_hoc": true,
    • "rota": true,
    • "events": true,
    • "opportunities": true,
    • "tasks": true
    },
  • "sensitive": true,
  • "require_description": true,
  • "require_date_time": true,
  • "allow_future": true,
  • "parent": {
    • "id": 0
    },
  • "outcomes": [
    • {
      • "id": 0,
      • "order_id": 0
      }
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 442,
    • "name": "Training",
    • "default_duration": 30,
    • "types": {
      • "ad_hoc": true,
      • "rota": true,
      • "events": true,
      • "opportunities": true,
      • "tasks": true
      },
    • "sensitive": true,
    • "require_description": true,
    • "require_date_time": true,
    • "allow_future": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "children": [
      • { }
      ]
    }
}

Delete an activity category

Delete an existing activity category.

You can only delete an activity category that has no children.

Authorizations:
JWT
path Parameters
categoryId
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "400 Bad request",
  • "status_code": "400"
}

Feature restricted

Activity listing

Retrieve a paginated response of activities

Note: endpoint is available with "Activities" feature

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

Search by activity description

category
string
Example: category=23,532,676

Filter by activity category id (comma separated list)

start_date
string <date>

Filter by activity start date

end_date
string <date>

Filter by activity end date

user
string
Example: user=4234,4536,112

Filter by user id (comma separated list)

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

Order the results. 'a' for ascending, 'd' for descending

s
string
Default: "start_date"
Enum: "description" "category" "start_date" "updated"
Example: s=category

Sort the results

updated_after
string
Example: updated_after=2023-03-01 09:00:00

Filter by activity 'updated after' datetime. Filter also includes the current datetime, consider the longer version of the logic as 'updated at or after'

updated_before
string
Example: updated_before=2023-04-01 15:00:00

Filter by activity 'updated before' datetime. Filter also includes the current datetime, consider the longer version of the logic as 'updated at or before'

Responses

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

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": 2432,
      • "description": "Training at HQ",
      • "start_date": "2019-08-24",
      • "start_time": "14:15:22Z",
      • "end_date": "2019-08-24",
      • "end_time": "14:15:22Z",
      • "duration": 250,
      • "final": true,
      • "pending_outcomes": true,
      • "type": "Event",
      • "type_id": "231312",
      • "url": "http://example.com",
      • "can_edit": true,
      • "can_delete": true,
      • "category": {
        • "id": 442,
        • "name": "Training",
        • "default_duration": 30,
        • "types": {
          • "ad_hoc": true,
          • "rota": true,
          • "events": true,
          • "opportunities": true,
          • "tasks": true
          },
        • "sensitive": true,
        • "require_description": true,
        • "require_date_time": true,
        • "allow_future": true,
        • "created_at": "2019-08-24T14:15:22Z",
        • "updated_at": "2019-08-24T14:15:22Z",
        • "children": [
          • { }
          ]
        },
      • "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
          }
        },
      • "roleProfile": {
        • "id": 3253,
        • "name": "Volunteer v1",
        • "display_name": "Volunteer",
        • "primary": true,
        • "team": {
          • "id": "3521",
          • "display_name": "Headquarters",
          • "parent_id": 1424,
          • "name": "Headquarters",
          • "description": "string",
          • "geo_location": "string",
          • "catchment_area_id": "string",
          • "icon": "fa fa-building",
          • "show_on_public_site": false,
          • "show_on_near_me_map": false,
          • "ceiling_enabled": false,
          • "public_url": "http://example.com",
          • "hidden": false,
          • "disabled": false,
          • "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"
          }
        },
      • "outcomes": {
        • "example-custom-field-text": {
          • "value": "string"
          },
        • "example-custom-field-dropdown": {
          • "value": "string"
          }
        }
      }
    ],
  • "meta": {
    • "pagination": {
      • "total": "string",
      • "count": "string",
      • "per_page": "string",
      • "current_page": "string",
      • "total_pages": "string",
      • "links": {
        • "next": "string",
        • "previous": "string"
        }
      }
    }
}

Create a new activity

Create a new activity

Note: endpoint is available with "Activities" feature

Authorizations:
JWT
Request Body schema: application/json
description
string

The activity description

start_date
required
string <date>

Activity start date

start_time
string <time>

Activity start time

end_date
string <date>

Activity end date

end_time
string <time>

Activity end time

object

Activity category outcomes

activity_category_id
required
integer

Activity category id

duration
integer

Activity duration (in minutes)

object
object

Responses

Response Schema: application/json
object (Activity)

Request samples

Content type
application/json
{
  • "description": "Training at HQ",
  • "start_date": "2019-08-24",
  • "start_time": "14:15:22Z",
  • "end_date": "2019-08-24",
  • "end_time": "14:15:22Z",
  • "outcomes": {
    • "example-custom-field-text": {
      • "value": "string"
      },
    • "example-custom-field-dropdown": {
      • "value": "string"
      }
    },
  • "activity_category_id": 0,
  • "duration": 0,
  • "user": {
    • "id": 24242
    },
  • "roleProfile": {
    • "id": 0
    }
}

Response samples

Content type
application/json
No sample

Show an activity

Retrieve a specific activities information

Note: endpoint is available with "Activities" feature

Authorizations:
JWT
path Parameters
id
required
string

Responses

Response Schema: application/json
object (Activity)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 2432,
    • "description": "Training at HQ",
    • "start_date": "2019-08-24",
    • "start_time": "14:15:22Z",
    • "end_date": "2019-08-24",
    • "end_time": "14:15:22Z",
    • "duration": 250,
    • "final": true,
    • "pending_outcomes": true,
    • "type": "Event",
    • "type_id": "231312",
    • "url": "http://example.com",
    • "can_edit": true,
    • "can_delete": true,
    • "category": {
      • "id": 442,
      • "name": "Training",
      • "default_duration": 30,
      • "types": {
        • "ad_hoc": true,
        • "rota": true,
        • "events": true,
        • "opportunities": true,
        • "tasks": true
        },
      • "sensitive": true,
      • "require_description": true,
      • "require_date_time": true,
      • "allow_future": true,
      • "created_at": "2019-08-24T14:15:22Z",
      • "updated_at": "2019-08-24T14:15:22Z",
      • "children": [
        • { }
        ]
      },
    • "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
        }
      },
    • "roleProfile": {
      • "id": 3253,
      • "name": "Volunteer v1",
      • "display_name": "Volunteer",
      • "primary": true,
      • "team": {
        • "id": "3521",
        • "display_name": "Headquarters",
        • "parent_id": 1424,
        • "name": "Headquarters",
        • "description": "string",
        • "geo_location": "string",
        • "catchment_area_id": "string",
        • "icon": "fa fa-building",
        • "show_on_public_site": false,
        • "show_on_near_me_map": false,
        • "ceiling_enabled": false,
        • "public_url": "http://example.com",
        • "hidden": false,
        • "disabled": false,
        • "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"
        }
      },
    • "outcomes": {
      • "example-custom-field-text": {
        • "value": "string"
        },
      • "example-custom-field-dropdown": {
        • "value": "string"
        }
      }
    }
}

Update an activity

Update an existing activities details

Note: endpoint is available with "Activities" feature

Authorizations:
JWT
path Parameters
id
required
string
Request Body schema: application/json
description
string

The activity description

start_date
required
string <date>

Activity start date

start_time
string <time>

Activity start time

end_date
string <date>

Activity end date

end_time
string <time>

Activity end time

object

Activity category outcomes

activity_category_id
required
integer

Activity category id

duration
integer

Activity duration (in minutes)

object
object

Responses

Response Schema: application/json
object (Activity)

Request samples

Content type
application/json
{
  • "description": "Training at HQ",
  • "start_date": "2019-08-24",
  • "start_time": "14:15:22Z",
  • "end_date": "2019-08-24",
  • "end_time": "14:15:22Z",
  • "outcomes": {
    • "example-custom-field-text": {
      • "value": "string"
      },
    • "example-custom-field-dropdown": {
      • "value": "string"
      }
    },
  • "activity_category_id": 0,
  • "duration": 0,
  • "user": {
    • "id": 24242
    },
  • "roleProfile": {
    • "id": 0
    }
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 2432,
    • "description": "Training at HQ",
    • "start_date": "2019-08-24",
    • "start_time": "14:15:22Z",
    • "end_date": "2019-08-24",
    • "end_time": "14:15:22Z",
    • "duration": 250,
    • "final": true,
    • "pending_outcomes": true,
    • "type": "Event",
    • "type_id": "231312",
    • "url": "http://example.com",
    • "can_edit": true,
    • "can_delete": true,
    • "category": {
      • "id": 442,
      • "name": "Training",
      • "default_duration": 30,
      • "types": {
        • "ad_hoc": true,
        • "rota": true,
        • "events": true,
        • "opportunities": true,
        • "tasks": true
        },
      • "sensitive": true,
      • "require_description": true,
      • "require_date_time": true,
      • "allow_future": true,
      • "created_at": "2019-08-24T14:15:22Z",
      • "updated_at": "2019-08-24T14:15:22Z",
      • "children": [
        • { }
        ]
      },
    • "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
        }
      },
    • "roleProfile": {
      • "id": 3253,
      • "name": "Volunteer v1",
      • "display_name": "Volunteer",
      • "primary": true,
      • "team": {
        • "id": "3521",
        • "display_name": "Headquarters",
        • "parent_id": 1424,
        • "name": "Headquarters",
        • "description": "string",
        • "geo_location": "string",
        • "catchment_area_id": "string",
        • "icon": "fa fa-building",
        • "show_on_public_site": false,
        • "show_on_near_me_map": false,
        • "ceiling_enabled": false,
        • "public_url": "http://example.com",
        • "hidden": false,
        • "disabled": false,
        • "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"
        }
      },
    • "outcomes": {
      • "example-custom-field-text": {
        • "value": "string"
        },
      • "example-custom-field-dropdown": {
        • "value": "string"
        }
      }
    }
}

Delete an activity

Delete an existing activity

Note: endpoint is available with "Activities" feature

Authorizations:
JWT
path Parameters
id
required
string

Responses

Response samples

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

Activity listing

Retrieve a paginated response of activities for a specific user

Note: endpoint is available with "Activities" feature

Authorizations:
JWT
path Parameters
userId
required
string

Responses

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

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": 2432,
      • "description": "Training at HQ",
      • "start_date": "2019-08-24",
      • "start_time": "14:15:22Z",
      • "end_date": "2019-08-24",
      • "end_time": "14:15:22Z",
      • "duration": 250,
      • "final": true,
      • "pending_outcomes": true,
      • "type": "Event",
      • "type_id": "231312",
      • "url": "http://example.com",
      • "can_edit": true,
      • "can_delete": true,
      • "category": {
        • "id": 442,
        • "name": "Training",
        • "default_duration": 30,
        • "types": {
          • "ad_hoc": true,
          • "rota": true,
          • "events": true,
          • "opportunities": true,
          • "tasks": true
          },
        • "sensitive": true,
        • "require_description": true,
        • "require_date_time": true,
        • "allow_future": true,
        • "created_at": "2019-08-24T14:15:22Z",
        • "updated_at": "2019-08-24T14:15:22Z",
        • "children": [
          • { }
          ]
        },
      • "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
          }
        },
      • "roleProfile": {
        • "id": 3253,
        • "name": "Volunteer v1",
        • "display_name": "Volunteer",
        • "primary": true,
        • "team": {
          • "id": "3521",
          • "display_name": "Headquarters",
          • "parent_id": 1424,
          • "name": "Headquarters",
          • "description": "string",
          • "geo_location": "string",
          • "catchment_area_id": "string",
          • "icon": "fa fa-building",
          • "show_on_public_site": false,
          • "show_on_near_me_map": false,
          • "ceiling_enabled": false,
          • "public_url": "http://example.com",
          • "hidden": false,
          • "disabled": false,
          • "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"
          }
        },
      • "outcomes": {
        • "example-custom-field-text": {
          • "value": "string"
          },
        • "example-custom-field-dropdown": {
          • "value": "string"
          }
        }
      }
    ],
  • "meta": {
    • "pagination": {
      • "total": "string",
      • "count": "string",
      • "per_page": "string",
      • "current_page": "string",
      • "total_pages": "string",
      • "links": {
        • "next": "string",
        • "previous": "string"
        }
      }
    }
}

Show an activity

Retrieve a specific activities information for a user

Note: endpoint is available with "Activities" feature

Authorizations:
JWT
path Parameters
userId
required
string
activityId
required
string

Responses

Response Schema: application/json
object (Activity)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 2432,
    • "description": "Training at HQ",
    • "start_date": "2019-08-24",
    • "start_time": "14:15:22Z",
    • "end_date": "2019-08-24",
    • "end_time": "14:15:22Z",
    • "duration": 250,
    • "final": true,
    • "pending_outcomes": true,
    • "type": "Event",
    • "type_id": "231312",
    • "url": "http://example.com",
    • "can_edit": true,
    • "can_delete": true,
    • "category": {
      • "id": 442,
      • "name": "Training",
      • "default_duration": 30,
      • "types": {
        • "ad_hoc": true,
        • "rota": true,
        • "events": true,
        • "opportunities": true,
        • "tasks": true
        },
      • "sensitive": true,
      • "require_description": true,
      • "require_date_time": true,
      • "allow_future": true,
      • "created_at": "2019-08-24T14:15:22Z",
      • "updated_at": "2019-08-24T14:15:22Z",
      • "children": [
        • { }
        ]
      },
    • "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
        }
      },
    • "roleProfile": {
      • "id": 3253,
      • "name": "Volunteer v1",
      • "display_name": "Volunteer",
      • "primary": true,
      • "team": {
        • "id": "3521",
        • "display_name": "Headquarters",
        • "parent_id": 1424,
        • "name": "Headquarters",
        • "description": "string",
        • "geo_location": "string",
        • "catchment_area_id": "string",
        • "icon": "fa fa-building",
        • "show_on_public_site": false,
        • "show_on_near_me_map": false,
        • "ceiling_enabled": false,
        • "public_url": "http://example.com",
        • "hidden": false,
        • "disabled": false,
        • "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"
        }
      },
    • "outcomes": {
      • "example-custom-field-text": {
        • "value": "string"
        },
      • "example-custom-field-dropdown": {
        • "value": "string"
        }
      }
    }
}