API Documentation
[alert heading=”IMPORTANT:” type=”alert-danger” block=”false” close=”false”]The target audience for this topic is Technical and IT staff in your organization.[/alert]
What is an API Key?
In Volunteer Impact, an API Key enables you to request profile data from Volunteer Impact to be used in an external program or application.
Sample API Client
A sample API Client (implemented in C#) is available at: https://github.com/BetterImpact/ApiClient.
Authentication
Our API uses HTTP basic authentication over HTTPS.
API Endpoints: Listing Users
Enterprise: https://api.betterimpact.com/v1/enterprise/users/
Organization: https://api.betterimpact.com/v1/organization/users/
Parameters:
None.
Query parameters:
[table id=13 /]
Response parameters:
[table id=4 /]
Header Properties:
[table id=5 /]
API Endpoints: Single User
Enterprise: https://api.betterimpact.com/v1/enterprise/users/{user_id}
Organization: https://api.betterimpact.com/v1/organization/users/{user_id}
Parameters:
[table id=6 /]
Query parameters:
None.
Response:
A single user document, containing its own fields, as well as membership documents, custom fields documents, and qualifications documents.
- Qualifications will only be included if your API user credentials have access to the Volunteer module.
- Custom Fields will only be included if your API user credentials have access to at least one module that is specified on the custom field (the intersection between your modules and the ones on the custom field.).
User Properties:
[table id=7 /]
Membership Properties:
[table id=8 /]
Custom Field Properties:
[table id=9 /]
Qualification Properties:
[table id=10 /]
Background Check Properties:
[table id=11 /]
Custom Field Files
Enterprise: https://api.betterimpact.com/v1/enterprise/users/{user_id}/custom_fields/{user_custom_field_id}/file
Organization: https://api.betterimpact.com/v1/organization/users/{user_id}/custom_fields/{user_custom_field_id}/file
- These URLS are specified as the value of the custom field when custom fields are retrieved as part of a single, or list of users.
Parameters:
[table id=12 /]
Query Parameters:
None.
Response:
The file that was requested, as a byte stream.
Other Tutorials Related to API
Looking for something else?
[contentblock id=2]