Every API request must have a bearer token attached in the Authorization header.
These tokens are generated within the GiveCampus UI and only school administrators with super-user permissions can generate and manage them. You will choose this initial set of “full” administrators during the GiveCampus onboarding process.
All API responses will be delivered over a secure HTTPS connection, and a TLS version of 1.2 or 1.3 is required.
GiveCampus maintains detailed logs of API access and can provide them to your team upon request.
The API delivers data asynchronously using a request-and-poll pattern:
request_id and a status of in_progress./results/{request_id} every 2–5 seconds until status changes to completed (or error).download_url containing a JSON array of objects matching the model defined below.Most requests complete within a few seconds.
You can use the tools below to see responses from the API to understand how to build your own implementation.
You will see the URLs and paths necessary to make your own API calls.
Bearer API_TOKENrequest_id. Copy that ID and then use that in the results section to see the progress of your request and to see the download URL once the request is completed.In the routes section below, there is a "Try it out" button. After authenticating, you can select from the available parameters, and you will see the curl request performed, the results of your request, and any errors if applicable.
GiveCampus Proprietary and Confidential
basePath: "/api" securityDefinitions: Bearer: type: apiKey name: Authorization in: header description: Enter the token with the `Bearer ` prefix, e.g. "Bearer XXXXXXXXXXXXX". paths: "/constituents": get: tags: - Retrieve a list of constituents summary: Find your constituents description: |-This endpoint will submit a request to retrieve constituents based on the supplied parameters.
The results of this request is a JSON object that contains the following:
Once you receive the request_id, you can make a subsequent request to the results operation listed on this page.
You will take this id to check the state of the request and once it is completed you will have a valid download_url that will contain the data from the original constituents request
This endpoint allows you to create constituents.
When providing affiliations, relationships, or solicit codes, they need to exist in the GC system for constituent records to be created.
Note: You can only create up tp 5,000 constituents per request.
" operationId: createConstituents produces: - application/json parameters: - in: body name: Constituent Details schema: type: array items: allOf: - "$ref": constituent_object_part_1.yaml - "$ref": constituent_object_part_2.yaml - "$ref": constituent_object_part_3.yaml security: - Bearer: [] responses: '200': description: returns a request id that can be used to make further requests schema: "$ref": "#/definitions/ApiRequest" '400': description: Invalid request put: tags: - Update constituents summary: Update constituents description: "This endpoint allows you to update constituents.
gc_constituent_id
is used as the key to lookup and update a constituent.
When providing affiliations, relationships, or solicit codes, they need to exist in the GC system for constituent records to be created.
Note: You can only update up tp 5,000 constituents per request.
" operationId: updateConstituents produces: - application/json parameters: - in: body name: Constituent Details schema: type: array items: allOf: - "$ref": constituent_object_part_1.yaml - type: object properties: gc_constituent_id: description: GiveCampus ID for the constituent example: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX type: string format: uuid - "$ref": constituent_object_part_2.yaml - "$ref": constituent_object_part_3.yaml security: - Bearer: [] responses: '200': description: returns a request id that can be used to make further requests schema: "$ref": "#/definitions/ApiRequest" '400': description: Invalid request "/results/{request_id}": get: tags: - Results summary: Get your results description: Returns the results of your request, like constituents operationId: findResults produces: - application/json parameters: - in: path name: request_id schema: type: string required: true description: Request ID security: - Bearer: [] responses: '200': description: returns a status and download url for your request schema: "$ref": "#/definitions/ApiResults" '202': description: returns a status for your request schema: "$ref": "../shared/types/in_progress_api_results.yaml" '400': description: Invalid request definitions: GetConstituents: description: The following fields are returned per constituent in an array in the downloaded file from the Constituents API allOf: - "$ref": constituent_object_part_1.yaml - type: object properties: gc_constituent_id: description: GiveCampus ID for the constituent example: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX type: string format: uuid - "$ref": constituent_object_part_2.yaml - type: object properties: timestamps: description: Times associated to the constituent type: object properties: created_at: description: Timestamp for when the constituent was created in Unix time example: 1672549200 type: integer updated_at: description: Timestamp for the last time the constituent was updated in Unix time example: 1672549200 type: integer - "$ref": constituent_object_part_3.yaml ApiRequest: "$ref": "../shared/types/api_request.yaml" ApiResults: "$ref": "../shared/types/api_results.yaml"