REST API Reference

User List

Use this endpoint to obtain a list of all users on your domain with a variety of the users' data. Users who are active, pending, imported, or inactive will be included.

Request

URL https://api2.galaxydigital.com/volunteer/user/list/
Method: POST or GET
Request Parameters
Parameter Type Details
key* string Your unique API key. This parameter is required.
offset integer Number of records you wish to skip before your result set starts. This is used for pagination.
limit integer This will limit the number of records returned. The maximum number you can return at one time is 50.
where array This will filter results where a specific item is equal to the value passed. e.g. where[firstName]=Jim
like array This will filter results where a specific item is contains the value passed. e.g. like[lastName]=oe, which will pick up names like "Doe" and "Hoehn"
status string This will filter results based on the user's current status. You may use 'active', 'inactive', 'pending', or 'imported'
sinceId integer This will return users with a user id that is greater than the id specified.
sinceDate Format: yyyy-mm-dd date This will return users that have been added to the system since the date specified.
return array Request additional user data as part of the result set. You may use "extras", "tags", "qualifications", and/or "favoriteAgencies". e.g. return[]='extras' return[]='tags'

Return Structure

Variable Type Description
id number Unique identifier for the user record.
referenceId string/null Remote unique identifier for the user record.
firstName string/null First name for the user.
lastName string/null Last name for the user.
middleName string Middle name for the user.
email string Valid email address for the user.
address string Street address for the user.
address2 string Secondary address for the user. e.g. Appt 2
city string City for the user
state string Two letter state abbreviation. e.g. NY
postal string Zip/Postal code for the user
status string Current status of user.
dateAdded string The time, in ISO 8601 format, at which the user was created.
dateUpdated string The time, in ISO 8601 format, at which the user was updated.

Example Response

    
Content-Type: application/json
{ "rows":115, "offset":0, "limit":20, "message":"ok", "data":[ { "id":"613924" "status":"active" "referenceId":"" "firstName":"Mario" "lastName":"Kibler" "middleName":"" "email":"Mario.B.Kibler@example.com" "mobile":"1-415-555-7124" "phone":"360-555-7196" "company":"ACME" "gender":"Male" "birthdate":"1983-09-27" "address":"2350 Chardonnay Drive" "address2":"" "city":"Beaverton" "state":"WA" "postal":"97006" "dateAdded":"2015-03-02T11:00:51-06:00" "dateUpdated":"2016-05-17T14:15:36-05:00" "dateLastLogin":"" } ] }

User Get By ID

Use this endpoint to obtain information about a single user on your site. The user must be a active, pending, imported, or inactive, and they must also be on your site. Submit the `id` parameter to complete the get, where the id is the user ID on your site.

Request

URL https://api2.galaxydigital.com/volunteer/user/get/
Method: POST or GET
Request Parameters
Parameter Type Details
key* string Your unique API key. This parameter is required.
id mixed Unique identifier of record you wish to have returned.
idType string Type of unique identifier you will be using to request the user record. You may use "id", "email", or "referenceId". The default is "id", which is the GetConnected user ID.
getLogin boolean Request to create and return one-click login for this user.
return array Request additional user data as part of the result set. You may use "extras", "tags", "interests", "stats", "qualifications", and/or "favoriteAgencies". e.g. return[]='extras' return[]='tags'

Return Structure

Return label Type Description
id number Unique identifier for the user record.
status string Current status of the user.
referenceId string/null Remote unique identifier for the user record.
firstName string/null First name for the user.
lastName string/null Last name for the user.
middleName string Middle name for the user.
email string Valid email address for the user.
mobile string Mobile phone number for the user.
phone string Phone number for the user.
company string Company as defined by the user.
gender string Gender of the user.
birthdate string Birthdate as defined by the user.
address string Street address for the user.
address2 string Secondary address for the user. e.g. Appt 2
city string City for the user
state string Two letter state abbreviation. e.g. NY
postal string Zip/Postal code for the user
dateAdded string The time, in ISO 8601 format, at which the user was created.
dateUpdated string The time, in ISO 8601 format, at which the user was updated.
dateLastLogin string The time, in ISO 8601 format, at which the user last logged in.
link string/null Link to be used that will auto-log user into the site. Note: must pass "getLogin" parameter in request to receive.
expires string/null The time, in ISO 8601 format, that this link will expire.
now string/null The current server time in ISO 8601 format.

Example Response

Content-Type: application/json
{ "message":"ok", "data":{ "id":"123456", "status":"active", "referenceId":null, "firstName":"Paula", "lastName":"Jones", "middleName":"Kelly", "email":"pjones@example.com", "mobile":"615-555-1212", "phone":"978-555-1212", "gender":"Female", "address":"1212 Walking Ln.", "address2":"Appt 2b", "city":"Schenectady", "state":"NY", "postal":"12345", "dateAdded":"2010-11-29T15:44:25-05:00", "dateUpdated":"2013-02-09T11:11:25-05:00", "favoriteAgencies":[ { "agencyId":"25148", "agencyName":"The Learning Center" }, { "agencyId":"20596", "agencyName":"Cancer Association of Equestria" } ] } }

Add New User

You can add a user to your site with this POST. The user will have a status of "pending," a source of "API Insert," and a date added and updated equal to the current date and time. The system will check to make sure that the email used is not already on your site.

Request

URL https://api2.galaxydigital.com/volunteer/user/add/
Method: POST
Note: If you are trying to add a user that already exists in the system, the API will simply return the data for that user.
Request Parameters
Parameter Type Details
key* string Your unique API key. This parameter is required.
referenceId string Remote unique identifier for the user record.
firstName* string First name for the user.
lastName* string Last name for the user.
middleName string Middle name for the user.
email* string Valid email address for the user.
address string Street address for the user.
address2 string Secondary address for the user. e.g. Appt 2
city string City for the user
state string Two letter state abbreviation. e.g. NY
postal string Zip/Postal code for the user
password* string Desired password for the user.
status string Set current status of user. (active, pending, or inactive)
tagsAdd string Comma separated list of words. (fish,cake,dishes)
extraAdd array/null An array of supplemental information you wish to store with the user record. e.g. extraAdd['pet'] = 'fish', extraAdd['carType'] = 'van'
getLogin true/null Request to create and return one-click login for this user.
return array/null Request additional user data as part of the return result set. You may use "extras", "tags", and/or "favoriteAgencies". e.g. return[]='extras' return[]='tags'
welcomeEmail true/null If set to true a "welcome" email message will be sent to a new user.

Return Structure

Return Structure Type Description
id number Unique identifier for the user record.
referenceId string Remote unique identifier for the user record.
firstName string First name for the user.
lastName string Last name for the user.
middleName string Middle name for the user.
email string Valid email address for the user.
mobile string Cell phone number for the user.
phone string Phone number for the user.
gender string Gender for the user. e.g. Male or Female
address string Street address for the user.
address2 string Secondary street address for the user.
city string City for the user.
state string Two character state abbreviation for the user. e.g. NH or TN
postal string Postal/Zip code for the user.
status string Current status of user.
dateAdded string The time, in ISO 8601 format, at which the user was created.
dateUpdated string The time, in ISO 8601 format, at which the user was updated.
link string Link to be used that will auto-log user into the site. Note: must pass "getLogin" parameter in request to receive.
expires string The time, in ISO 8601 format, that this link will expire.
now string The current server time in ISO 8601 format.

Example Response

Content-Type: application/json
{ "message":"ok", "data":{ "id":"123456", "status":"active", "referenceId":null, "firstName":"Paula", "lastName":"Jones", "middleName":"Kelly", "email":"pjones@example.com", "mobile":"615-555-1212", "phone":"978-555-1212", "gender":"Female", "address":"1212 Walking Ln.", "address2":"Appt 2b", "city":"Schenectady", "state":"NY", "postal":"12345", "dateAdded":"2010-11-29T15:44:25-05:00", "dateUpdated":"2013-02-09T11:11:25-05:00", "status":"active", "favoriteAgencies":[ { "agencyId":"25148", "agencyName":"The Learning Center" }, { "agencyId":"20596", "agencyName":"Cancer Association of Equestria" } ] } }

Update Existing User

You can update a user's data with this POST. Supply as many changes as you like, and they will all replace current values. The user must be on your site and have a status of active, pending, imported, or inactive.

Request

URL https://api2.galaxydigital.com/volunteer/user/update/
Method: POST
Request Parameters
Parameter Type Details
key* string Your unique API key. This parameter is required.
id* string Unique identifier for the user record.
referenceId string Remote unique identifier for the user record.
firstName* string/null First name for the user.
lastName* string/null Last name for the user.
middleName string Middle name for the user.
email* string Valid email address for the user.
address string/null Street address for the user.
address2 string/null Secondary address for the user. e.g. Appt 2
city string/null City for the user
state string/null Two letter state abbreviation. e.g. NY
postal string/null Zip/Postal code for the user
password string/null Desired password for the user.
status string/null Set current status of user. (active, pending, or inactive)
tagsAdd string/null Comma separated list of tags to add to user.
tagsRemove string/null Comma separated list of tags to remove from user.
extraAdd array/null An array of supplemental information you wish to store with the user record. e.g. extraAdd['pet'] = 'fish', extraAdd['carType'] = 'van'
extraUpdate array/null An array of supplemental information you wish to update on the user record. e.g. extraUpdate['pet'] = 'dog', extraUpdate['computer'] = 'laptop'. Note, if the record does not exist, one will be created.
extraRemove array/null An array of supplemental information you wish to remove from the user record. e.g. extraRemove[] = 'pet', extraRemove[] = 'computer'
getLogin true/null Request to create and return one-click login for this user.
return array/null Request additional user data as part of the return result set. You may use "extras", "tags", and/or "favoriteAgencies". e.g. return[]='extras' return[]='tags'

Return Structure

Return Structure Type Description
id number Unique identifier for the user record.
referenceId string/null Remote unique identifier for the user record.
firstName string/null First name for the user.
lastName string/null Last name for the user.
middleName string Middle name for the user.
email string Valid email address for the user.
mobile string/null Cell phone number for the user.
phone string/null Phone number for the user.
gender string/null Gender for the user. e.g. Male or Female
address string/null Street address for the user.
address2 string/null Secondary street address for the user.
city string/null City for the user.
state string/null Two character state abbreviation for the user. e.g. NH or TN
postal string/null Postal/Zip code for the user.
status string Current status of user.
dateAdded string The time, in ISO 8601 format, at which the user was created.
dateUpdated string The time, in ISO 8601 format, at which the user was updated.
link string/null Link to be used that will auto-log user into the site. Note: must pass "getLogin" parameter in request to receive.
expires string/null The time, in ISO 8601 format, that this link will expire.
now string/null The current server time in ISO 8601 format.

Example Response

Content-Type: application/json
{ "message":"ok", "data":{ "id":"123456", "status":"active", "referenceId":null, "firstName":"Paula", "lastName":"Jones", "middleName":"Kelly", "email":"pjones@example.com", "mobile":"615-555-1212", "phone":"978-555-1212", "gender":"Female", "address":"1212 Walking Ln.", "address2":"Appt 2b", "city":"Schenectady", "state":"NY", "postal":"12345", "dateAdded":"2010-11-29T15:44:25-05:00", "dateUpdated":"2013-02-09T11:11:25-05:00", "status":"active", "favoriteAgencies":[ { "agencyId":"25148", "agencyName":"The Learning Center" }, { "agencyId":"20596", "agencyName":"Cancer Association of Equestria" } ] } }

User One-Click Login

This endpoint produce a hyperlink that the user can follow to log into your site. The user must be on your site and have a status of active. The link will be valid for 15 minutes.

Return Structure Type Description
link string Link to be used that will auto-log user into the site.
expires string The time, in ISO 8601 format, at which the link will expire.
now string Current time, in ISO 8601 format, for when the request was made.

Request

URL https://api2.galaxydigital.com/volunteer/user/oneclick/
Method: POST or GET
Request Parameters
Parameter Details
key* Your unique API key. This parameter is required.
id* Unique identifier of user for whom you wish to generate a one-click login link.

Example Response

Content-Type: application/json
{ "message":"ok", "data":{ "link":"http://www.example.com/users/oneclick/badb6c834899c356ee998a5231e578a5/", "expires":"2014-01-21T18:08:33-06:00", "now":"2014-01-21T18:23:33-06:00" } }

User Authenticate

This endpoint can be used to log a user into the system by passing their email and password as part of the post. The email must match a user on your site, and the user must be active.

Request

URL https://api2.galaxydigital.com/volunteer/user/authenticate/
Method: POST
Request Parameters
Parameter Type Details
key* string Your unique API key. This parameter is required.
email mixed Email address for record you wish to have returned.
password string Password for record you wish to have returned.
getLogin boolean Request to create and return one-click login for this user.
return array Request additional user data as part of the result set. You may use "extras", "tags", "interests", and/or "favoriteAgencies". e.g. return[]='extras' return[]='tags'

Return Structure

Return label Type Description
id number Unique identifier for the user record.
referenceId string/null Remote unique identifier for the user record.
firstName string/null First name for the user.
lastName string/null Last name for the user.
middleName string Middle name for the user.
email string Valid email address for the user.
address string Street address for the user.
address2 string Secondary address for the user. e.g. Appt 2
city string City for the user
state string Two letter state abbreviation. e.g. NY
postal string Zip/Postal code for the user
dateAdded string The time, in ISO 8601 format, at which the user was created.
dateUpdated string The time, in ISO 8601 format, at which the user was updated.
link string/null Link to be used that will auto-log user into the site. Note: must pass "getLogin" parameter in request to receive.
expires string/null The time, in ISO 8601 format, that this link will expire.
now string/null The current server time in ISO 8601 format.

Example Response

Content-Type: application/json
{ "message":"ok", "data":{ "id":"123456", "status":"active", "referenceId":null, "firstName":"Paula", "lastName":"Jones", "middleName":"Kelly", "email":"pjones@example.com", "mobile":"615-555-1212", "phone":"978-555-1212", "gender":"Female", "address":"1212 Walking Ln.", "address2":"Appt 2b", "city":"Schenectady", "state":"NY", "postal":"12345", "dateAdded":"2010-11-29T15:44:25-05:00", "dateUpdated":"2013-02-09T11:11:25-05:00", "favoriteAgencies":[ { "agencyId":"25148", "agencyName":"The Learning Center" }, { "agencyId":"20596", "agencyName":"Cancer Association of Equestria" } ] } }

Agency List

Use this endpoint to obtain a list of all agencies on your domain with a variety of the agencies' data. Agencies must be on your site, and inactive agencies will not be included in the results.

Return Structure Type Description
id number Unique identifier for the agency record.
agencyLink string/null Shortcut URL to go directly to the agency page.
Final URL would be https://(siteurl)/agency/(agencyLink)/
agencyName string Name of agency
agencyAddress string/null Address for agency
agencyAddress2 string/null Continued address for agency
agencyCity string/null Agency City
agencyState string/null Agency State
agencyZip string/null Agency zip code.
agencyPhone string/null Agency phone number.
agencyContact string/null Name of agency contact .
agencyURL string/null Agency website URL.
agencyDescription string/null Agency description.
dateAdded string The time, in ISO 8601 format, at which the agency was created.
dateUpdated string The time, in ISO 8601 format, at which the agency was updated.
status string Current status of agency.

Request

URL https://api2.galaxydigital.com/volunteer/agency/list/
Method: POST or GET
Request Parameters
Parameter Details
key* Your unique API key. This parameter is required.
offset Number of records you wish to skip before your result set starts. This is used for pagination.
limit This will limit the number of records returned. The maximum number you can return at one time is 50.
since_id This will return agencies with a unique id that is greater than the id specified.
since_date Format: yyyy-mm-dd This will return agencies that have been added to the system since the date specified.
search This will limit results based on search string passed. This will search against the need title, description, and any tags associated with the agency.

Example Response

Content-Type: application/json
{ "rows":251, "offset":0, "limit":2, "message":"ok", "data":[ { "id":"9658", "agencyLink":"agencyone", "agencyName":"Agency One", "agencyAddress":"1212 S. Pine Street", "agencyAddress2":"", "agencyCity":"Danvers", "agencyState":"MA", "agencyZip":".01923", "agencyPhone":"781-555-1212", "agencyContact":"Joyce Smith", "agencyURL":"http:\/\/www.example.org\/", "status":"active", "dateAdded":"2010-11-29T15:44:25-05:00", "dateUpdated":"2013-02-09T11:11:25-05:00" }, { "id":"10254", "agencyLink":"alc", "agencyName":"Adult Training Center", "agencyAddress":"14124 West End Ave.", "agencyAddress2":"", "agencyCity":"Danvers", "agencyState":"MA", "agencyZip":"01923", "agencyPhone":"978.555.1212", "agencyContact":"Mary Jones", "agencyURL":"http\/\/www.example.com\/", "status":"imported", "dateAdded":"2010-11-29T15:44:25-05:00", "dateUpdated":"2013-02-09T11:11:25-05:00" } ] }

Agency Get By ID

Use this endpoint to obtain information about a single agency on your site. The agency cannot be inactive, and they must also be on your site. Submit the `id` parameter to complete the get, where the id is the agency ID on your site.

Return Structure Type Description
id number Unique identifier for the agency record.
agencyLink string/null Shortcut URL to go directly to the agency page.
Final URL would be https://(siteurl)/agency/(agencyLink)/
agencyName string Name of agency
agencyAddress string/null Address for agency
agencyAddress2 string/null Continued address for agency
agencyCity string/null Agency City
agencyState string/null Agency State
agencyZip string/null Agency zip code.
agencyPhone string/null Agency phone number.
agencyContact string/null Name of agency contact .
agencyURL string/null Agency website URL.
agencyDescription string/null Agency description.
dateAdded string The time, in ISO 8601 format, at which the agency was created.
dateUpdated string The time, in ISO 8601 format, at which the agency was updated.
status string Current status agency.
causes array/null Causes defined by the agency.

Request

URL https://api2.galaxydigital.com/volunteer/agency/get/
Method: POST or GET
Request Parameters
Parameter Details
key* Your unique API key. This parameter is required.
id Unique identifier of record you wish to have returned.

Example Response

Content-Type: application/json
{ "message":"ok", "data":{ "id":"9658", "agencyLink":"agencyone", "agencyName":"Agency One", "agencyAddress":"1212 S. Pine Street", "agencyAddress2":"", "agencyCity":"Danvers", "agencyState":"MA", "agencyZip":".01923", "agencyPhone":"781-555-1212", "agencyContact":"Joyce Smith", "agencyURL":"http:\/\/www.example.org\/", "status":"active", "dateAdded":"2010-11-29T15:44:25-05:00", "dateUpdated":"2013-02-09T11:11:25-05:00" } }

Need List

Use this endpoint to obtain a list of all needs on your domain with a variety of the needs’ data. Needs must be on your site, active, and non expired.

\
Return Structure Type Description
id number Unique identifier for the need record.
needAddress string/null Street address for need.
needCity string/null City for need.
needState string/null State for need.
needZip string/null Zip Code for need.
needTitle string Title of need.
needDetails string/null Description of need.
needType string Primary category assigned to need.
needAgeRequirements string/null Minimum age requirement for need responder.
needAllowTeams bool Indicates if a need is accepting team signups.
needContact string/null Comma separated list of contact email addresses for need.
needDate string/null Date need either happens on or expires. If needDateType is "ongoing" this will be null.
needDateType string Either "ongoing", "until", or "on".
needVolunteersNeeded number/null Number of responders needed for this need.
duration string Duration of need in hours.
registrationClosed string The date when responses will no longer be accepted.
dateAdded string The time, in ISO 8601 format, at which the record was created.
dateUpdated string The time, in ISO 8601 format, at which the record was updated.
isPrivate bool Indicates if the need is private and should not be shown publicly.
status string Current status of need.
impactArea string Impact area as defined by the agency.
needHoursDescription string Text description of the need time. e.g. 9am to 5pm
interests array Interests assigned to the need.
qualifications array Qualifications assigned to the need.
agencyId number Unique ID for agency that created need.
agencyName string Name of agency that created need.
aemId number Unique ID of the Advanced Event attached to this item.
aemTitle number Title of the Advanced Event attached to this item.
initiativeId number Unique ID of the Initiative attached to this item.
initiativeTitle number Title of the Initiative attached to this item.
needLink string Direct link to the need.
needLinkCustom string Direct link to the need using your custom domain name.
shifts array Array of shifts attached to this need. Each shift item consists of shiftId, startDate, endDate, duration, capacity, responses, and status

Request

URL https://api2.galaxydigital.com/volunteer/need/list/
Method: POST or GET
Request Parameters
Parameter Details
key* Your unique API key. This parameter is required.
offset Number of records you wish to skip before your result set starts. This is used for pagination.
limit This will limit the number of records returned. The maximum number you can return at one time is 50.
since_id This will return needs with a unique id that is greater than the id specified.
showExpired This will allow expired needs to be part of the result set.
since_date Format: yyyy-mm-dd This will return needs that have been added to the system since the date specified.
search This will limit results based on search string passed. This will search against the need title, description, and any tags associated with the need.
aemId This will return needs that have been part of a specific Advanced Event.
initiativeId This will return needs that have been part of a specific Initative.
agency Unique agency identifier This will return needs that have been added to the system by a specific agency.
aemId This will return needs part of a specific Advanced Event.
type Allowed: "volunteer", "advocate", "inkind", or "employment" This will return needs that have been categorized with the category specified.
orderBy This will define the order in which the needs are returned. Options are: "newest", "oldest", "soonest", and "alpha". Note: soonest will not return "Ongoing" needs.

Example Response

        
Content-Type: application/json
{ "rows":370, "offset":0, "limit":20, "message":"ok", "data":[ { "id":"3", "needZip":01923, "needTitle":"A Test Need", "needDetails":"This is an example need.", "needType":"volunteer", "needAgeRequirements":null, "needContact":'jack@example.com,mary@example.com', "needDate":'2013-06-15', "needDateType":"until", "needVolunteersNeeded":null, "status":"active", "dateAdded":"2010-11-29T15:44:25-05:00", "dateUpdated":"2013-02-09T11:11:25-05:00", "agencyId":"521456", "agencyName":"All Persons Agency" }, { "id":"4", "needZip":01921, "needTitle":"What is a need?", "needDetails":"Just another need example.", "needType":"volunteer", "needAgeRequirements":'18', "needContact":null, "needDate":"", "needDateType":"ongoing", "needVolunteersNeeded":null, "status":"active", "dateAdded":"2010-11-29T15:44:25-05:00", "dateUpdated":"2013-02-09T11:11:25-05:00", "agencyId":"332547", "agencyName":"We help today" } ] }

Need Get By ID

Use this endpoint to obtain information about a single need on your site. The need must be active, non expired, and on your site. Submit the `id` parameter to complete the get, where the id is the need ID on your site.

Return Structure Type Description
id number Unique identifier for the need record.
needAddress string/null Street address for need.
needCity string/null City for need.
needState string/null State for need.
needZip string/null Zip Code for need.
needTitle string Title of need.
needDetails string/null Description of need.
needType string Primary category assigned to need.
needAgeRequirements string/null Minimum age requirement for need responder.
needAllowTeams bool Indicates if a need is accepting team signups.
needContact string/null Comma separated list of contact email addresses for need.
needDate string/null Date need either happens on or expires. If needDateType is "ongoing" this will be null.
needDateType string Either "ongoing", "until", or "on".
needVolunteersNeeded number/null Number of responders needed for this need.
duration string Duration of need in hours.
registrationClosed string The date when responses will no longer be accepted.
dateAdded string The time, in ISO 8601 format, at which the record was created.
dateUpdated string The time, in ISO 8601 format, at which the record was updated.
isPrivate bool Indicates if the need is private and should not be shown publicly.
status string Current status of need.
agencyId number Unique ID for agency that created need.
agencyName string Name of agency that created need.
aemId number Unique ID of the Advanced Event attached to this item.
aemTitle number Title of the Advanced Event attached to this item.
initiativeId number Unique ID of the Initiative attached to this item.
initiativeTitle number Title of the Initiative attached to this item.
needHoursDescription string Text description of the need time. e.g. 9am to 5pm
interests array Interests assigned to the need.
needLink string Direct link to the need.
needLinkCustom string Direct link to the need using your custom domain name.
shifts array Array of shifts attached to this need. Each shift item consists of shiftId, startDate, endDate, duration, capacity, responses, and status
qualifications array Array of qualifications attached to this need. Each shift item consists of qualificationId, qualificationCategory, AND qualificationTitle

Request

URL https://api2.galaxydigital.com/volunteer/need/get/
Method: POST or GET
Request Parameters
Parameter Details
key* Your unique API key. This parameter is required.
id Unique identifier of record you wish to have returned.
showExpired This will allow expired needs to be part of the result set.

Example Response

		
Content-Type: application/json
{ "message":"ok", "data":{ "id":"3", "needZip":01923, "needTitle":"A Test Need", "needDetails":"This is an example need.", "needType":"volunteer", "needAgeRequirements":null, "needContact":'jack@example.com,mary@example.com', "needDate":'2013-06-15', "needDateType":"until", "needVolunteersNeeded":null, "status":"active", "dateAdded":"2010-11-29T15:44:25-05:00", "dateUpdated":"2013-02-09T11:11:25-05:00", "agencyId":"521456", "agencyName":"All Persons Agency" } }

Response Get By ID

Use this endpoint to obtain information about a single response on your site. Unlike other endpoints, the response does not have to have a specific status to be shown. Submit the `id` parameter to complete the get, where the id is the response ID on your site.

Request

URL https://api2.galaxydigital.com/volunteer/response/get/
Method: POST or GET
Request Parameters
Parameter Type Details
key* string Your unique API key. This parameter is required.
id mixed Unique identifier of record you wish to have returned.

Return Structure

Return label Type Description
responseId number Unique identifier for the user record.
responseStatus string Current status of the record.
responsePhone string  
responseAddress string  
responseNote string  
waiverAgree string Did user agree to waiver
agencyId number Unique identifier
agencyName string Agency name
needId number Unique identifier
needTitle string Need title
needDate string Need date
userId number Unique identifier
firstName string Responder first name
lastName string Responder last name
email string Responder email
aemId number Unique ID of the Advanced Event attached to this item.
aemTitle number Title of the Advanced Event attached to this item.
initiativeId number Unique ID of the Initiative attached to this item.
initiativeTitle number Title of the Initiative attached to this item.
companyId number ID of the Company attached to this item.
companyName number Name of the Company attached to this item.
shift array The shift attached to this response. Shift item consists of shiftId, startDate, endDate, duration, capacity, responses, and status
responseAdded string The time, in ISO 8601 format, that this link will expire.
responseUpdated string The time, in ISO 8601 format, that this link will expire.

Example Response

    
Content-Type: application/json
{ "message":"ok", "data":{ "responseId":"255002", "responseStatus":"active", "responsePhone":null, "responseAddress":"", "responseNote":"", "waiverAgree":"No", "agencyId":"33316", "agencyName":"Meow-ntain Cat Sanctuary Agency", "needId":"93929", "needTitle":"Purrfessional Administrative Assistant", "needDate":"2016-02-06", "userId":"613930", "firstName":"Bernadette", "lastName":"Grasty-Colont", "email":"bernadette@example.com", "responseAdded":"2015-03-04T09:31:20-06:00", "responseUpdated":"2015-03-04T09:31:20-06:00" } }

Response List

Use this endpoint to obtain a list of all responses on your domain with a variety of data about the responses as well as their the needs, agencies, and users. Responses must not be inactive and must be on your site.

Request

URL https://api2.galaxydigital.com/volunteer/response/list/
Method: POST or GET
Request Parameters
Parameter Type Details
key* string Your unique API key. This parameter is required.
offset integer Number of records you wish to skip before your result set starts. This is used for pagination.
limit integer This will limit the number of records returned. The maximum number you can return at one time is 50.
agencyId integer This will return responses to needs for the specific agency.
needId integer This will return responses to a specific need.
userId integer This will return responses by a specific user.
companyId integer This will return responses by a company.
aemId integer This will return responses part of a specific Advanced Event.
initiativeId This will return responses that have been part of a specific Initative.
shift array The shift attached to this response. Shift item consists of shiftId, startDate, endDate, duration, capacity, responses, and status
sinceId integer This will return responses with a response id that is greater than the id specified.
sinceDate Format: yyyy-mm-dd date This will return responses that have been added to the system since the date specified.

Return Structure

Variable Type Description
responseId number Unique identifier for the response record.
responseStatus string Current status of response
responsePhone string/null Phone number entered for the user.
responseAddress string/null Address entered for the user.
waiverAgree string Has the user agreed to the waiver when responding.
agencyId number Unique identifier for the agency that created the need.
agencyName string Name of the agency that created the need.
needId number Unique identifier for the need.
needTitle string Title for the need.
userId number Unique identifier for the user.
firstName string First name of the user.
lastName string Last name of the user.
email string Email address of the user.
aemId number Unique ID of the Advanced Event attached to this item.
aemTitle number Title of the Advanced Event attached to this item.
initiativeId number Unique ID of the Initiative attached to this item.
initiativeTitle number Title of the Initiative attached to this item.
companyId number ID of the Company attached to this item.
companyName number Name of the Company attached to this item.
responseAdded string The time, in ISO 8601 format, at which the response was created.
responseUpdated string The time, in ISO 8601 format, at which the response was updated.

Example Response

Content-Type: application/json
{ "rows":115, "offset":0, "limit":20, "message":"ok", "data":[ { "responseId":"255002", "responseStatus":"active", "responsePhone":null, "responseAddress":"", "responseNote":"", "waiverAgree":"No", "agencyId":"33316", "agencyName":"Meow-ntain Cat Sanctuary Agency", "needId":"93929", "needTitle":"Purrfessional Administrative Assistant", "needDate":"2016-02-06", "userId":"613930", "firstName":"Bernadette", "lastName":"Grasty-Colont", "email":"bernadette@example.com", "responseAdded":"2015-03-04T09:31:20-06:00", "responseUpdated":"2015-03-04T09:31:20-06:00" }, { "responseId":"255050", "responseStatus":"active", "responsePhone":"", "responseAddress":null, "responseNote":null, "waiverAgree":"No", "agencyId":"33317", "agencyName":"Mountain Trail Club", "needId":"94252", "needTitle":"Trail Maintenance on the Singing Creek Trail", "needDate":"2015-04-18", "userId":"613925", "firstName":"Default", "lastName":"Manager", "email":"default.manager@example.com", "responseAdded":"2015-03-04T10:39:53-06:00", "responseUpdated":"2015-03-04T10:39:53-06:00" } ] }

Add New Response

You can create a response between a user on your site and a need on your site using this post. In addition to being on your site, the user must have a status of active, pending, imported, or inactive. In addition to being on your site, the need must be active and non expired. A response will be recorded to the user and need you specify, that need’s agency will be recorded, the current time will be added as the date added and updated, and status will be active.

Request

URL https://api2.galaxydigital.com/volunteer/response/add/
Method: POST
Note: If you are trying to add a response that already exists in the system, the API will simply return the data for that record.
Request Parameters
Parameter Type Details
key* string Your unique API key. This parameter is required.
needId* number ID of the need from this response.
userId* number ID of the user from this response.
responsePhone string Phone number of the responder.
responseAddress string Address of the responder.
responseNote string Comment to add to the response.

Return Structure

Return label Type Description
responseId number Unique identifier for the user record.
responseStatus string Current status of the record.
responsePhone string  
responseAddress string  
responseNote string  
waiverAgree string Did user agree to waiver
agencyId number Unique identifier
agencyName string Agency name
needId number Unique identifier
needTitle string Need title
needDate string Need date
userId number Unique identifier
firstName string Responder first name
lastName string Responder last name
email string Responder email
responseAdded string The time, in ISO 8601 format, that this link will expire.
responseUpdated string The time, in ISO 8601 format, that this link will expire.

Example Response

Content-Type: application/json
{ "message":"ok", "data":{ "responseId":"255002", "responseStatus":"active", "responsePhone":null, "responseAddress":"", "responseNote":"", "waiverAgree":"No", "agencyId":"33316", "agencyName":"Meow-ntain Cat Sanctuary Agency", "needId":"93929", "needTitle":"Purrfessional Administrative Assistant", "needDate":"2016-02-06", "userId":"613930", "firstName":"Bernadette", "lastName":"Grasty-Colont", "email":"bernadette@example.com", "responseAdded":"2015-03-04T09:31:20-06:00", "responseUpdated":"2015-03-04T09:31:20-06:00" } }

Hour List

Use this endpoint to obtain a list of all hours on your domain with a variety of data about the hours as well as data about the user, agency, and need. The hours’ user must be active, the hours’ need must not be inactive, the hours’ agency must not be inactive, the hours must be active, and the hours must be on your site.

Request

URL https://api2.galaxydigital.com/volunteer/hour/list/
Method: POST or GET
Request Parameters
Parameter Type Details
key* string Your unique API key. This parameter is required.
offset integer Number of records you wish to skip before your result set starts. This is used for pagination.
limit integer This will limit the number of records returned. The maximum number you can return at one time is 50.
agencyId integer This will return hours applied to needs for the specific agency.
needId integer This will return hours applied to a specific need.
userId integer This will return hours submitted by a specific user.
aemId integer This will return hours part of a specific Advanced Event.
sinceId integer This will return hours with an id that is greater than the id specified.
sinceDate Format: yyyy-mm-dd date This will return hours that have been added to the system since the date specified.
return array Request additional hour data as part of the result set. You may only use "referenceId" for now. e.g. return[]='referenceId'

Return Structure

Variable Type Description
hourId number Unique identifier for the record.
status string Current status of the record.
contactName string Contact name from the need.
contactDetails string Contact details from the need
hours string Number of hours submitted for this entry.
hourType string Type of hour entry. Either need or individual.
miles string Number of miles submitted for this entry.
location string Location information added by the user.
description string Description information added by the user for this entry.
agencyId string Id of the agency that created the need.
agencyName string Name of the agency that created the need.
needId string ID of the need to which the user responded.
needTitle string Name of the need to which the user responded.
needDate string Date of the need to which the user responded.
userId string ID of the user who responded.
firstName string First name of the user who responded.
lastName string Last name of the user who responded.
email string Email name of the user who responded.
aemId number Unique ID of the Advanced Event attached to this item.
aemTitle number Title of the Advanced Event attached to this item.
dateAdded string The date, in ISO 8601 format, that hour entry was added.
dateUpdated string The date, in ISO 8601 format, that hour entry was last updated.

Example Response

Content-Type: application/json
{ "rows":115, "offset":0, "limit":20, "message":"ok", "data":[ { "hourId":"127017", "status":"approved", "contactName":"", "contactDetails":"", "hours":"3.00", "miles":"5", "location":"", "description":"Had a purrfect time!", "agencyId":"33316", "agencyName":"Meow-ntain Cat Sanctuary Agency", "needId":"93929", "needTitle":"Purrfessional Administrative Assistant", "needDate":"2016-09-02", "userId":"613930", "firstName":"Bernadette", "lastName":"Grasty-Colont", "email":"bernadette@example.com", "dateAdded":"2015-03-04T09:35:23-06:00", "dateUpdated":"2015-03-04T09:37:35-06:00" }, { "hourId":"127144", "status":"approved", "contactName":"", "contactDetails":"", "hours":"3.00", "miles":"16", "location":"", "description":"Explored trail to get idea of how much work and what tools will be required.", "agencyId":"33317", "agencyName":"Mountain Trail Club", "needId":"94339", "needTitle":"Trail Maintenance on the Singing Creek Trail", "needDate":"2015-03-28", "userId":"613928", "firstName":"Ada", "lastName":"User", "email":"user@example.com", "dateAdded":"2015-03-05T08:38:37-06:00", "dateUpdated":"2015-03-05T08:40:02-06:00" } ] }

Hour Get By ID

Use this endpoint to obtain information about a single hours entry on your site. The hours’ user must be active, the hours’ need must not be inactive, the hours’ agency must not be inactive, and the hours must be on your site. Submit the `hourId` parameter to complete the get, where the id is the hour id on our site.

Request

URL https://api2.galaxydigital.com/volunteer/hour/get/
Method: POST or GET
Request Parameters
Parameter Type Details
key* string Your unique API key. This parameter is required.
hourId mixed Unique identifier of record you wish to have returned.

Return Structure

Return label Type Description
hourId number Unique identifier for the record.
status string Current status of the record.
contactName string Contact name from the need.
contactDetails string Contact details from the need
hours string Number of hours submitted for this entry.
hourType string Type of hour entry. Either need or individual.
miles string Number of miles submitted for this entry.
location string Location information added by the user.
description string Description information added by the user for this entry.
agencyId string Id of the agency that created the need.
agencyName string Name of the agency that created the need.
aemId number Unique ID of the Advanced Event attached to this item.
aemTitle number Title of the Advanced Event attached to this item.
needId string ID of the need to which the user responded.
needTitle string Name of the need to which the user responded.
needDate string Date of the need to which the user responded.
userId string ID of the user who responded.
firstName string First name of the user who responded.
lastName string Last name of the user who responded.
email string Email name of the user who responded.
dateAdded string The date, in ISO 8601 format, that hour entry was added.
dateUpdated string The date, in ISO 8601 format, that hour entry was last updated.

Example Response

Content-Type: application/json
{ "message":"ok", "data":{ "hourId":"127017", "status":"approved", "contactName":"", "contactDetails":"", "hours":"3.00", "miles":"5", "location":"", "description":"Had a purrfect time!", "agencyId":"33316", "agencyName":"Meow-ntain Cat Sanctuary Agency", "needId":"93929", "needTitle":"Purrfessional Administrative Assistant", "needDate":"2016-09-02", "userId":"613930", "firstName":"Bernadette", "lastName":"Grasty-Colont", "email":"bernadette@example.com", "dateAdded":"2015-03-04T09:35:23-06:00", "dateUpdated":"2015-03-04T09:37:35-06:00" } }

Add New Hour Entry

You can create an hours entry for a user on your site and a need on your site using this post. The user must have a status of active, pending, imported, or inactive. The hours will be created for the user and the need, the status will be “approved,” the current time will be added as the date added and updated, and the “hours” value you supply will be recorded as the duration.

Request

URL https://api2.galaxydigital.com/volunteer/hour/add/
Method: POST
Request Parameters
Parameter Type Details
key* string Your unique API key. This parameter is required.
needId* number ID of the need from this response.
userId* number ID of the user from this response.
hours* number Number of hours volunteered.
miles number Miles traveled for this volunteer event.
location string Location where volunteer event happened.
description string Other notes about volunteer hour entry.
contactName string Contact of someone who can confirm this hour entry.
contactDetails string Addional contact information for hour confirmation.

Return Structure

Return label Type Description
hourId number Unique identifier for the record.
status string Current status of the record.
contactName string Contact of someone who can confirm this hour entry.
contactDetails string Addional contact information for hour confirmation.
hours number Hours entered for this entry
location string Location where volunteer event happened.
description string Other notes about volunteer hour entry.
agencyId number Unique identifier
agencyName string Agency name
needId number Unique identifier
needTitle string Need title
needDate string Need date
userId number Unique identifier
firstName string Responder first name
lastName string Responder last name
email string Responder email
dateAdded string The time, in ISO 8601 format, that this hour entry was added.
dateUpdated string The time, in ISO 8601 format, that this hour entry was last updated.

Example Response

Content-Type: application/json
{ "message":"ok", "data":{ "hourId":"254875", "status":"approved", "contactName":"bubba", "contactDetails":"", "hours":"10.00", "miles":"", "location":"", "description":"", "agencyId":"33316", "agencyName":"Meow-ntain Cat Sanctuary Agency", "needId":"93929", "needTitle":"Purrfessional Administrative Assistant", "needDate":"2016-09-02", "userId":"613930", "firstName":"Bernadette", "lastName":"Grasty-Colont", "email":"bernadette@example.com", "dateAdded":"2016-05-27T13:15:41-05:00", "dateUpdated":"2016-05-27T13:15:41-05:00" } }

Update Hour Entry

Use this POST to update an existing hours entry. Add as many parameters as you like to replace current data. The hours updated must be associated with an active user, a need that is not inactive, an agency that is not inactive, and be on your site.

Request

URL https://api2.galaxydigital.com/volunteer/hour/update/
Method: POST
Request Parameters
Parameter Type Details
key* string Your unique API key. This parameter is required.
hourId* string The unique ID for the entry you wish to edit.
hours number Number of hours volunteered.
status string Approval status of hour entry. e.g. 'approved', 'pending', 'denied', 'inactive', or 'entered'
miles number Miles traveled for this volunteer event.
location string Location where volunteer event happened.
description string Other notes about volunteer hour entry.
contactName string Contact of someone who can confirm this hour entry.
contactDetails string Addional contact information for hour confirmation.

Return Structure

Return label Type Description
hourId number Unique identifier for the record.
status string Current status of the record.
contactName string Contact of someone who can confirm this hour entry.
contactDetails string Addional contact information for hour confirmation.
hours number Hours entered for this entry
location string Location where volunteer event happened.
description string Other notes about volunteer hour entry.
agencyId number Unique identifier
agencyName string Agency name
needId number Unique identifier
needTitle string Need title
needDate string Need date
userId number Unique identifier
firstName string Responder first name
lastName string Responder last name
email string Responder email
dateAdded string The time, in ISO 8601 format, that this hour entry was added.
dateUpdated string The time, in ISO 8601 format, that this hour entry was last updated.

Example Response

Content-Type: application/json
{ "message":"ok", "data":{ "hourId":"254875", "status":"approved", "contactName":"bubba", "contactDetails":"", "hours":"10.00", "miles":"", "location":"", "description":"", "agencyId":"33316", "agencyName":"Meow-ntain Cat Sanctuary Agency", "needId":"93929", "needTitle":"Purrfessional Administrative Assistant", "needDate":"2016-09-02", "userId":"613930", "firstName":"Bernadette", "lastName":"Grasty-Colont", "email":"bernadette@example.com", "dateAdded":"2016-05-27T13:15:41-05:00", "dateUpdated":"2016-05-27T13:15:41-05:00" } }

Event List

Use this endpoint to obtain a full list of events on your domain with a variety of data about the event. The events must be on your site, active, and start in the future in order to appear in results.

Request

URL https://api2.galaxydigital.com/volunteer/event/list/
Method: POST or GET
Request Parameters
Parameter Type Details
key* string Your unique API key. This parameter is required.
offset integer Number of records you wish to skip before your result set starts. This is used for pagination.
limit integer This will limit the number of records returned. The maximum number you can return at one time is 50.

Return Structure

Variable Type Description
eventId number Unique identifier for the record.
eventStatus string Current status of the record.
eventTitle string Title of the record.
eventDescription string Description of the record.
eventWebsite string Website listed for the event.
eventHost string Host listed for the event.
eventContact string Contact listed for the event.
eventVenue string Venue listed for the event.
eventAddress string Address listed for the event.
eventAddress2 string Address listed for the event.
eventCity string City listed for the event.
eventState string State listed for the event.
eventZipCode string Zip code listed for the event.
eventCounty string County listed for the event.
eventEmail string Email listed for the event.
eventStart string The date/time, in ISO 8601 format, that the event starts.
eventEnd string The date/time, in ISO 8601 format, that the event ends.
dateAdded string The date/time, in ISO 8601 format, that the event was added.
dateUpdated string The date/time, in ISO 8601 format, that the event was last updated.
agencyId number The ID for the agency that created the event.
agencyName string The name of the agency that created the event.
agencyStatus string The current status of the agency that created the event.

Example Response

Content-Type: application/json
{ "rows":115, "offset":0, "limit":20, "message":"ok", "data":[ { "eventId":"16228", "eventTitle":"Pet Therapy training class Fall 2016", "eventDescription":"We have 2 Orientation/Training classes one March 2, 2016 one September 7, 2016.", "eventWebsite":"", "eventHost":"", "eventContact":"www.therapypetpals.org", "eventVenue":"", "eventAddress":"27434 Robinson Rd.", "eventAddress2":"", "eventCity":"Spring", "eventState":"TX", "eventZipCode":"77386", "eventCounty":"", "eventEmail":"mlucas99@sbcglobal.net", "eventStart":"2016-09-07T18:45:00-05:00", "eventEnd":"2016-09-07T20:30:00-05:00", "allDay":"0", "dateAdded":"2015-02-13T12:52:37-06:00", "dateUpdated":"2016-01-12T16:10:43-06:00", "eventStatus":"active", "agencyId":"17490", "agencyName":"Therapy Pet Pals of Texas, Inc.", "agencyStatus":"active" }, { "eventId":"16228", "eventTitle":"Pet Therapy training class Fall 2016", "eventDescription":"We have 2 Orientation/Training classes one March 2, 2016 one September 7, 2016.", "eventWebsite":"", "eventHost":"", "eventContact":"www.therapypetpals.org", "eventVenue":"", "eventAddress":"27434 Robinson Rd.", "eventAddress2":"", "eventCity":"Spring", "eventState":"TX", "eventZipCode":"77386", "eventCounty":"", "eventEmail":"mlucas99@sbcglobal.net", "eventStart":"2016-09-07T18:45:00-05:00", "eventEnd":"2016-09-07T20:30:00-05:00", "allDay":"0", "dateAdded":"2015-02-13T12:52:37-06:00", "dateUpdated":"2016-01-12T16:10:43-06:00", "eventStatus":"active", "agencyId":"17490", "agencyName":"Therapy Pet Pals of Texas, Inc.", "agencyStatus":"active" } ] }

Event Get By ID

Use this endpoint to obtain information about a single event on your site. The event must be active and it must start in the future. Submit the `id` parameter to complete your get, where the id is the event id on your site.

Request

URL https://api2.galaxydigital.com/volunteer/event/get/
Method: POST or GET
Request Parameters
Parameter Type Details
key* string Your unique API key. This parameter is required.
id mixed Unique identifier of record you wish to have returned.

Return Structure

Return label Type Description
eventId number Unique identifier for the record.
eventStatus string Current status of the record.
eventTitle string Title of the record.
eventDescription string Description of the record.
eventWebsite string Website listed for the event.
eventHost string Host listed for the event.
eventContact string Contact listed for the event.
eventVenue string Venue listed for the event.
eventAddress string Address listed for the event.
eventAddress2 string Address listed for the event.
eventCity string City listed for the event.
eventState string State listed for the event.
eventZipCode string Zip code listed for the event.
eventCounty string County listed for the event.
eventEmail string Email listed for the event.
eventStart string The date/time, in ISO 8601 format, that the event starts.
eventEnd string The date/time, in ISO 8601 format, that the event ends.
dateAdded string The date/time, in ISO 8601 format, that the event was added.
dateUpdated string The date/time, in ISO 8601 format, that the event was last updated.
agencyId number The ID for the agency that created the event.
agencyName string The name of the agency that created the event.
agencyStatus string The current status of the agency that created the event.

Example Response

Content-Type: application/json
{ "message":"ok", "data":{ "eventId":"16228", "eventTitle":"Pet Therapy training class Fall 2016", "eventDescription":"We have 2 Orientation/Training classes one March 2, 2016 one September 7, 2016.", "eventWebsite":"", "eventHost":"", "eventContact":"www.therapypetpals.org", "eventVenue":"", "eventAddress":"27434 Robinson Rd.", "eventAddress2":"", "eventCity":"Spring", "eventState":"TX", "eventZipCode":"77386", "eventCounty":"", "eventEmail":"mlucas99@sbcglobal.net", "eventStart":"2016-09-07T18:45:00-05:00", "eventEnd":"2016-09-07T20:30:00-05:00", "allDay":"0", "dateAdded":"2015-02-13T12:52:37-06:00", "dateUpdated":"2016-01-12T16:10:43-06:00", "eventStatus":"active", "agencyId":"17490", "agencyName":"Therapy Pet Pals of Texas, Inc.", "agencyStatus":"active" } }