Bulk export reference guide
Export API
Export data from Stellic on demand using our RESTful API. Access secure endpoints for programmatic data retrieval with near real-time delivery.
Before You Begin
Requirements
Superadmin permissions to access export endpoints
All date/time fields use UTC timezone by default
2-minute request timeout limit - large exports may time out and require asynchronous processing
Export Process
The bulk export process varies based on data volume:
Small volumes: Single synchronous request
Large volumes: Asynchronous process with multiple steps
API Structure
Base URL
Parameters
output_format
Yes
Query
Format for exported data. Currently supported: csv
delivery_channel
No
Query
Controls synchronous vs asynchronous flow. Options: http_file (sync), s3 (async). Defaults to sync if omitted
Example URL
Export Flows
Synchronous Flow
Use for small data volumes that can be exported quickly.
When to use:
delivery_channelis omitted or set tohttp_fileData volume is small enough to complete within 2 minutes
Default flow for most exports
Process:
Make a single API call
Download file immediately
Large datasets will fail with timeout errors. Use asynchronous flow instead.
Asynchronous Flow
Use for large data volumes that exceed the timeout limit.
When to use:
delivery_channelis set tos3Exporting extensive datasets
Default flow for certain exports (see below)
Exports that default to asynchronous flow:
audit_requirementsall_appointments(if number of appointments > 5000, otherwise synchronous)sections_counting_for_reqspermissions
These exports automatically use delivery_channel=s3 due to their data volume characteristics.
Process:
Data Types
Audit & Requirements
audit_data
Exports data of all audits.
Sample URL:
audit_requirements
Exports all requirements of an audit along with constraints on each requirement.
Parameters:
reset_cache
Optional
If true, updates cache of all audits. Use when cache needs latest data. May timeout via URL (developer use)
for_ext_ids
Optional
If true, excludes constraints and provides external IDs column instead. Default: false
Sample URL:
incorrect_audit_applications
Exports students with audit application details, checking if applied audit matches expected version and identifying manual applications.
Sample URL:
programs_without_audits
Exports all programs without a relevant audit.
Sample URL:
requirement_units_taken
Exports credits counting towards specific requirements for each student across their programs.
Parameters:
screen_names
Yes
List of requirement screen names. e.g., ["Writing Requirement", "Science Requirement"]
audit_mode
Optional
official or planned. Default: official
exclude_archived
Optional
Exclude archived students. Default: true
Sample URL:
Planning & Registration
plan_courses
Exports course information for students.
Parameters:
mode
Yes
planned or unmatched
course_filter
Optional
registered (official audit) or planned (planned courses). Default: registered
Sample URL:
plancourse_enrollment_by_term
Exports enrollment numbers in plan courses over each term.
Parameters:
years
Yes
List of years. e.g., [2021, 2022]
school_name
Yes
School name. e.g., Divinity School
Sample URL:
registration_details
Exports pre-registration details for courses in a specific semester and year.
Parameters:
year
Yes
Pre-registration year. e.g., 2022
semester
Yes
Semester. e.g., winter, fall
timestamp
Optional
Fetch registrations before this timestamp. e.g., 2023-01-19 01:53
all_students
Optional
Include students with no registrations. Default: False
Sample URL:
sections_counting_for_reqs
Exports courses and requirements from course sections counting towards requirements.
Parameters:
usem_ids
Yes
Term ID(s) for unique semesters. Can specify multiple
Sample URL (Single Term):
Sample URL (Multiple Terms):
Exceptions & Workflows
bulk_exceptions_detailed
Exports all exceptions with filtering options.
Parameters:
school_shortname
Yes
Filter by school ID. e.g., IA
include_all
Yes
Include all exception statuses (active, pending, inactive, canceled, denied)
exclude_archived
Yes
Set to false to export archived students. Default: true
Sample URL:
export_workflow_responses
Exports all petitions for a specified workflow.
Parameters:
workflow_id
Yes
Workflow ID. e.g., 1, 23
Sample URL:
Pathways & Programs
bulk_pathways
Exports all pathways in bulk.
Parameters:
include_placeholders
Yes
Include placeholders with planned courses. Default: false
include_extracurriculars
Yes
Include extracurricular activities. Default: false
Sample URL:
Student Data
student_geneds
Exports GenEd enrollment information for each student.
Sample URL:
engagement_score
Exports engagement scores measuring student interaction and participation.
Sample URL:
graduation_applications
Exports graduation application data with filtering for updated records.
Parameters:
updated_since
Yes
Filter by update timestamp. Formats: ISO 8601, human-readable, Python datetime. e.g., 2025-06-10T02:11:37
use_local_timezone
Yes
Interpret naive datetime as local time. Default: false (UTC)
Sample URL:
remaining_non_admin_requirements
Exports students with remaining requirements while excluding specific administrative requirements (e.g., milestones, portfolios). Useful for graduation clearance processes and targeted outreach to students approaching graduation.
Parameters:
expected_graduation_term
Yes
Unique semester ID for expected graduation term. e.g., 2258
exclude_requirement_names
Yes
List of requirement screen names to exclude from the check. Repeat the parameter for each requirement to exclude (see examples below)
program_name
No
Filter by specific program name to narrow requirement search. e.g., "Computer Science BS"
audit_name
No
Filter by specific audit name to narrow requirement search. e.g., "EY2024"
mode
No
official (excludes planned courses) or planned (includes planned courses). Default: official
active_status
No
Filter by student status. Options: Active, LOA (Leave of Absence). If omitted, includes all status types
exclude_archived
No
true (exclude archived students) or false (include archived students). Default: true
Archived Students: By default, archived students are excluded from the export to focus on active students. To include archived students in the results, add exclude_archived=false to your query parameters.
Excluded Requirements Format: To exclude multiple requirements, repeat the exclude_requirement_names parameter for each requirement:
Sample URL:
Export Columns:
Network ID
Student ID
First Name
Last Name
Primary Advisor
Expected Graduation
Applied for Graduation
Active vs LOA (conditional)
Archived Status
Remaining Requirements Count
Advising & Care
all_appointments
Exports all appointment data with optional filtering and field selection.
Parameters:
start
Yes
Start date (use with end). e.g., 2025-01-01
end
Yes
End date (use with start). e.g., 2025-12-31
fields
Yes
Comma-separated field list. e.g., student_name,advisor_name,appointment_time
Sample URL:
appointments_admin_info
Exports administrative information for staff with admin roles, including timeblock status and scheduling activity.
Sample URL:
tagged_notes
Exports notes with specific tags, including student and creator information.
Parameters:
tag
Yes
Tag to search for on notes. e.g., 2023FANeverAttended
Sample URL:
Groups & Permissions
dynamic_group_entities
Exports users and groups assigned to a specific dynamic group.
Parameters:
dynamic_group
Yes
Dynamic group name. e.g., Engineering Students
Sample URL:
user_groups
Exports a list of all available user groups.
Sample URL:
permissions
Exports a comprehensive list of all permissions in the system, detailing what permissions are assigned, to whom (user or group), on what object, and how the permission was inherited.
Parameters:
usernames
Yes
Comma-separated list of usernames. e.g., jsmith,jdoe
group_ids
Yes
Comma-separated list of group IDs. e.g., 9,12
Omitting both usernames and group_ids will trigger a full export of all permissions for all users and groups, which can take a significant amount of time to generate.
Finding Group IDs: You can find the group ID in the URL when viewing a group in Stellic. Navigate to Staff > Groups, click a group, and check the URL - the number after id= is the group ID.
Sample URLs:
For a specific user:
For a specific group:
For all users and groups:
Last updated
Was this helpful?