# Scholarly API Documentation

## Docs

- [Create an additional appointment](https://api-docs.scholarlysoftware.com/api-reference/additional-appointments/create-an-additional-appointment.md): Create a new additional appointment
- [Delete an additional appointment](https://api-docs.scholarlysoftware.com/api-reference/additional-appointments/delete-an-additional-appointment.md): Delete a additional appointment
- [Get an additional appointment](https://api-docs.scholarlysoftware.com/api-reference/additional-appointments/get-an-additional-appointment.md): Returns a specific additional appointment including configured record extras
- [List additional appointments](https://api-docs.scholarlysoftware.com/api-reference/additional-appointments/list-additional-appointments.md): Returns a list of additional appointments
- [List additional appointments for a profile](https://api-docs.scholarlysoftware.com/api-reference/additional-appointments/list-additional-appointments-for-a-profile.md)
- [Update an additional appointment](https://api-docs.scholarlysoftware.com/api-reference/additional-appointments/update-an-additional-appointment.md): Update a additional appointment
- [Create an address for a profile](https://api-docs.scholarlysoftware.com/api-reference/addresses/create-an-address-for-a-profile.md)
- [Create an address for an user](https://api-docs.scholarlysoftware.com/api-reference/addresses/create-an-address-for-an-user.md)
- [Delete an address](https://api-docs.scholarlysoftware.com/api-reference/addresses/delete-an-address.md): Deletes a specific address
- [Get an address](https://api-docs.scholarlysoftware.com/api-reference/addresses/get-an-address.md): Returns a specific address by UUID
- [List addresses](https://api-docs.scholarlysoftware.com/api-reference/addresses/list-addresses.md): Returns a list of addresses
- [List addresses for a profile](https://api-docs.scholarlysoftware.com/api-reference/addresses/list-addresses-for-a-profile.md): Returns a list of addresses
- [List addresses for an user](https://api-docs.scholarlysoftware.com/api-reference/addresses/list-addresses-for-an-user.md): Returns a list of addresses
- [Update an address](https://api-docs.scholarlysoftware.com/api-reference/addresses/update-an-address.md): Updates a specific address
- [Create an admin assistant role permission](https://api-docs.scholarlysoftware.com/api-reference/admin-assistant-role-permissions/create-an-admin-assistant-role-permission.md): Grant a permission to an admin assistant role
- [Delete an admin assistant role permission](https://api-docs.scholarlysoftware.com/api-reference/admin-assistant-role-permissions/delete-an-admin-assistant-role-permission.md): Revoke a permission from an admin assistant role
- [Get an admin assistant role permission](https://api-docs.scholarlysoftware.com/api-reference/admin-assistant-role-permissions/get-an-admin-assistant-role-permission.md): Returns a specific admin assistant role permission
- [List admin assistant role permissions](https://api-docs.scholarlysoftware.com/api-reference/admin-assistant-role-permissions/list-admin-assistant-role-permissions.md): Returns a list of admin assistant role permissions
- [Create an admin assistant role](https://api-docs.scholarlysoftware.com/api-reference/admin-assistant-roles/create-an-admin-assistant-role.md): Create a new admin assistant role mapping
- [Delete an admin assistant role](https://api-docs.scholarlysoftware.com/api-reference/admin-assistant-roles/delete-an-admin-assistant-role.md): Delete an admin assistant role mapping
- [Get an admin assistant role](https://api-docs.scholarlysoftware.com/api-reference/admin-assistant-roles/get-an-admin-assistant-role.md): Returns a specific admin assistant role mapping
- [List admin assistant roles](https://api-docs.scholarlysoftware.com/api-reference/admin-assistant-roles/list-admin-assistant-roles.md): Returns a list of admin assistant role mappings
- [List admin assistant roles for an user](https://api-docs.scholarlysoftware.com/api-reference/admin-assistant-roles/list-admin-assistant-roles-for-an-user.md): Returns a list of admin assistant role mappings
- [Update an admin assistant role](https://api-docs.scholarlysoftware.com/api-reference/admin-assistant-roles/update-an-admin-assistant-role.md): Update an admin assistant role mapping
- [Create a backup](https://api-docs.scholarlysoftware.com/api-reference/backups/create-a-backup.md): Creates a new database backup and queues the export job
- [Get a backup](https://api-docs.scholarlysoftware.com/api-reference/backups/get-a-backup.md): Returns details of a specific backup
- [List backups](https://api-docs.scholarlysoftware.com/api-reference/backups/list-backups.md): Returns a list of database backups
- [Create a campus](https://api-docs.scholarlysoftware.com/api-reference/campuses/create-a-campus.md)
- [Delete a campus](https://api-docs.scholarlysoftware.com/api-reference/campuses/delete-a-campus.md)
- [Get a campus](https://api-docs.scholarlysoftware.com/api-reference/campuses/get-a-campus.md)
- [List campuses](https://api-docs.scholarlysoftware.com/api-reference/campuses/list-campuses.md): List all campuses
- [Update a campus](https://api-docs.scholarlysoftware.com/api-reference/campuses/update-a-campus.md)
- [Create a credit line item for a profile](https://api-docs.scholarlysoftware.com/api-reference/credit-line-items/create-a-credit-line-item-for-a-profile.md)
- [Create a line item for a profile](https://api-docs.scholarlysoftware.com/api-reference/credit-line-items/create-a-line-item-for-a-profile.md)
- [Delete a credit line item](https://api-docs.scholarlysoftware.com/api-reference/credit-line-items/delete-a-credit-line-item.md)
- [Delete a line item](https://api-docs.scholarlysoftware.com/api-reference/credit-line-items/delete-a-line-item.md): Deletes a specific credit line item
- [Get a credit line item](https://api-docs.scholarlysoftware.com/api-reference/credit-line-items/get-a-credit-line-item.md)
- [Get a line item](https://api-docs.scholarlysoftware.com/api-reference/credit-line-items/get-a-line-item.md): Returns a specific credit line item by UUID
- [List credit line items](https://api-docs.scholarlysoftware.com/api-reference/credit-line-items/list-credit-line-items.md)
- [List credit line items for a profile](https://api-docs.scholarlysoftware.com/api-reference/credit-line-items/list-credit-line-items-for-a-profile.md)
- [List line items](https://api-docs.scholarlysoftware.com/api-reference/credit-line-items/list-line-items.md): Returns a list of credit line items
- [List line items for a profile](https://api-docs.scholarlysoftware.com/api-reference/credit-line-items/list-line-items-for-a-profile.md): Returns a list of credit line items
- [Update a credit line item](https://api-docs.scholarlysoftware.com/api-reference/credit-line-items/update-a-credit-line-item.md)
- [Update a line item](https://api-docs.scholarlysoftware.com/api-reference/credit-line-items/update-a-line-item.md): Updates a specific credit line item
- [Create a department chair](https://api-docs.scholarlysoftware.com/api-reference/department-chairs/create-a-department-chair.md): Create a new department chair assignment
- [Delete a department chair](https://api-docs.scholarlysoftware.com/api-reference/department-chairs/delete-a-department-chair.md): Delete a department chair assignment
- [Get a department chair](https://api-docs.scholarlysoftware.com/api-reference/department-chairs/get-a-department-chair.md): Returns a specific department chair assignment
- [List department chairs](https://api-docs.scholarlysoftware.com/api-reference/department-chairs/list-department-chairs.md): Returns a list of department chair assignments
- [Create a department](https://api-docs.scholarlysoftware.com/api-reference/departments/create-a-department.md): Creates a new department following JSON:API specification
- [Delete a department](https://api-docs.scholarlysoftware.com/api-reference/departments/delete-a-department.md): Deletes a department following JSON:API specification
- [Get a department](https://api-docs.scholarlysoftware.com/api-reference/departments/get-a-department.md): Returns details of a specific department
- [Get parent department](https://api-docs.scholarlysoftware.com/api-reference/departments/get-parent-department.md)
- [Get parent relationship linkage](https://api-docs.scholarlysoftware.com/api-reference/departments/get-parent-relationship-linkage.md): Returns JSON:API relationship linkage data for the parent department.
- [List child departments](https://api-docs.scholarlysoftware.com/api-reference/departments/list-child-departments.md)
- [List children relationship linkage](https://api-docs.scholarlysoftware.com/api-reference/departments/list-children-relationship-linkage.md): Returns JSON:API relationship linkage data for child departments.
- [List departments](https://api-docs.scholarlysoftware.com/api-reference/departments/list-departments.md): ### A Note on Department Structure
- [Update a department](https://api-docs.scholarlysoftware.com/api-reference/departments/update-a-department.md): Updates a department's name following JSON:API specification
- [Update parent relationship](https://api-docs.scholarlysoftware.com/api-reference/departments/update-parent-relationship.md): Sets or removes the parent department. Pass null data to make this a root department.
- [Create an employment for an user](https://api-docs.scholarlysoftware.com/api-reference/employments/create-an-employment-for-an-user.md)
- [Delete an employment](https://api-docs.scholarlysoftware.com/api-reference/employments/delete-an-employment.md): Deletes a specific employment
- [Get an employment](https://api-docs.scholarlysoftware.com/api-reference/employments/get-an-employment.md): Returns a specific employment by UUID
- [List employments](https://api-docs.scholarlysoftware.com/api-reference/employments/list-employments.md): Returns a list of employments
- [List employments for an user](https://api-docs.scholarlysoftware.com/api-reference/employments/list-employments-for-an-user.md): Returns a list of employments
- [Update an employment](https://api-docs.scholarlysoftware.com/api-reference/employments/update-an-employment.md): Updates a specific employment
- [Create a faculty activity](https://api-docs.scholarlysoftware.com/api-reference/faculty-activities/create-a-faculty-activity.md)
- [Create a faculty activity for a profile](https://api-docs.scholarlysoftware.com/api-reference/faculty-activities/create-a-faculty-activity-for-a-profile.md)
- [Delete a faculty activity](https://api-docs.scholarlysoftware.com/api-reference/faculty-activities/delete-a-faculty-activity.md): Soft-deletes a faculty activity
- [Get a faculty activity](https://api-docs.scholarlysoftware.com/api-reference/faculty-activities/get-a-faculty-activity.md): Returns a single faculty activity by ID
- [List faculty activities](https://api-docs.scholarlysoftware.com/api-reference/faculty-activities/list-faculty-activities.md): Returns a list of faculty activities
- [List faculty activities for a profile](https://api-docs.scholarlysoftware.com/api-reference/faculty-activities/list-faculty-activities-for-a-profile.md): Returns a list of faculty activities
- [Update a faculty activity](https://api-docs.scholarlysoftware.com/api-reference/faculty-activities/update-a-faculty-activity.md): Updates a faculty activity
- [Get a faculty activity configuration](https://api-docs.scholarlysoftware.com/api-reference/faculty-activity-configurations/get-a-faculty-activity-configuration.md): Returns a faculty activity configuration
- [List faculty activity configurations](https://api-docs.scholarlysoftware.com/api-reference/faculty-activity-configurations/list-faculty-activity-configurations.md): Returns a list of faculty activity configurations
- [Confirm a file upload](https://api-docs.scholarlysoftware.com/api-reference/file-upload-requests/confirm-a-file-upload.md): Step 3 of 3-step file upload: Confirm the upload by creating the actual file.
- [Create a file upload request in user's root folder](https://api-docs.scholarlysoftware.com/api-reference/file-upload-requests/create-a-file-upload-request-in-users-root-folder.md): Step 1 of 3-step file upload: Initiate a direct upload.
- [Create a file upload request (initiate direct upload)](https://api-docs.scholarlysoftware.com/api-reference/file-upload-requests/create-a-file-upload-request-initiate-direct-upload.md): Step 1 of 3-step file upload: Initiate a direct upload.
- [Delete a faculty activity file](https://api-docs.scholarlysoftware.com/api-reference/files/delete-a-faculty-activity-file.md): Removes a specific file from a faculty activity using the file's unique identifier
- [Delete a file](https://api-docs.scholarlysoftware.com/api-reference/files/delete-a-file.md): Deletes a file
- [Get a file](https://api-docs.scholarlysoftware.com/api-reference/files/get-a-file.md): Returns details of a specific file
- [List faculty activity files](https://api-docs.scholarlysoftware.com/api-reference/files/list-faculty-activity-files.md): Returns a list of files attached to a specific faculty activity in JSON:API format
- [List files for a folder](https://api-docs.scholarlysoftware.com/api-reference/files/list-files-for-a-folder.md)
- [List files for an user](https://api-docs.scholarlysoftware.com/api-reference/files/list-files-for-an-user.md)
- [Update a file](https://api-docs.scholarlysoftware.com/api-reference/files/update-a-file.md): Update a file's metadata or move it to a different folder.
- [Upload a faculty activity file](https://api-docs.scholarlysoftware.com/api-reference/files/upload-a-faculty-activity-file.md): Uploads a file to a specific faculty activity by sending the raw file binary data in the request body
- [Create a folder](https://api-docs.scholarlysoftware.com/api-reference/folders/create-a-folder.md): Creates a new folder following JSON:API specification
- [Create a folder for an user](https://api-docs.scholarlysoftware.com/api-reference/folders/create-a-folder-for-an-user.md): Creates a new folder following JSON:API specification
- [Delete a folder](https://api-docs.scholarlysoftware.com/api-reference/folders/delete-a-folder.md): Deletes a folder following JSON:API specification. This will also delete any files as well as subfolders and their files.
- [Get a folder](https://api-docs.scholarlysoftware.com/api-reference/folders/get-a-folder.md): Returns details of a specific folder
- [Get parent folder](https://api-docs.scholarlysoftware.com/api-reference/folders/get-parent-folder.md)
- [Get parent relationship linkage](https://api-docs.scholarlysoftware.com/api-reference/folders/get-parent-relationship-linkage.md): Returns JSON:API relationship linkage data for the parent folder.
- [List child folders](https://api-docs.scholarlysoftware.com/api-reference/folders/list-child-folders.md)
- [List children relationship linkage](https://api-docs.scholarlysoftware.com/api-reference/folders/list-children-relationship-linkage.md): Returns JSON:API relationship linkage data for child folders.
- [List folders](https://api-docs.scholarlysoftware.com/api-reference/folders/list-folders.md): Returns root folders for the current user.
- [List folders for an user](https://api-docs.scholarlysoftware.com/api-reference/folders/list-folders-for-an-user.md): Returns root folders for the current user.
- [Update a folder](https://api-docs.scholarlysoftware.com/api-reference/folders/update-a-folder.md): Updates a folder's name following JSON:API specification
- [Update parent relationship](https://api-docs.scholarlysoftware.com/api-reference/folders/update-parent-relationship.md): Updates the parent relationship of a folder (JSON:API relationship endpoint). Use this to move folders.
- [Get an institution](https://api-docs.scholarlysoftware.com/api-reference/institutions/get-an-institution.md): Returns the current institution
- [Create a leave for a profile](https://api-docs.scholarlysoftware.com/api-reference/leaves/create-a-leave-for-a-profile.md)
- [Delete a leave](https://api-docs.scholarlysoftware.com/api-reference/leaves/delete-a-leave.md): Deletes a specific leave
- [Get a leave](https://api-docs.scholarlysoftware.com/api-reference/leaves/get-a-leave.md): Returns a specific leave by UUID
- [List leaves](https://api-docs.scholarlysoftware.com/api-reference/leaves/list-leaves.md): Returns a list of leave records
- [List leaves for a profile](https://api-docs.scholarlysoftware.com/api-reference/leaves/list-leaves-for-a-profile.md): Returns a list of leave records
- [Update a leave](https://api-docs.scholarlysoftware.com/api-reference/leaves/update-a-leave.md): Updates a specific leave
- [Create a phone number for a profile](https://api-docs.scholarlysoftware.com/api-reference/phone-numbers/create-a-phone-number-for-a-profile.md)
- [Create a phone number for an user](https://api-docs.scholarlysoftware.com/api-reference/phone-numbers/create-a-phone-number-for-an-user.md)
- [Delete a phone number](https://api-docs.scholarlysoftware.com/api-reference/phone-numbers/delete-a-phone-number.md): Deletes a specific phone number
- [Get a phone number](https://api-docs.scholarlysoftware.com/api-reference/phone-numbers/get-a-phone-number.md): Returns a specific phone number by UUID
- [List phone numbers](https://api-docs.scholarlysoftware.com/api-reference/phone-numbers/list-phone-numbers.md): Returns a list of phone numbers
- [List phone numbers for a profile](https://api-docs.scholarlysoftware.com/api-reference/phone-numbers/list-phone-numbers-for-a-profile.md): Returns a list of phone numbers
- [List phone numbers for an user](https://api-docs.scholarlysoftware.com/api-reference/phone-numbers/list-phone-numbers-for-an-user.md): Returns a list of phone numbers
- [Update a phone number](https://api-docs.scholarlysoftware.com/api-reference/phone-numbers/update-a-phone-number.md): Updates a specific phone number
- [Create a primary appointment](https://api-docs.scholarlysoftware.com/api-reference/primary-appointments/create-a-primary-appointment.md): Create a new primary appointment
- [Delete a primary appointment](https://api-docs.scholarlysoftware.com/api-reference/primary-appointments/delete-a-primary-appointment.md): Delete a primary appointment
- [Get a primary appointment](https://api-docs.scholarlysoftware.com/api-reference/primary-appointments/get-a-primary-appointment.md): Returns a specific primary appointment
- [List primary appointments](https://api-docs.scholarlysoftware.com/api-reference/primary-appointments/list-primary-appointments.md): Returns a list of primary appointments
- [List primary appointments for a profile](https://api-docs.scholarlysoftware.com/api-reference/primary-appointments/list-primary-appointments-for-a-profile.md)
- [Update a primary appointment](https://api-docs.scholarlysoftware.com/api-reference/primary-appointments/update-a-primary-appointment.md): Update a primary appointment
- [Create a profile](https://api-docs.scholarlysoftware.com/api-reference/profiles/create-a-profile.md): Non-admin users cannot create profiles
- [Delete a profile avatar](https://api-docs.scholarlysoftware.com/api-reference/profiles/delete-a-profile-avatar.md): Delete the avatar image for a profile. This operation is idempotent - it will succeed even if no avatar exists.
- [Delete a profile CV](https://api-docs.scholarlysoftware.com/api-reference/profiles/delete-a-profile-cv.md): Delete the CV for a profile. This operation is idempotent - it will succeed even if no CV exists.
- [Get a profile](https://api-docs.scholarlysoftware.com/api-reference/profiles/get-a-profile.md): Returns a specific profile by UUID with relationships
- [List profiles](https://api-docs.scholarlysoftware.com/api-reference/profiles/list-profiles.md): Returns a list of profiles
- [Update a profile](https://api-docs.scholarlysoftware.com/api-reference/profiles/update-a-profile.md): Update a profile's display name
- [Upload a profile avatar](https://api-docs.scholarlysoftware.com/api-reference/profiles/upload-a-profile-avatar.md): Upload an avatar image for a profile by sending the raw image binary data in the request body
- [Upload a profile CV](https://api-docs.scholarlysoftware.com/api-reference/profiles/upload-a-profile-cv.md): Upload a CV PDF or DOCX for a profile by sending the raw binary data in the request body. Maximum file size is 10 MB.
- [Create a rank](https://api-docs.scholarlysoftware.com/api-reference/ranks/create-a-rank.md): Creates a new rank for the specified institution. Only available at institution admin permission levels.
- [Delete a rank](https://api-docs.scholarlysoftware.com/api-reference/ranks/delete-a-rank.md): Deletes a rank. Only available at institution admin permission levels. Only able to delete ranks with no primary appointments.
- [Get a rank](https://api-docs.scholarlysoftware.com/api-reference/ranks/get-a-rank.md): Returns details of a specific rank
- [List ranks](https://api-docs.scholarlysoftware.com/api-reference/ranks/list-ranks.md): Returns a list of ranks
- [Update a rank](https://api-docs.scholarlysoftware.com/api-reference/ranks/update-a-rank.md): Updates a rank. Only available at institution admin permission levels.
- [Create an user](https://api-docs.scholarlysoftware.com/api-reference/users/create-an-user.md): Create a new user with a display name and email addresses
- [Get an user](https://api-docs.scholarlysoftware.com/api-reference/users/get-an-user.md): Returns a single user by UUID
- [List users](https://api-docs.scholarlysoftware.com/api-reference/users/list-users.md): Return a list of users
- [Update an user](https://api-docs.scholarlysoftware.com/api-reference/users/update-an-user.md): Updates an existing user
- [Additional appointment created](https://api-docs.scholarlysoftware.com/api-reference/webhooks/additional_appointment-created.md): Triggered when a new additional appointment is created in an institution
- [Additional appointment deleted](https://api-docs.scholarlysoftware.com/api-reference/webhooks/additional_appointment-deleted.md): Triggered when a additional appointment is deleted from an institution
- [Additional appointment updated](https://api-docs.scholarlysoftware.com/api-reference/webhooks/additional_appointment-updated.md): Triggered when a additional appointment is updated in an institution
- [Backup completed](https://api-docs.scholarlysoftware.com/api-reference/webhooks/backup-completed.md): Triggered when an institution backup export is completed
- [Department created](https://api-docs.scholarlysoftware.com/api-reference/webhooks/department-created.md): Triggered when a new department is created in an institution
- [Department deleted](https://api-docs.scholarlysoftware.com/api-reference/webhooks/department-deleted.md): Triggered when a department is deleted from an institution
- [Department updated](https://api-docs.scholarlysoftware.com/api-reference/webhooks/department-updated.md): Triggered when a department is updated in an institution
- [Faculty activity created](https://api-docs.scholarlysoftware.com/api-reference/webhooks/faculty_activity-created.md): Triggered when a new faculty activity is created in an institution
- [Faculty activity deleted](https://api-docs.scholarlysoftware.com/api-reference/webhooks/faculty_activity-deleted.md): Triggered when a faculty activity is deleted from an institution
- [Faculty activity updated](https://api-docs.scholarlysoftware.com/api-reference/webhooks/faculty_activity-updated.md): Triggered when a faculty activity is updated in an institution
- [Primary appointment created](https://api-docs.scholarlysoftware.com/api-reference/webhooks/primary_appointment-created.md): Triggered when a new primary appointment is created in an institution
- [Primary appointment deleted](https://api-docs.scholarlysoftware.com/api-reference/webhooks/primary_appointment-deleted.md): Triggered when a primary appointment is deleted from an institution
- [Primary appointment updated](https://api-docs.scholarlysoftware.com/api-reference/webhooks/primary_appointment-updated.md): Triggered when a primary appointment is updated in an institution
- [Profile created](https://api-docs.scholarlysoftware.com/api-reference/webhooks/profile-created.md): Triggered when a new profile is created in an institution
- [Profile deleted](https://api-docs.scholarlysoftware.com/api-reference/webhooks/profile-deleted.md): Triggered when a profile is deleted from an institution
- [Profile related object updated](https://api-docs.scholarlysoftware.com/api-reference/webhooks/profile-related_object_updated.md): Triggered when a profile or any object in its graph (activities, appointments, leaves, custom fields, rank, department) changes. Typically, we recommend customers don't use this webhook and instead listen to the individual events on the specific models.
- [Profile updated](https://api-docs.scholarlysoftware.com/api-reference/webhooks/profile-updated.md): Triggered when a profile is updated in an institution
- [Rank created](https://api-docs.scholarlysoftware.com/api-reference/webhooks/rank-created.md): Triggered when a new rank is created in an institution
- [Rank deleted](https://api-docs.scholarlysoftware.com/api-reference/webhooks/rank-deleted.md): Triggered when a rank is deleted from an institution
- [Rank updated](https://api-docs.scholarlysoftware.com/api-reference/webhooks/rank-updated.md): Triggered when a rank is updated in an institution
- [Workflows case completed](https://api-docs.scholarlysoftware.com/api-reference/webhooks/workflows_case-completed.md): Triggered when a workflow case is completed (all steps finished)
- [Workflows case created](https://api-docs.scholarlysoftware.com/api-reference/webhooks/workflows_case-created.md): Triggered when a new workflow case is created
- [Workflows case deleted](https://api-docs.scholarlysoftware.com/api-reference/webhooks/workflows_case-deleted.md): Triggered when a workflow case is deleted
- [Workflows case response completed](https://api-docs.scholarlysoftware.com/api-reference/webhooks/workflows_case-response_completed.md): Triggered when a step response is completed in a workflow case
- [Workflows case updated](https://api-docs.scholarlysoftware.com/api-reference/webhooks/workflows_case-updated.md): Triggered when a workflow case is updated
- [Get a workflow case](https://api-docs.scholarlysoftware.com/api-reference/workflow-cases/get-a-workflow-case.md): Returns a specific case (faculty evaluation) by ID
- [List workflow cases](https://api-docs.scholarlysoftware.com/api-reference/workflow-cases/list-workflow-cases.md): Returns a list of all cases (faculty evaluations) accessible to the user
- [List workflow cases for a workflow group](https://api-docs.scholarlysoftware.com/api-reference/workflow-cases/list-workflow-cases-for-a-workflow-group.md): Returns a list of all cases (faculty evaluations) accessible to the user
- [Get a workflow definition](https://api-docs.scholarlysoftware.com/api-reference/workflow-definitions/get-a-workflow-definition.md): Returns a specific workflow definition
- [List workflow definitions](https://api-docs.scholarlysoftware.com/api-reference/workflow-definitions/list-workflow-definitions.md): Returns a list of workflow definitions
- [Get a workflow group](https://api-docs.scholarlysoftware.com/api-reference/workflow-groups/get-a-workflow-group.md): Returns a specific workflow group by ID
- [List children of a workflow group](https://api-docs.scholarlysoftware.com/api-reference/workflow-groups/list-children-of-a-workflow-group.md)
- [List workflow groups for a workflow](https://api-docs.scholarlysoftware.com/api-reference/workflow-groups/list-workflow-groups-for-a-workflow.md)
- [Get a workflow response](https://api-docs.scholarlysoftware.com/api-reference/workflow-responses/get-a-workflow-response.md): Returns a specific workflow response by ID
- [List workflow responses](https://api-docs.scholarlysoftware.com/api-reference/workflow-responses/list-workflow-responses.md): Returns a list of workflow responses.
- [List workflow responses for a workflow case](https://api-docs.scholarlysoftware.com/api-reference/workflow-responses/list-workflow-responses-for-a-workflow-case.md): Returns a list of workflow responses.
- [Get a workflow step](https://api-docs.scholarlysoftware.com/api-reference/workflow-steps/get-a-workflow-step.md): Returns a specific workflow step by UUID
- [List workflow steps](https://api-docs.scholarlysoftware.com/api-reference/workflow-steps/list-workflow-steps.md): Returns a list of workflow steps
- [List workflow steps for a workflow definition](https://api-docs.scholarlysoftware.com/api-reference/workflow-steps/list-workflow-steps-for-a-workflow-definition.md): Returns a list of workflow steps
- [Get a workflow](https://api-docs.scholarlysoftware.com/api-reference/workflows/get-a-workflow.md): Returns a specific workflow (faculty evaluation cycle) by UUID
- [List workflows](https://api-docs.scholarlysoftware.com/api-reference/workflows/list-workflows.md): Returns a list of workflows (faculty evaluation cycles)
- [Filtering Faculty Activities by Integer Properties](https://api-docs.scholarlysoftware.com/faculty-activity-filters.md): Bound your faculty activity queries to a numeric range over an integer property defined by your institution.
- [File Uploads](https://api-docs.scholarlysoftware.com/file-uploads.md): To support file uploads of any size and type, Scholarly uses a 3-step process for uploading files.
- [Inclusion of Related Resources](https://api-docs.scholarlysoftware.com/include.md): Including related resources are a great way to make the most efficient use of the Scholarly API
- [Introduction](https://api-docs.scholarlysoftware.com/index.md): This is the introduction to Scholarly API
- [Webhooks](https://api-docs.scholarlysoftware.com/webhooks.md): Webhooks are great for listening and responding to changes within Scholarly

## OpenAPI Specs

- [openapi](https://api-docs.scholarlysoftware.com/openapi.json)