You can integrate Citizens with iSAMS to automatically sync student data, transcripts, and profile information. This helps you avoid manual uploads and keeps student profiles accurate and up to date.
Step 1: Request REST API access from iSAMS
To get started, you need iSAMS to give Citizens REST API access for your school.
Email [email protected].
In your email, include your iSAMS client code.
Ask them to grant Citizens REST API access to integrate with your iSAMS data.
iSAMS will then provide you with the credentials needed for the integration.
Step 2: Collect your iSAMS API details
Once REST API access has been granted, make sure you have the following details:
Client ID
A long string of letters and numbers.
Client Secret
A long string of letters and numbers.
Base URL
This will look something like:
https://isams.yourschoolname.com
Citizens will need all three from you to complete the integration.
Step 3: Check and set API permissions in iSAMS
As an iSAMS administrator, you can control which data your REST API keys can access.
If you have already configured permissions, double-check that Citizens has access to the required areas listed below.
Required permissions
Citizens needs access to the following data:
Students table
Used for key student profile fields, including:academicHouse
date of birth (dob)
forename
surname
yearGroup
schoolEmailAddress
latestPhotoId
Gradebooks
Required to automatically create Student Transcripts in Citizens.SchoolID
Used to retrieve student photos and automatically import them into student profiles.
Step 4: Share details with Citizens
Once you have:
Client ID
Client Secret
Base URL
Correct permissions enabled
You are ready to complete the setup with Citizens.
If you need help finalising the integration, contact the Citizens team ([email protected]) and share these details securely.
Need help?
If you run into any issues with iSAMS API access, we recommend contacting [email protected] directly. For Citizens-related questions, reach out to the [email protected] and we’ll be happy to help.
💬 Help us make the Citizens app better
What do you like about the app? What’s confusing? Is there anything missing? What do you think we should build next? Citizens was built for you - and your feedback helps us shape what comes next. We want you to absolutely love it!
👉 Email your feedback to: [email protected]