Skip to main content
The GET /api/v1/faculty_activities endpoint exposes range filters for every integer-kind property defined on your institution’s faculty activity configurations. This lets you pull, for example, a faculty member’s bar admissions for a year range, or publications above a citation count threshold — without iterating client-side.

​
Filter shape

Each integer property contributes six filter keys, one per comparison operator: Combine gte + lte (or gt + lt) to express a range.

​
Example

Fetch bar admissions admitted between 2010 and 2022 (inclusive):

​
filter[key] is required

Property names are scoped to your institution’s faculty activity configurations. To resolve a property unambiguously, every integer-property filter must be paired with filter[key]=<configuration_kind> so the API knows which configuration to interpret the property name against. The API responds with 400 Bad Request if any of the following are true:
  • filter[key] is missing.
  • filter[key] points to a configuration that does not own the named integer property.
  • The filter value is not a valid integer.

​
Caveats

  • Records whose JSON value for the property is null (or the property is absent) are excluded from gte/lte/gt/lt/eq/neq results.
  • Properties marked allow_multiple are not exposed through these filters.
  • The exact set of available property filters depends on how your institution has configured faculty activities. The API reference page is generated against a representative configuration; substitute your own property names in the URL pattern above.