API Endpoints: Lookup Activity Categories
Enterprise: No access. Activity categories are only available at the organization level.
Organization: https://api.betterimpact.com/v1/organization/look_up/activity_categories
Parameters:
None.
Query Parameters:
None.
Response:
An array of activity category documents. See below.
| activity_category_id | Integer | The ID of the activity category. |
| name | String | The name of the activity Category |
API Endpoints: Lookup Organizations
Enterprise: https://api.betterimpact.com/v1/enterprise/look_up/organizations
Organization: No access. Organizations are only available at the enterprise level.
Parameters:
None.
Query Parameters:
None.
Response:
An array of organization documents. See below.
| organization_id | Integer | The ID of the organization |
| name | String | The name of the organization |
| active | Boolean | Whether or not the organization is active |
| date_created | DateTime | The datetime when the organization was created, ISO 8601 UTC format. |
| date_updated | DateTime | The datetime when the organization was last updated, ISO 8601 UTC format. |
| has_administrator_module | Boolean | Whether or not the organization has the administrator module enabled |
| has_client_module | Boolean | Whether or not the organization has the client module enabled |
| has_donor_module | Boolean | Whether or not the organization has the donor module enabled |
| has_member_module | Boolean | Whether or not the organization has the member module enabled |
| has_volunteer_module | Boolean | Whether or not the organization has the volunteer module enabled |
| enterprise_region_id | Integer | The ID of the region that the enterprise exists in |
| enterprise_region_name | String | The name of the region that the enterprise exists in |
API Endpoints: Lookup Activity Report Groups
Enterprise: https://api.betterimpact.com/v1/enterprise/look_up/activity_report_groups
Organization: No access. Activity report groups are only available at the enterprise level.
Parameters:
None.
Query Parameters:
None.
Response:
An array of activity report group documents. See below.
| activity_report_group_id | Integer | The ID of the activity report group. |
| name | String | The name of the activity report group |
API Endpoints: Lookup Qualifications
Enterprise: https://api.betterimpact.com/v1/enterprise/look_up/qualifications
Organization: https://api.betterimpact.com/v1/organization/look_up/qualifications
Parameters:
None.
Query Parameters:
None.
Response:
An array of qualification documents. See below.
| qualification_id | Integer | The ID of the qualification |
| name | String | The name of the qualification |
| expires | Boolean | Whether or not the qualification expires |
| match_type | String | The type of match to achieve the qualification. Options are: “exact” and “ranked” |
| display_order | Integer | Ascending numeric display order. Allows ordering the list in the same way it is displayed in Better Impact |
| belongs_to_enterprise | Boolean | Whether or not the qualification belongs to an enterprise. Enterprise qualifications are shown at the organization level. |
| options | Array of qualification option objects | See table below. |
Qualification option object
| qualification_option_id | Integer | The ID of the qualification option |
| description | String | A string that describes the qualification option |
| rank | Integer | Which rank this qualification option is (in order) |
API Endpoints: Lookup Custom Fields
Enterprise: https://api.betterimpact.com/v1/enterprise/look_up/custom_fields
Organization: https://api.betterimpact.com/v1/organization/look_up/custom_fields
Parameters:
None.
Query Parameters:
None.
Response:
An array of custom field documents. See below.
| custom_field_id | Integer | The ID of the custom field |
| name | String | The name of the custom field |
| display_order | Integer | Ascending numeric display order. Allows ordering the list in the same way it is displayed in Better Impact. The orders start at 1 inside each category. |
| belongs_to_enterprise | Boolean | Whether or not this custom field belongs to an enterprise. Enterprise custom fields are shown in the organization list. |
| custom_field_category_id | Integer | The ID of the category that this custom field resides in |
| custom_field_category_name | String | The name of the category that the custom field resides in. |
| custom_field_category_display_order | Integer | Ascending numeric display order. Allows ordering the list in the same way it is displayed in Better Impact |
| options | Array of custom field dropdown option objects | See below. Only included for dropdown custom fields. |
Custom field option object
| custom_field_option_id | Integer | The ID of the custom field option |
| description | String | A string that describes the custom field option |
API Endpoints: Feedback Fields
Enterprise: https://api.betterimpact.com/v1/enterprise/look_up/feedback_fields
Organization: https://api.betterimpact.com/v1/organization/look_up/feedback_fields
Parameters:
None.
Query Parameters:
None.
Response:
An array of feedback field documents. See below.
| feedback_field_id | Integer | The ID of the feedback field |
| name | String | The name of the feedback field |
| prompt | String | The prompt that is displayed to the volunteer when filling out this feedback field |
| active | Boolean | Whether or not this feedback field is active |
| required | Boolean | Whether or not this feedback field is required |
| belongs_to_enterprise | Boolean | Whether or not this feedback field belongs to an enterprise. Enterprise feedback fields are shown on the organization list |
| options | Array of feedback field option objects | See below. Only included for dropdown type feedback fields |
Feedback field option object
| feedback_field_option_id | Integer | The ID of the feedback field option |
| description | String | A string that describes the feedback field option |