Data Export API (1.0.0)

Download OpenAPI specification:

This is the official API documentation for the endpoints available through the Data Export API. The easiest way to get started is by using the Postman collection provided (see instructions below).

Getting Started with Postman

Download the spec by clicking the button above
In Postman, navigate to Collections on the left and click Import at the top
Drag and drop the downloaded openapi.json file into the import prompt
After importing, you should see the Data Export API collection on the left. You will first want to update the {{baseUrl}} variable:
- Current value: https://school.service.campusgroups.com/data/v1
- Replace "school" with your school code
You should now be ready to use the API endpoints.
- First, make a POST request to submit a new data request,
- then make a GET request to the same endpoint to see the status of the request, or get the paginated results.
- Make sure to include your school code and your API Secret key in the headers of all requests.

Date Ranges and Pagination

All endpoints require date range parameters to filter the result set based on the updatedOn field:

updatedStart: The start date/time that records were last updated
updatedEnd: The end date/time that records were last updated

For pagination:

When making a GET request the response will include a nextToken in the body if there are more results. By default the page size is 999, which is the maximum, but a size parameter is supported if you want less.
To get the next page of results, include a token parameter set to the value of the nextToken from the previous response
Repeat until you receive a response with no nextToken, indicating you've reached the end of the results

Events

Endpoint to retrieve events based on the specified start and end dates, it returns a query id that can be used to retrieve the results of the query. Use Request Events to request the data results of the query and upon success of the query use Retrieve Events

Retrieve events

After a query has been submitted, this endpoint can be used to retrieve the results of the query given the query ID.

query Parameters

queryId required	string Example: queryId=9261fb39-9206-4f6a-80dd-0b5329c8ba4b reference to the query id
token	string Example: token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsInVzZXJuYW1lIjoiYWRtaW4iLCJleHAiOjE1NzU2NjE The token for the next page of results

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

Content type

application/json

{"Results": [{"id": 1,
"updatedOn": "2019-08-24T14:15:22Z",
"createdOn": "2019-08-24T14:15:22Z",
"name": "User Orientation Day",
"type": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"groupId": 1,
"cohostingGroupIds": "1,2,3",
"cohostingGroupNames": "Group A, Group B, Group C",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"timeZone": "string",
"shortDescription": "string",
"privacyLevel": "Everyone",
"whoCanSeeAttendeeList": "Nobody",
"whoCanSeeEventOnCalendar": "Everyone",
"locationType": "Off-Campus",
"whoCanSeeLocation": "Everyone",
"approvalStatus": "Approved",
"description": "string",
"locationName": "string",
"address": "string",
"telephone": "string",
"zipcode": "string",
"city": "string",
"state": "string",
"country": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"room": "string",
"registrationEnabled": true,
"externalRegistrationUrl": "string",
"registrationOpenDate": "2019-08-24T14:15:22Z",
"registrationCloseDate": "2019-08-24T14:15:22Z",
"closed": true,
"capacity": 0,
"registrationRedirectUrl": "string",
"reminderDelay": 0,
"sendReminder": 0,
"reminderMessage": "string",
"rsvpMessage": "string",
"feedbackRequest": true,
"allowRsvpAtTheDoor": true,
"parentEventIds": "string",
"dressCode": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"waiverRequired": true,
"showWaiverAtRegistration": true,
"draft": true,
"deleted": true,
"template": true,
"tags": [{"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
}
],
"adminTags": [{"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
}
],
"customFields": [{"answer": "string",
"question": "string"
}
]
}
],
"NextToken": "string"
}

Request events

Request events that were updated between the specified start and end dates. This endpoint returns a queryId that can be used to retrieve the results of the query. Use Retrieve Events to retrieve the results of the query and upon success

query Parameters

updatedStart required	string <date-time> Example: updatedStart=2020-01-01T00:00:00Z&updatedStart=2020-01-01 The `updatedOn` start date to filter the query (inclusive)
updatedEnd required	string <date-time> Example: updatedEnd=2020-01-01T23:59:59Z The `updatedOn` end date to filter the query (inclusive)

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

200
400
401
500

Content type

application/json

{"queryId": "9261fb39-9206-4f6a-80dd-0b5329c8ba4b"
}

RSVP

Endpoint to retrieve rsvp, it returns a query id that can be used to retrieve the results of the query. Use Request RSVP to request the data results of the query and upon success of the query use Retrieve RSVP

Retrieve RSVP

After a query has been submitted, this endpoint can be used to retrieve the results of the query given the query ID.

query Parameters

queryId required	string Example: queryId=9261fb39-9206-4f6a-80dd-0b5329c8ba4b reference to the query id
token	string Example: token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsInVzZXJuYW1lIjoiYWRtaW4iLCJleHAiOjE1NzU2NjE The token for the next page of results

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

Content type

application/json

{"Results": [{"id": 0,
"eventId": 0,
"memberId": 0,
"rsvp": "string",
"createdOn": "2019-08-24T14:15:22Z",
"feedbackRating": "string",
"feedbackComment": "string",
"waiverChecked": true,
"waiverSignature": "string",
"hideFromListAttendees": true,
"updatedOn": "2019-08-24T14:15:22Z",
"customFields": [{"answer": "string",
"question": "string"
}
]
}
],
"NextToken": "string"
}

Request RSVP

Request RSVP that were updated between the specified start and end dates. This endpoint returns a queryId that can be used to retrieve the results of the query. Use Retrieve RSVP to retrieve the results of the query and upon success

query Parameters

updatedStart required	string <date-time> Example: updatedStart=2020-01-01T00:00:00Z&updatedStart=2020-01-01 The `updatedOn` start date to filter the query (inclusive)
updatedEnd required	string <date-time> Example: updatedEnd=2020-01-01T23:59:59Z The `updatedOn` end date to filter the query (inclusive)

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

200
400
401
500

Content type

application/json

{"queryId": "9261fb39-9206-4f6a-80dd-0b5329c8ba4b"
}

Event Registration Options

Endpoint to retrieve event_registration_options, it returns a query id that can be used to retrieve the results of the query. Use Request Event Registration Options to request the data results of the query and upon success of the query use Retrieve Event Registration Options

Retrieve Event Registration Options

After a query has been submitted, this endpoint can be used to retrieve the results of the query given the query ID.

query Parameters

queryId required	string Example: queryId=9261fb39-9206-4f6a-80dd-0b5329c8ba4b reference to the query id
token	string Example: token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsInVzZXJuYW1lIjoiYWRtaW4iLCJleHAiOjE1NzU2NjE The token for the next page of results

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

Content type

application/json

{"Results": [{"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z",
"eventId": 0,
"createdOn": "2019-08-24T14:15:22Z",
"groupId": 0,
"deleted": true,
"userId": 0,
"description": "string",
"price": 0.1,
"quantityAvailable": 0,
"maxPerOrder": 0,
"minPerOrder": 0,
"endSalesDate": "2019-08-24T14:15:22Z",
"startSalesDate": "2019-08-24T14:15:22Z",
"refundDeadline": "2019-08-24",
"cancellationDeadline": "2019-08-24",
"preventCancellation": true,
"itemType": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"taxIncluded": true,
"allowWaitingList": true,
"donation": true
}
],
"NextToken": "string"
}

Request Event Registration Options

Request Event Registration Options that were updated between the specified start and end dates This endpoint returns a queryId that can be used to retrieve the results of the query. Use Retrieve Event Registration Options to retrieve the results of the query and upon success

query Parameters

updatedStart required	string <date-time> Example: updatedStart=2020-01-01T00:00:00Z&updatedStart=2020-01-01 The `updatedOn` start date to filter the query (inclusive)
updatedEnd required	string <date-time> Example: updatedEnd=2020-01-01T23:59:59Z The `updatedOn` end date to filter the query (inclusive)

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

200
400
401
500

Content type

application/json

{"queryId": "9261fb39-9206-4f6a-80dd-0b5329c8ba4b"
}

Payments

Endpoint to retrieve payments, it returns a query id that can be used to retrieve the results of the query. Use Request Payments to request the data results of the query and upon success of the query use Retrieve Payments

Retrieve Payments

After a query has been submitted, this endpoint can be used to retrieve the results of the query given the query ID.

query Parameters

queryId required	string Example: queryId=9261fb39-9206-4f6a-80dd-0b5329c8ba4b reference to the query id
token	string Example: token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsInVzZXJuYW1lIjoiYWRtaW4iLCJleHAiOjE1NzU2NjE The token for the next page of results

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

Content type

application/json

{"Results": [{"type": "club",
"id": 0,
"updatedOn": "2019-08-24T14:15:22Z",
"rsvpId": 0,
"cartItemId": 0,
"amount": 0,
"quantity": 0,
"createdOn": "2019-08-24T14:15:22Z",
"rsvpDuringCheckin": true,
"itemTitle": "string",
"fee": 0,
"deleted": true,
"refId": 0,
"refundRequest": "string",
"refundResponse": "string",
"refundNeeded": true,
"gatewayAccountNumber": "string",
"transactionDetails": "string",
"cartUid": "string",
"gatewayTransactionId": "string",
"status": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"paymentMethod": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
}
}
],
"NextToken": "string"
}

Request Payments

Request payments that were updated between the specified start and end dates This endpoint returns a queryId that can be used to retrieve the results of the query. Use Retrieve Payments to retrieve the results of the query and upon success

query Parameters

updatedStart required	string <date-time> Example: updatedStart=2020-01-01T00:00:00Z&updatedStart=2020-01-01 The `updatedOn` start date to filter the query (inclusive)
updatedEnd required	string <date-time> Example: updatedEnd=2020-01-01T23:59:59Z The `updatedOn` end date to filter the query (inclusive)

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

200
400
401
500

Content type

application/json

{"queryId": "9261fb39-9206-4f6a-80dd-0b5329c8ba4b"
}

Checkins

Endpoint to retrieve checkin, it returns a query id that can be used to retrieve the results of the query. Use Request Checkins to request the data results of the query and upon success of the query use Retrieve Checkin

Retrieve Checkins

After a query has been submitted, this endpoint can be used to retrieve the results of the query given the query ID.

query Parameters

queryId required	string Example: queryId=9261fb39-9206-4f6a-80dd-0b5329c8ba4b reference to the query id
token	string Example: token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsInVzZXJuYW1lIjoiYWRtaW4iLCJleHAiOjE1NzU2NjE The token for the next page of results

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

Content type

application/json

{"Results": [{"id": 0,
"userId": "string",
"paymentId": 0,
"eventId": 0,
"checkedinUserId": 0,
"action": "string",
"method": "string",
"appId": 0,
"deleted": true,
"updatedOn": "2019-08-24T14:15:22Z",
"createdOn": "2019-08-24T14:15:22Z"
}
],
"NextToken": "string"
}

Request Checkins

Request checkins that were updated between the specified start and end dates This endpoint returns a queryId that can be used to retrieve the results of the query. Use Retrieve Checkins to retrieve the results of the query and upon success

query Parameters

updatedStart required	string <date-time> Example: updatedStart=2020-01-01T00:00:00Z&updatedStart=2020-01-01 The `updatedOn` start date to filter the query (inclusive)
updatedEnd required	string <date-time> Example: updatedEnd=2020-01-01T23:59:59Z The `updatedOn` end date to filter the query (inclusive)

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

200
400
401
500

Content type

application/json

{"queryId": "9261fb39-9206-4f6a-80dd-0b5329c8ba4b"
}

Users

Endpoint to retrieve users, it returns a query id that can be used to retrieve the results of the query. Use Request Users to request the data results of the query and upon success of the query use Retrieve Users

Retrieve Users

After a query has been submitted, this endpoint can be used to retrieve the results of the query given the query ID.

query Parameters

queryId required	string Example: queryId=9261fb39-9206-4f6a-80dd-0b5329c8ba4b reference to the query id
token	string Example: token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsInVzZXJuYW1lIjoiYWRtaW4iLCJleHAiOjE1NzU2NjE The token for the next page of results

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

Content type

application/json

{"Results": [{"id": 0,
"firstName": "string",
"lastName": "string",
"maidenName": "string",
"middleInitial": "string",
"email": "user@example.com",
"otherEmail": "user@example.com",
"alumniEmail": "user@example.com",
"preferredEmail": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"netid": "string",
"netid2": "string",
"netid3": "string",
"swipeid": "string",
"qrcode": "string",
"barcode": "string",
"rfid": "string",
"externalUid": "string",
"deactivated": true,
"schoolProgram": "string",
"degree": "string",
"companyName": "string",
"workTitle": "string",
"accountType": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"monthOfEntry": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"yearOfEntry": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"monthOfGraduation": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"yearOfGraduation": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"gender": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"genderPronouns": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"phoneNumber": "string",
"mobileNumber": "string",
"streetAddress": "string",
"city": "string",
"state": "string",
"zipcode": "string",
"country": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"bio": "string",
"source": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"isAdmin": true,
"createdOn": "2019-08-24T14:15:22Z",
"updatedOn": "2019-08-24T14:15:22Z",
"tags": [{"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
}
],
"personalInterests": [{"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
}
],
"sportsInterests": [{"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
}
],
"careerInterests": [{"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
}
],
"lookingFor": [{"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
}
],
"languages": [{"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
}
],
"nationalities": [{"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
}
],
"customFields": [{"answer": "string",
"question": "string"
}
]
}
],
"NextToken": "string"
}

Request Users

Request users that were updated between the specified start and end dates This endpoint returns a queryId that can be used to retrieve the results of the query. Use Retrieve Users to retrieve the results of the query and upon success

query Parameters

updatedStart required	string <date-time> Example: updatedStart=2020-01-01T00:00:00Z&updatedStart=2020-01-01 The `updatedOn` start date to filter the query (inclusive)
updatedEnd required	string <date-time> Example: updatedEnd=2020-01-01T23:59:59Z The `updatedOn` end date to filter the query (inclusive)

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

200
400
401
500

Content type

application/json

{"queryId": "9261fb39-9206-4f6a-80dd-0b5329c8ba4b"
}

Academic Experiences

Endpoint to retrieve academic_experiences, it returns a query id that can be used to retrieve the results of the query. Use Request Academic Experiences to request the data results of the query and upon success of the query use Retrieve Academic Experiences

Retrieve Academic Experiences

After a query has been submitted, this endpoint can be used to retrieve the results of the query given the query ID.

query Parameters

queryId required	string Example: queryId=9261fb39-9206-4f6a-80dd-0b5329c8ba4b reference to the query id
token	string Example: token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsInVzZXJuYW1lIjoiYWRtaW4iLCJleHAiOjE1NzU2NjE The token for the next page of results

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

Content type

application/json

{"Results": [{"id": 0,
"updatedOn": "2019-08-24T14:15:22Z",
"createdOn": "2019-08-24T14:15:22Z",
"userId": 0,
"university": "string",
"studyField": "string",
"degree": "string",
"activities": "string",
"startYear": 0,
"endYear": 0,
"deleted": true,
"location": "string"
}
],
"NextToken": "string"
}

Request Academic Experiences

Request Academic Experiences that were updated between the specified start and end dates This endpoint returns a queryId that can be used to retrieve the results of the query. Use Retrieve Academic Experiences to retrieve the results of the query and upon success

query Parameters

updatedStart required	string <date-time> Example: updatedStart=2020-01-01T00:00:00Z&updatedStart=2020-01-01 The `updatedOn` start date to filter the query (inclusive)
updatedEnd required	string <date-time> Example: updatedEnd=2020-01-01T23:59:59Z The `updatedOn` end date to filter the query (inclusive)

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

200
400
401
500

Content type

application/json

{"queryId": "9261fb39-9206-4f6a-80dd-0b5329c8ba4b"
}

Work Experiences

Endpoint to retrieve work_experiences, it returns a query id that can be used to retrieve the results of the query. Use Request Work Experiences to request the data results of the query and upon success of the query use Retrieve Work Experiences

Retrieve Work Experiences

After a query has been submitted, this endpoint can be used to retrieve the results of the query given the query ID.

query Parameters

queryId required	string Example: queryId=9261fb39-9206-4f6a-80dd-0b5329c8ba4b reference to the query id
token	string Example: token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsInVzZXJuYW1lIjoiYWRtaW4iLCJleHAiOjE1NzU2NjE The token for the next page of results

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

Content type

application/json

{"Results": [{"id": 0,
"updatedOn": "2019-08-24T14:15:22Z",
"createdOn": "2019-08-24T14:15:22Z",
"userId": 0,
"companyName": "string",
"industry": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"title": "string",
"description": "string",
"startYear": 0,
"startMonth": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"endYear": 0,
"endMonth": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"deleted": true,
"location": "string",
"department": "string",
"country": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
}
}
],
"NextToken": "string"
}

Request Work Experiences

Request Work Experiences that were updated between the specified start and end dates This endpoint returns a queryId that can be used to retrieve the results of the query. Use Retrieve Work Experiences to retrieve the results of the query and upon success

query Parameters

updatedStart required	string <date-time> Example: updatedStart=2020-01-01T00:00:00Z&updatedStart=2020-01-01 The `updatedOn` start date to filter the query (inclusive)
updatedEnd required	string <date-time> Example: updatedEnd=2020-01-01T23:59:59Z The `updatedOn` end date to filter the query (inclusive)

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

200
400
401
500

Content type

application/json

{"queryId": "9261fb39-9206-4f6a-80dd-0b5329c8ba4b"
}

Groups

Endpoint to retrieve groups, it returns a query id that can be used to retrieve the results of the query. Use Request Groups to request the data results of the query and upon success of the query use Retrieve Groups

Retrieve Groups

After a query has been submitted, this endpoint can be used to retrieve the results of the query given the query ID.

query Parameters

queryId required	string Example: queryId=9261fb39-9206-4f6a-80dd-0b5329c8ba4b reference to the query id
token	string Example: token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsInVzZXJuYW1lIjoiYWRtaW4iLCJleHAiOjE1NzU2NjE The token for the next page of results

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

Content type

application/json

{"Results": [{"id": 0,
"name": "string",
"email": "string",
"acronym": "string",
"type": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"country": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"mission": "string",
"goals": "string",
"membershipBenefits": "string",
"published": true,
"webSite": "string",
"logoUrl": "string",
"externalGroupId": "string",
"status": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"hideFromGroupsList": true,
"closeMembership": true,
"deactivated": true,
"privateMembership": true,
"paymentGateway": "string",
"parentGroupId": 0,
"membershipDefaultDuration": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"createdOn": "2019-08-24T14:15:22Z",
"updatedOn": "2019-08-24T14:15:22Z",
"categoryTags": [{"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
}
],
"membershipOptions": [{"name": "string",
"fee": 10.75,
"duration": "Lifetime",
"optionNum": 1
}
],
"customFields": [{"answer": "string",
"question": "string"
}
]
}
],
"NextToken": "string"
}

Request Groups

Request groups that were updated between the specified start and end dates This endpoint returns a queryId that can be used to retrieve the results of the query. Use Retrieve Groups to retrieve the results of the query and upon success

query Parameters

updatedStart required	string <date-time> Example: updatedStart=2020-01-01T00:00:00Z&updatedStart=2020-01-01 The `updatedOn` start date to filter the query (inclusive)
updatedEnd required	string <date-time> Example: updatedEnd=2020-01-01T23:59:59Z The `updatedOn` end date to filter the query (inclusive)

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

200
400
401
500

Content type

application/json

{"queryId": "9261fb39-9206-4f6a-80dd-0b5329c8ba4b"
}

Members

Endpoint to retrieve members, it returns a query id that can be used to retrieve the results of the query. Use Request Members to request the data results of the query and upon success of the query use Retrieve Members

Retrieve Members

After a query has been submitted, this endpoint can be used to retrieve the results of the query given the query ID.

query Parameters

queryId required	string Example: queryId=9261fb39-9206-4f6a-80dd-0b5329c8ba4b reference to the query id
token	string Example: token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsInVzZXJuYW1lIjoiYWRtaW4iLCJleHAiOjE1NzU2NjE The token for the next page of results

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

Content type

application/json

{"Results": [{"id": 0,
"userId": 0,
"groupId": 0,
"member": 0,
"membershipEndDate": "2019-08-24",
"officerStatus": "current_officer",
"officerPosition": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"customPosition": "string",
"customPositionType": "officer",
"officerRole": "string",
"source": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"validated": true,
"createdOn": "2019-08-24T14:15:22Z",
"deleted": true,
"updatedOn": "2019-08-24T14:15:22Z",
"tags": [{"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
}
],
"customFields": [{"answer": "string",
"question": "string"
}
]
}
],
"NextToken": "string"
}

Request Members

Request members that were updated between the specified start and end dates This endpoint returns a queryId that can be used to retrieve the results of the query. Use Retrieve Members to retrieve the results of the query and upon success

query Parameters

updatedStart required	string <date-time> Example: updatedStart=2020-01-01T00:00:00Z&updatedStart=2020-01-01 The `updatedOn` start date to filter the query (inclusive)
updatedEnd required	string <date-time> Example: updatedEnd=2020-01-01T23:59:59Z The `updatedOn` end date to filter the query (inclusive)

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

200
400
401
500

Content type

application/json

{"queryId": "9261fb39-9206-4f6a-80dd-0b5329c8ba4b"
}

Retrieve Tags

After a query has been submitted, this endpoint can be used to retrieve the results of the query given the query ID.

query Parameters

queryId required	string Example: queryId=9261fb39-9206-4f6a-80dd-0b5329c8ba4b reference to the query id
token	string Example: token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsInVzZXJuYW1lIjoiYWRtaW4iLCJleHAiOjE1NzU2NjE The token for the next page of results

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

Content type

application/json

{"Results": [{"id": 0,
"name": "string",
"color": "string",
"type": "string",
"adminOnly": 0,
"parentId": 0,
"groupId": 0,
"userId": 0,
"deleted": 0,
"createdOn": "2019-08-24T14:15:22Z",
"updatedOn": "2019-08-24T14:15:22Z"
}
],
"NextToken": "string"
}

Request Tags

Request tags that were updated between the specified start and end dates. This endpoint returns a queryId that can be used to retrieve the results of the query. Use Retrieve Tags to retrieve the results of the query and upon success

query Parameters

updatedStart required	string <date-time> Example: updatedStart=2020-01-01T00:00:00Z&updatedStart=2020-01-01 The `updatedOn` start date to filter the query (inclusive)
updatedEnd required	string <date-time> Example: updatedEnd=2020-01-01T23:59:59Z The `updatedOn` end date to filter the query (inclusive)

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

200
400
401
500

Content type

application/json

{"queryId": "9261fb39-9206-4f6a-80dd-0b5329c8ba4b"
}

Budgets

Endpoint to retrieve budgets, it returns a query id that can be used to retrieve the results of the query. Use Request Budgets to request the data results of the query and upon success of the query use Retrieve Budgets

Retrieve Budgets

After a query has been submitted, this endpoint can be used to retrieve the results of the query given the query ID.

query Parameters

queryId required	string Example: queryId=9261fb39-9206-4f6a-80dd-0b5329c8ba4b reference to the query id
token	string Example: token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsInVzZXJuYW1lIjoiYWRtaW4iLCJleHAiOjE1NzU2NjE The token for the next page of results

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

Content type

application/json

{"Results": [{"createdOn": "2019-08-24T14:15:22Z",
"updatedOn": "2019-08-24T14:15:22Z",
"id": 0,
"userId": 0,
"name": "string",
"description": "string",
"deleted": true,
"totalAllocation": 0.1,
"budgetStatus": "string",
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"budgetRequestFormId": 0,
"budgetType": "Simple",
"paymentRequestApprovalFormId": 0,
"budgetAdmins": [0
]
}
],
"NextToken": "string"
}

Request Budgets

Request budgets that were updated between the specified start and end dates This endpoint returns a queryId that can be used to retrieve the results of the query. Use Retrieve Budgets to retrieve the results of the query and upon success

query Parameters

updatedStart required	string <date-time> Example: updatedStart=2020-01-01T00:00:00Z&updatedStart=2020-01-01 The `updatedOn` start date to filter the query (inclusive)
updatedEnd required	string <date-time> Example: updatedEnd=2020-01-01T23:59:59Z The `updatedOn` end date to filter the query (inclusive)

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

200
400
401
500

Content type

application/json

{"queryId": "9261fb39-9206-4f6a-80dd-0b5329c8ba4b"
}

Budget Transactions

Endpoint to retrieve budget_transactions, it returns a query id that can be used to retrieve the results of the query. Use Request Budget Transactions to request the data results of the query and upon success of the query use Retrieve Budget Transactions

Retrieve Budget Transactions

After a query has been submitted, this endpoint can be used to retrieve the results of the query given the query ID.

query Parameters

queryId required	string Example: queryId=9261fb39-9206-4f6a-80dd-0b5329c8ba4b reference to the query id
token	string Example: token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsInVzZXJuYW1lIjoiYWRtaW4iLCJleHAiOjE1NzU2NjE The token for the next page of results

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

Content type

application/json

{"Results": [{"createdOn": "2019-08-24T14:15:22Z",
"updatedOn": "2019-08-24T14:15:22Z",
"id": 0,
"userId": 0,
"budgetId": 0,
"groupId": 0,
"deleted": true,
"description": "string",
"amountFromAllocation": 0.1,
"amountFromGroupFunds": 0.1,
"paymentMethod": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"transactionCategory": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"budgetSourceType": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"vendorName": "string",
"externalTransactionId": "string",
"additionalNotes": "string",
"fundRequestType": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"fundRequestStatus": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"referenceNumber": "string",
"receipts": ["string"
]
}
],
"NextToken": "string"
}

Request Budget Transactions

Request budget transactions that were updated between the specified start and end dates This endpoint returns a queryId that can be used to retrieve the results of the query. Use Retrieve Budget Transactions to retrieve the results of the query and upon success

query Parameters

updatedStart required	string <date-time> Example: updatedStart=2020-01-01T00:00:00Z&updatedStart=2020-01-01 The `updatedOn` start date to filter the query (inclusive)
updatedEnd required	string <date-time> Example: updatedEnd=2020-01-01T23:59:59Z The `updatedOn` end date to filter the query (inclusive)

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

200
400
401
500

Content type

application/json

{"queryId": "9261fb39-9206-4f6a-80dd-0b5329c8ba4b"
}

Surveys

Endpoint to retrieve surveys, it returns a query id that can be used to retrieve the results of the query. Use Request Surveys to request the data results of the query and upon success of the query use Retrieve Surveys

Retrieve Surveys

After a query has been submitted, this endpoint can be used to retrieve the results of the query given the query ID.

query Parameters

queryId required	string Example: queryId=9261fb39-9206-4f6a-80dd-0b5329c8ba4b reference to the query id
token	string Example: token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsInVzZXJuYW1lIjoiYWRtaW4iLCJleHAiOjE1NzU2NjE The token for the next page of results

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

Content type

application/json

{"Results": [{"id": 0,
"name": "string",
"description": "string",
"authorId": 0,
"type": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"workflowTemplateId": 0,
"blockResubmitStatus": "string",
"mandatoryAudience": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"quizPassScore": 0,
"closed": true,
"openDate": "2019-08-24T14:15:22Z",
"closeDate": "2019-08-24T14:15:22Z",
"submissionCap": 0,
"loginRequired": true,
"anonymousSubmissions": 0,
"whoCanSubmit": "string",
"createdOn": "2019-08-24T14:15:22Z",
"updatedOn": "2019-08-24T14:15:22Z",
"deleted": true,
"groupId": 0,
"archived": true,
"tags": [{"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
}
],
"mandatoryMembersTags": [{"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
}
]
}
],
"NextToken": "string"
}

Request Surveys

Request surveys data based on the query ID

query Parameters

updatedStart required	string <date-time> Example: updatedStart=2020-01-01T00:00:00Z&updatedStart=2020-01-01 The `updatedOn` start date to filter the query (inclusive)
updatedEnd required	string <date-time> Example: updatedEnd=2020-01-01T23:59:59Z The `updatedOn` end date to filter the query (inclusive)

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

200
400
401
500

Content type

application/json

{"queryId": "9261fb39-9206-4f6a-80dd-0b5329c8ba4b"
}

Survey Submissions

Endpoint to retrieve survey submissions, it returns a query id that can be used to retrieve the results of the query. Use Request Survey Submissions to request the data results of the query and upon success of the query use Retrieve Survey Submissions

Retrieve Survey Submissions

Retrieve survey submissions data based on the specified start and end dates

query Parameters

queryId required	string Example: queryId=9261fb39-9206-4f6a-80dd-0b5329c8ba4b reference to the query id
token	string Example: token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsInVzZXJuYW1lIjoiYWRtaW4iLCJleHAiOjE1NzU2NjE The token for the next page of results

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

Content type

application/json

{"Results": [{"id": 0,
"deleted": true,
"status": "string",
"approvedBy": 0,
"approvedOn": "2019-08-24T14:15:22Z",
"archived": true,
"draft": true,
"createdOn": "2019-08-24T14:15:22Z",
"contentType": "string",
"contentTypeId": 0,
"memberId": 0,
"quizScore": 0,
"userId": 0,
"submittedOn": "2019-08-24T14:15:22Z",
"surveyId": 0,
"updatedOn": "2019-08-24T14:15:22Z",
"tags": [{"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
}
],
"responses": [{"answers": ["string"
],
"proposedAnswers": ["string"
],
"question": "string",
"questionId": "string",
"questionType": "string"
}
]
}
],
"NextToken": "string"
}

Request Survey Submissions

Request survey submissions data based on the query ID

query Parameters

updatedStart required	string <date-time> Example: updatedStart=2020-01-01T00:00:00Z&updatedStart=2020-01-01 The `updatedOn` start date to filter the query (inclusive)
updatedEnd required	string <date-time> Example: updatedEnd=2020-01-01T23:59:59Z The `updatedOn` end date to filter the query (inclusive)

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

200
400
401
500

Content type

application/json

{"queryId": "9261fb39-9206-4f6a-80dd-0b5329c8ba4b"
}

Rooms

Endpoint to retrieve rooms, it returns a query id that can be used to retrieve the results of the query. Use Request Rooms to request the data results of the query and upon success of the query use Retrieve Rooms

Retrieve Rooms

After a query has been submitted, this endpoint can be used to retrieve the results of the query given the query ID.

query Parameters

queryId required	string Example: queryId=9261fb39-9206-4f6a-80dd-0b5329c8ba4b reference to the query id
token	string Example: token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsInVzZXJuYW1lIjoiYWRtaW4iLCJleHAiOjE1NzU2NjE The token for the next page of results

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

Content type

application/json

{"Results": [{"id": 0,
"name": "string",
"description": "string",
"capacity": 0,
"photoUrl": "string",
"active": true,
"type": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"building": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"floor": {"id": 0,
"name": "string",
"updatedOn": "2019-08-24T14:15:22Z"
},
"createdOn": "2019-08-24T14:15:22Z",
"updatedOn": "2019-08-24T14:15:22Z"
}
],
"NextToken": "string"
}

Request Rooms

Request rooms that were updated between the specified start and end dates. This endpoint returns a queryId that can be used to retrieve the results of the query. Use Retrieve Rooms to retrieve the results of the query and upon success

query Parameters

updatedStart required	string <date-time> Example: updatedStart=2020-01-01T00:00:00Z&updatedStart=2020-01-01 The `updatedOn` start date to filter the query (inclusive)
updatedEnd required	string <date-time> Example: updatedEnd=2020-01-01T23:59:59Z The `updatedOn` end date to filter the query (inclusive)

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

200
400
401
500

Content type

application/json

{"queryId": "9261fb39-9206-4f6a-80dd-0b5329c8ba4b"
}

Room Reservations

Endpoint to retrieve room reservations, it returns a query id that can be used to retrieve the results of the query. Use Request Room Reservations to request the data results of the query and upon success of the query use Retrieve Room Reservations

Retrieve Room Reservations

After a query has been submitted, this endpoint can be used to retrieve the results of the query given the query ID.

query Parameters

queryId required	string Example: queryId=9261fb39-9206-4f6a-80dd-0b5329c8ba4b reference to the query id
token	string Example: token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsInVzZXJuYW1lIjoiYWRtaW4iLCJleHAiOjE1NzU2NjE The token for the next page of results

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

Content type

application/json

{"Results": [{"id": 0,
"eventId": 0,
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"roomId": 0,
"externalReservationId": "string",
"status": "pending",
"userId": 0,
"name": "string",
"createdOn": "2019-08-24T14:15:22Z",
"updatedOn": "2019-08-24T14:15:22Z"
}
],
"NextToken": "string"
}

Request Room Reservations

Request room reservations that were updated between the specified start and end dates. This endpoint returns a queryId that can be used to retrieve the results of the query. Use Retrieve Room Reservations to retrieve the results of the query and upon success

query Parameters

updatedStart required	string <date-time> Example: updatedStart=2020-01-01T00:00:00Z&updatedStart=2020-01-01 The `updatedOn` start date to filter the query (inclusive)
updatedEnd required	string <date-time> Example: updatedEnd=2020-01-01T23:59:59Z The `updatedOn` end date to filter the query (inclusive)

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

200
400
401
500

Content type

application/json

{"queryId": "9261fb39-9206-4f6a-80dd-0b5329c8ba4b"
}

Badges

Endpoint to retrieve badges, it returns a query id that can be used to retrieve the results of the query. Use Request Badges to request the data results of the query and upon success of the query use Retrieve Badges

Retrieve Badges

After a query has been submitted, this endpoint can be used to retrieve the results of the query given the query ID.

query Parameters

queryId required	string Example: queryId=9261fb39-9206-4f6a-80dd-0b5329c8ba4b reference to the query id
token	string Example: token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsInVzZXJuYW1lIjoiYWRtaW4iLCJleHAiOjE1NzU2NjE The token for the next page of results

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

Content type

application/json

{"Results": [{"id": 0,
"name": "string",
"description": "string",
"userId": 0,
"groupId": 0,
"private": true,
"groupBadge": false,
"photoUrl": "string",
"completionRuleId": 0,
"isLinkedinCertificate": true,
"winLimit": 0,
"deleted": true,
"createdOn": "2019-08-24T14:15:22Z",
"updatedOn": "2019-08-24T14:15:22Z"
}
],
"NextToken": "string"
}

Request Badges

Request badges that were updated between the specified start and end dates This endpoint returns a queryId that can be used to retrieve the results of the query. Use Retrieve Badges to retrieve the results of the query and upon success

query Parameters

updatedStart required	string <date-time> Example: updatedStart=2020-01-01T00:00:00Z&updatedStart=2020-01-01 The `updatedOn` start date to filter the query (inclusive)
updatedEnd required	string <date-time> Example: updatedEnd=2020-01-01T23:59:59Z The `updatedOn` end date to filter the query (inclusive)

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

200
400
401
500

Content type

application/json

{"queryId": "9261fb39-9206-4f6a-80dd-0b5329c8ba4b"
}

Badge Completions

Endpoint to retrieve badge completions, it returns a query id that can be used to retrieve the results of the query. Use Request Badge Completions to request the data results of the query and upon success of the query use Retrieve Badge Completions

Retrieve Badge Completions

After a query has been submitted, this endpoint can be used to retrieve the results of the query given the query ID.

query Parameters

queryId required	string Example: queryId=9261fb39-9206-4f6a-80dd-0b5329c8ba4b reference to the query id
token	string Example: token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsInVzZXJuYW1lIjoiYWRtaW4iLCJleHAiOjE1NzU2NjE The token for the next page of results

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

Content type

application/json

{"Results": [{"id": 0,
"badgeId": 0,
"userId": 0,
"groupId": null,
"count": 0,
"deleted": true,
"createdOn": "2019-08-24T14:15:22Z",
"updatedOn": "2019-08-24T14:15:22Z"
}
],
"NextToken": "string"
}

Request Badge Completions

Request badge completions that were updated between the specified start and end dates This endpoint returns a queryId that can be used to retrieve the results of the query. Use Retrieve Badge Completions to retrieve the results of the query and upon success

query Parameters

updatedStart required	string <date-time> Example: updatedStart=2020-01-01T00:00:00Z&updatedStart=2020-01-01 The `updatedOn` start date to filter the query (inclusive)
updatedEnd required	string <date-time> Example: updatedEnd=2020-01-01T23:59:59Z The `updatedOn` end date to filter the query (inclusive)

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

200
400
401
500

Content type

application/json

{"queryId": "9261fb39-9206-4f6a-80dd-0b5329c8ba4b"
}

Feed Posts

Endpoint to retrieve feed posts, it returns a query id that can be used to retrieve the results of the query. Use Request Feed Posts to request the data results of the query and upon success of the query use Retrieve Feed Posts

Retrieve feed posts

After a query has been submitted, this endpoint can be used to retrieve the results of the query given the query ID.

query Parameters

queryId required	string Example: queryId=9261fb39-9206-4f6a-80dd-0b5329c8ba4b reference to the query id
token	string Example: token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsInVzZXJuYW1lIjoiYWRtaW4iLCJleHAiOjE1NzU2NjE The token for the next page of results

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

Content type

application/json

{"Results": [{"createdOn": "2019-08-24T14:15:22Z",
"updatedOn": "2019-08-24T14:15:22Z",
"id": 0,
"type": "feed",
"typeId": 0,
"content": "string",
"userId": 0,
"groupId": 0,
"link": "string",
"deleted": true,
"postType": "string",
"feedPostPrivacy": "string",
"channel": "string",
"attachments": "string",
"comments": [{"id": 0,
"createdOn": "2019-08-24T14:15:22Z",
"updatedOn": "2019-08-24T14:15:22Z",
"userId": 0,
"feedPostId": 0,
"content": "string",
"photo": "string",
"attachments": "string",
"deleted": true
}
]
}
],
"NextToken": "string"
}

Request feed posts

Request feed posts that were updated between the specified start and end dates. This endpoint returns a queryId that can be used to retrieve the results of the query. Use Retrieve Feed Posts to retrieve the results of the query and upon success

query Parameters

updatedStart required	string <date-time> Example: updatedStart=2020-01-01T00:00:00Z&updatedStart=2020-01-01 The `updatedOn` start date to filter the query (inclusive)
updatedEnd required	string <date-time> Example: updatedEnd=2020-01-01T23:59:59Z The `updatedOn` end date to filter the query (inclusive)

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

200
400
401
500

Content type

application/json

{"queryId": "9261fb39-9206-4f6a-80dd-0b5329c8ba4b"
}

Tracks

Endpoint to retrieve tracks, it returns a query id that can be used to retrieve the results of the query. Use Request Tracks to request the data results of the query and upon success of the query use Retrieve Tracks

Retrieve Tracks

After a query has been submitted, this endpoint can be used to retrieve the results of the query given the query ID.

query Parameters

queryId required	string Example: queryId=9261fb39-9206-4f6a-80dd-0b5329c8ba4b reference to the query id
token	string Example: token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsInVzZXJuYW1lIjoiYWRtaW4iLCJleHAiOjE1NzU2NjE The token for the next page of results

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

Content type

application/json

{"Results": [{"id": 0,
"createdOn": "2019-08-24T14:15:22Z",
"updatedOn": "2019-08-24T14:15:22Z",
"groupId": 0,
"userId": 0,
"name": "string",
"description": "string",
"color": "string",
"iconName": "string",
"deleted": true,
"archived": true,
"startDate": "2019-08-24",
"isVisible": true
}
],
"NextToken": "string"
}

Request Tracks

Request tracks that were updated between the specified start and end dates. This endpoint returns a queryId that can be used to retrieve the results of the query. Use Retrieve Tracks to retrieve the results of the query and upon success

query Parameters

updatedStart required	string <date-time> Example: updatedStart=2020-01-01T00:00:00Z&updatedStart=2020-01-01 The `updatedOn` start date to filter the query (inclusive)
updatedEnd required	string <date-time> Example: updatedEnd=2020-01-01T23:59:59Z The `updatedOn` end date to filter the query (inclusive)

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

200
400
401
500

Content type

application/json

{"queryId": "9261fb39-9206-4f6a-80dd-0b5329c8ba4b"
}

Checklists

Endpoint to retrieve checklists, it returns a query id that can be used to retrieve the results of the query. Use Request Checklists to request the data results of the query and upon success of the query use Retrieve Checklists

Retrieve Checklists

After a query has been submitted, this endpoint can be used to retrieve the results of the query given the query ID.

query Parameters

queryId required	string Example: queryId=9261fb39-9206-4f6a-80dd-0b5329c8ba4b reference to the query id
token	string Example: token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsInVzZXJuYW1lIjoiYWRtaW4iLCJleHAiOjE1NzU2NjE The token for the next page of results

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

Content type

application/json

{"Results": [{"id": 0,
"createdOn": "2019-08-24T14:15:22Z",
"updatedOn": "2019-08-24T14:15:22Z",
"name": "string",
"deleted": true,
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"description": "string",
"groupId": 0,
"userId": 0,
"archived": true,
"isVisible": true,
"trackId": 0,
"isSequential": true
}
],
"NextToken": "string"
}

Request Checklists

Request checklists that were updated between the specified start and end dates. This endpoint returns a queryId that can be used to retrieve the results of the query. Use Retrieve Checklists to retrieve the results of the query and upon success

query Parameters

updatedStart required	string <date-time> Example: updatedStart=2020-01-01T00:00:00Z&updatedStart=2020-01-01 The `updatedOn` start date to filter the query (inclusive)
updatedEnd required	string <date-time> Example: updatedEnd=2020-01-01T23:59:59Z The `updatedOn` end date to filter the query (inclusive)

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

200
400
401
500

Content type

application/json

{"queryId": "9261fb39-9206-4f6a-80dd-0b5329c8ba4b"
}

Checklist Items

Endpoint to retrieve checklist items, it returns a query id that can be used to retrieve the results of the query. Use Request Checklist Items to request the data results of the query and upon success of the query use Retrieve Checklist Items

Retrieve Checklist Items

After a query has been submitted, this endpoint can be used to retrieve the results of the query given the query ID.

query Parameters

queryId required	string Example: queryId=9261fb39-9206-4f6a-80dd-0b5329c8ba4b reference to the query id
token	string Example: token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsInVzZXJuYW1lIjoiYWRtaW4iLCJleHAiOjE1NzU2NjE The token for the next page of results

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

Content type

application/json

{"Results": [{"id": 0,
"createdOn": "2019-08-24T14:15:22Z",
"updatedOn": "2019-08-24T14:15:22Z",
"title": "string",
"checklistId": 0,
"deleted": true,
"description": "string",
"optional": true,
"allowStudentToCheck": true,
"deadline": "2019-08-24",
"userId": 0,
"parentChecklistItemId": 0,
"completionRule": {"id": 0,
"updatedOn": "2019-08-24T14:15:22Z",
"ruleType": "string",
"conditionType": "string",
"conditionFilter": "string",
"conditionIteration": 0,
"hasReflection": true,
"reflectionSurveyId": 0,
"reflectionRequiresApproval": true,
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"requireSpecificSubmission": true
}
}
],
"NextToken": "string"
}

Request Checklist Items

Request checklist items that were updated between the specified start and end dates. This endpoint returns a queryId that can be used to retrieve the results of the query. Use Retrieve Checklist Items to retrieve the results of the query and upon success

query Parameters

updatedStart required	string <date-time> Example: updatedStart=2020-01-01T00:00:00Z&updatedStart=2020-01-01 The `updatedOn` start date to filter the query (inclusive)
updatedEnd required	string <date-time> Example: updatedEnd=2020-01-01T23:59:59Z The `updatedOn` end date to filter the query (inclusive)

header Parameters

X-CG-API-Secret required	string The API key for the school, generated by the school in the CampusGroups Admin Page
X-CG-School required	string Example: readyeducation The school code for the school

Responses

Response samples

200
400
401
500

Content type

application/json

{"queryId": "9261fb39-9206-4f6a-80dd-0b5329c8ba4b"
}