You can use our API documentation to see the output format of any of our endpoints - either in our sandbox, or to see the data in your live environment.
Use one of the following URLs to open the API reference:
Test system: https://demo.360alumni.com/api/doc/
Your system: https://<<your-system>>.360alumni.com/api/doc</your-system>
Before you can access either environment, you'll need to get an API key, which you use to authenticate with the API. Your account manager at 360Alumni will coordinate with our Client Integrations Team to create an API key for your organization. Once you have the key, connecting to the 360Alumni API is easy. For each API request, simply include your API key as the value in an HTTP header named x-api-key. See the examples for details.
The following steps walk you through the basics to get started using the API.
1. Click an API method to display its reference documentation.
For example, click GET /api/campaigns/.
An API Reference Page
Note, for a GET /api/campaigns/ request the page parameter indicates which set of results to return. The default page value is 1 representing the first 100 results.
A page represents up to 100 results returned in a JSON array.
2. Click Sandbox to display a form for entering values and trying the request.
3. Enter the headers.
Type "x-api-key" (without quotes) in the "Key" field.
a. Enter your key in the "value" field.
Be sure you are using the correct URL. A key for the test api will not work in your system, and vice-versa.
b. Enter any Requirements, and click "Try!"
An API Sandbox Test Form:
4. Click Try! to execute the API request.
5. The display shows results such as the following:
Note the following about the results:
Request URL: Shows what executed.
Response Headers: Contains messages about the success or failure of the request.
Response Body: Contains a JSON array of the results, in this case an array of Campaign Objects.
Other API requests use the Donation Object or the User Object.
Curl Command Line: Contains a form of the request that you can copy and paste to execute at the command line or in scripts.
curl -X "GET" -H "Accept:\ application/json" -H "Content-type:\ application/json" -H "x-api-key:\ <<your-api-key>>" /api/campaigns</your-api-key>
6. Each campaign object in the returned array is identified with an id value. Note the first object in the array above contains the id value 17.
7. To get a single campaign object, click GET /api/campaigns/{id}.
This API request requires an integer id parameter that represents the compaign identifier.
The Reference Page for GET /api/campaigns/{id}
8. Click Sandbox and enter the following to execute the API request:
a. Enter your API key in an HTTP request header.
b. Enter an id parameter value representing the campaign you want to get.
c. Click Try! to execute the API request.
The Sandbox Form for a GET /api/campaigns/{id} Request
9. The Response Body shows the results in a formatted JSON Campaign Object.
The Response Body, Formatted
Click Raw to show the JSON object without formatting, suitable for copying and using in code.
The Response Body, Unformatted
Name
Type
Required
Description
Format
amount
number
Required
Words
campaign_id
number
Required
Words
created_at
string
Words
Words
first_name
string
Words
id
string
Words
Words
last_name
string
Words
user_id
number
Words
The following JSON Donation object is suitable for copying.
Name
Type
Required
Description
Format
ambassadors
array of ambassador objects
optional
See ambassador object below.
author
author object
optional
See the author object below.
createdAt
string
The date this campaign record was created.
.YYYY-MM-DD Year-Month-Day
details
string
The detailed description of the organisation and campaign.
end_date
string
The date the campaign ends.
.YYYY-MM-DD Year-Month-Day
goal
number
The monetary goal for the campaign,
id
number
Required
A unique ID for this campaign auto-generated by 360Alumni.
image
string
A URL to an image representing the campaign or organization.
URL
islnactive
number
The status of whether the campaign is active. 1: is active 0: is inactive
raised
number
The monetary amount raised by the campaign.
start_date
string
The date the campaign starts.
.YYYY-MM-DD Year-Month-Day
thank_you_message
string
A thank-you message that can be sent to donors.
title
string
Required
The title for the campaign.
type
string
The type of the campaign length such as short or ongoing.
updatedAt
string
The date this campaign record was modified.
.YYYY-MM-DD Year-Month-Day
Name
Type
Required
Format
user_id
number
Required
The user ID identifying an ambassador for the campaign generated by 360Alumni. See also the User Object.
first_name
string
Required
The ambassador's first name.
last_name
string
Required
The ambassador's last name.
JSON Field
(* = Required)
JSON Type (size)
Valid Values
Description
Format
Type
Format
Description
Date
YYYY-MM-DD
Year-Month-Day. Example: 2018-03-21
Learn
Learn how to use the API
API
Try the API
