Assemble Developer Portal

API docs by Redocly

Organisation (3.0)

Download OpenAPI specification:Download

This documentation describes how to retrieve and update information relating to your organisation.

Assemble is a powerful volunteer management software that gives organisations lots of flexibility and control over how their users interact with it. Changing organisation settings can have a big impact on how your Assemble works. Always ensure that you understand the impact and concequences of any change you may make to your organisation.

The organisation endpoints will change and include/exclude information depending on the authenticated users permissions.

You can find our more information on how to configure your organisation within our support centre.

Organisation

Basic organisation details

Retrieve the basic information for the current organisation

Responses

Response Schema: application/json
object (OrganisationBasic)

Response samples

Content type
application/json
{
  • "data": {
    • "name": "My Organisation",
    • "slug": "my-organisation",
    • "timezone": "Europe/London",
    • "date_format": "j F Y",
    • "date_format_moment": "DD MMMM YYYY",
    • "date_input_format": "d/m/Y",
    • "time_format": "H:i",
    • "time_input_format": "H:i",
    • "ga_property_id": "string",
    • "web_url": "string",
    • "api_url": "string",
    • "forum_url": "string",
    • "minor_age": "18",
    • "senior_age": "0",
    • "sso_enabled": true
    }
}

Update organisation

Update the current organisations information.

Your permissions will determine what information you can view and update.

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

The name of the organisation

date_format
string
Default: "j F Y"

Display format of dates

date_format_moment
string
Default: "DD MMMM YYYY"

Display format of days (momentjs)

date_input_format
string
Default: "d/m/Y"

Date input format

time_format
string
Default: "H:i"

Time format

time_input_format
string
Default: "H:i"

Time input format

ga_property_id
string or null

Google analytics id

minor_age
string
Default: "18"

Organisations minor age

senior_age
string
Default: "0"

Organisations senior age

sso_enabled
boolean

Determine if SSO is enabled

twitter_handle
string

Twitter handle

twitter_type
string

Twitter type

twitter_list
string

Twitter list

facebook_handle
string

Facebook handle

youtube_list
string

Youtube list

youtube_type
string

Youtube type

public_site_enabled
string

Determine if the public site is enabled

ios_store_link
string

iOS app store link

play_store_link
string

Play store link

max_on_call_duration
string

Max on call duration

default_on_call_duration
string

Default on call duration

dpo_name
string

Data protection officer name

dpo_email
string

Data protection officer email

dpo_telephone
string

Data protection officer telephone

dpo_address
string

Data protection officer address

anonymise_users_after
string

Amount of time users are anonymised after (months)

auth0_enabled
string

Determine if auth0 is enabled

expenses_max_age
integer

Maximum age of expenses

expenses_submission_rules
string

Expenses submission rules

expenses_require_authorisation
boolean

Determine if expenses require authorisation

expenses_allow_authoriser
boolean

Determines if a user can choose a specific person to approve the expense

expenses_submission_declaration
string

Expenses submission declaration

expenses_submission_declaration_supervisor
string

Expenses submission declaration for supervisors

expenses_submission_email
string

Expenses submission email address

cname
string

Organisation cname

allow_indexers
string

Determine if we allow indexers on the public site

anonymise_closed_applications_after
string

Amount of time closed applications are anonymised after (months)

anonymise_cleared_applications_after
string

Amount of time cleared applications are anonymised after (months)

login_text
string

Text to display on the login screen

outdated_browser_text
string

Text to display on unsupported browsers

email_header_colour
string

Email header colour

email_header_text_colour
string

Email header text colour

email_link_colour
string

Email link colour

email_button_colour
string

Email button colour

email_button_text_colour
string

Email button text colour

branding_level
string

Branding level

branding_settings
string

Branding settings

zendesk_organisation_id
string

Zendesk organisation id

zendesk_enabled
string

Determine if zendesk is enabled

zendesk_subdomain
string

Zendesk subdomain

zendesk_username
string

Zendesk username

zendesk_token_set
string

Determine if the zendesk token has been set

support_email
string

Organisations support email address

vetting_email
string

Vetting email address

web_hook_settings
string

Web hook settings

auth0_domain
string

Auth0 domain

auth0_client_id
string

Auth0 client id

auth0_client_secret_set
string

Determine if the Auth0 client secret has been set

return_tasks_to_owner
string

Determine if tasks are returned to the owner

moodle_enabled
string

Determine if moodle integration is enabled

moodle_url
string

Moodle URL

moodle_token
string

Moodle token

moodle_auth_token
string

Moodle auth token

talentlms_enabled
string

Determine if TalentLMS is enabled

barcode_prefix
string

Barcode prefix

barcode_type
string

Barcode type

access_password
string

Access password (staging only)

statuses
string
object (Image)
object (Image)

Responses

Response Schema: application/json
object (OrganisationBasic)

Detailed organisation information.

Information returned will depend on the authenticated users level of permission.

Request samples

Content type
application/json
{
  • "name": "My Organisation",
  • "date_format": "j F Y",
  • "date_format_moment": "DD MMMM YYYY",
  • "date_input_format": "d/m/Y",
  • "time_format": "H:i",
  • "time_input_format": "H:i",
  • "ga_property_id": "string",
  • "minor_age": "18",
  • "senior_age": "0",
  • "sso_enabled": true,
  • "twitter_handle": "string",
  • "twitter_type": "string",
  • "twitter_list": "string",
  • "facebook_handle": "string",
  • "youtube_list": "string",
  • "youtube_type": "string",
  • "public_site_enabled": "string",
  • "ios_store_link": "string",
  • "play_store_link": "string",
  • "max_on_call_duration": "string",
  • "default_on_call_duration": "string",
  • "dpo_name": "string",
  • "dpo_email": "string",
  • "dpo_telephone": "string",
  • "dpo_address": "string",
  • "anonymise_users_after": "string",
  • "auth0_enabled": "string",
  • "expenses_max_age": 0,
  • "expenses_submission_rules": "string",
  • "expenses_require_authorisation": true,
  • "expenses_allow_authoriser": true,
  • "expenses_submission_declaration": "string",
  • "expenses_submission_declaration_supervisor": "string",
  • "expenses_submission_email": "string",
  • "cname": "string",
  • "allow_indexers": "string",
  • "anonymise_closed_applications_after": "string",
  • "anonymise_cleared_applications_after": "string",
  • "login_text": "string",
  • "outdated_browser_text": "string",
  • "email_header_colour": "string",
  • "email_header_text_colour": "string",
  • "email_link_colour": "string",
  • "email_button_colour": "string",
  • "email_button_text_colour": "string",
  • "branding_level": "string",
  • "branding_settings": "string",
  • "zendesk_organisation_id": "string",
  • "zendesk_enabled": "string",
  • "zendesk_subdomain": "string",
  • "zendesk_username": "string",
  • "zendesk_token_set": "string",
  • "support_email": "string",
  • "vetting_email": "string",
  • "web_hook_settings": "string",
  • "auth0_domain": "string",
  • "auth0_client_id": "string",
  • "auth0_client_secret_set": "string",
  • "return_tasks_to_owner": "string",
  • "moodle_enabled": "string",
  • "moodle_url": "string",
  • "moodle_token": "string",
  • "moodle_auth_token": "string",
  • "talentlms_enabled": "string",
  • "barcode_prefix": "string",
  • "barcode_type": "string",
  • "access_password": "string",
  • "statuses": "string",
  • "header_logo": {
    • "id": 45645,
    • "thumbnails": { }
    },
  • "logo": {
    • "id": 45645,
    • "thumbnails": { }
    }
}

Response samples

Content type
application/json
No sample

Full organisation details

Retrieve detailed information about the current organisation

Authorizations:
JWT

Responses

Response Schema: application/json
object (OrganisationBasic)

Detailed organisation information.

Information returned will depend on the authenticated users level of permission.

Response samples

Content type
application/json
{}