Finding a User

Once you’ve got SIS data successfully importing into Signal Kit, you’re going to need to find and reference some users - for SSOing into the application, sending announcements to/from, or confirming that the sync worked as you expected it to. Staff members, students, contacts and the rest of the school community are referred to as users within Signal Kit. This article will walk through a simple user search, but feel free to view the whole user API in our API reference to dive right in.

Search Options

Signal Kit provides two ways for you to find the user you’re looking for. If you already have an ID from your data, finding the Signal Kit user is as easy as passing a few query parameters to the endpoint. Email address searches are also available and just as simple but ID lookups are preferred.

By ID

The User API endpoint accepts a combination of query parameters named source, source_type, source_id. Using the combination of source and source_type, Signal Kit will automatically translate source_id and return the corresponding user.

Valid source values: csv, ddit, aeries

Valid source_type values: staff, teacher, student, contact

By Email Address

The User API endpoint accepts a search query parameter. Simply enter the email address as the value for the search query parameter and that’s it!