Interfolio Permissions API
Retrieve details of users' permissions.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/interfolio:interfolio-permissions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Interfolio Permissions API
version: 1.0.0
x-logo:
url: /images/logo_faculty180_intf.png
description: 'Operations tagged Permissions across 2 of this provider''s published API definitions: faculty180-swagger.json, interfolio-faculty180-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://faculty180.interfolio.com
tags:
- name: Permissions
description: Retrieve details of users' permissions.
paths:
/api.php/users/permissions:
get:
tags:
- Permissions
summary: Retrieves a listing of users and basic identifying information for each
description: 'Description
Retrieve details on user''s permissions within your institution. A count of user permissions will be returned if no parameters are specified.
Example URL(s)
https://faculty180.interfolio.com/api.php/users/permissions?userlist=m123456,m789123
https://faculty180.interfolio.com/api.php/users/permissions?userlist=m123456,m789123&rights=1'
operationId: facultyPermissions
parameters:
- name: userlist
in: query
description: "Enter user(s) to retrieve permissions information.\n * When defined, limits the bulk GET to the users in the list.\n * When undefined, all faculty and their permissions are listed"
style: form
explode: false
schema:
type: array
items:
type: string
- $ref: '#/components/parameters/rights'
- name: unitid
in: query
description: "Retrieve a user with specific unitid(s).\n * When defined, only returns permissions for selected unitids.\n * When undefined, all units are selected.\n * Multiple values can be sent as a comma separated list."
schema:
type: array
items:
type: integer
- name: data
in: query
description: "Determines the extent of data that will be returned.\n * **Count:** Returns count of number of users with administrative rights.\n * **Summary:** Returns an array of units and rights values for requested user.\n * **Detailed:** Returns an array of values for all users with extra text."
schema:
type: string
enum:
- count
- summary
- detailed
default: count
- $ref: '#/components/parameters/q'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
responses:
'200':
description: A list of users' permissions.
content:
application/json:
example:
- m123456:
pid: '0000001'
rights:
- unitid: 1
rightid: 1
unit: University
level: University
right: Full Admin Rights
- unitid: 2
rightid: 2
unit: College of Business
level: College
right: Report Rights Only
default:
description: an "unexpected" error
post:
tags:
- Permissions
summary: Assigns administrative permissions to users
description: 'Description
Create permissions for a single user.
Example URL(s)
https://faculty180.interfolio.com/api.php/users/permissions'
operationId: createUsersPermissions
responses:
'200':
description: Permission inserted successfully.
'400':
description: "Possible errors include:\n * Required field <field> not provided.\n * Field <field> must be numeric.\n * User <userid> does not exist.\n * Unit <unitid> does not exist.\n * Field rightid must be one of: 1, 2.\n * Permission already assigned to user <userid> for unit <unitid>."
requestBody:
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/permissionsPost'
required: true
servers:
- url: https://faculty180.interfolio.com
/api.php/users/{userid}/permissions:
get:
tags:
- Permissions
summary: Retrieves a listing of users and basic identifying information for each
description: 'Description
Retrieve details on a single user''s permissions within your institution. A count of the user permissions will be returned if no parameters are specified.
Example URL(s)
https://faculty180.interfolio.com/api.php/users/m123456/permissions?data=detailed
https://faculty180.interfolio.com/api.php/users/m123456/permissions?data=detailed&unitid=2'
operationId: getApiPhpUsersByUseridPermissions
parameters:
- name: userid
in: path
description: Retrieves permission details on the specified user.
required: true
schema:
type: string
- $ref: '#/components/parameters/rights'
- name: unitid
in: query
description: "Retrieve a user with specific unitid(s).\n * When defined, only returns permissions for selected unitids.\n * When undefined, all units are selected.\n * Multiple values can be sent as a comma separated list."
schema:
type: array
items:
type: integer
- name: data
in: query
description: "Determines the extent of data that will be returned.\n * **Count:** Returns count of number of administrative rights the user has.\n * **Summary:** Returns an array of units and rights values for requested user.\n * **Detailed:** Returns an array of units and rights values for requested user with extra text"
schema:
type: string
enum:
- count
- summary
- detailed
default: count
- $ref: '#/components/parameters/q'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
responses:
'200':
description: A list of users' permissions.
content:
application/json:
example:
- m123456:
pid: '0000001'
rights:
- unitid: 1
rightid: 1
unit: University
level: University
right: Full Admin Rights
- unitid: 2
rightid: 2
unit: College of Business
level: College
right: Report Rights Only
default:
description: an "unexpected" error
x-operation-id-source: normalized
x-operation-id-original: facultyPermissions
servers:
- url: https://faculty180.interfolio.com
components:
schemas:
permissionsPost:
required:
- userid
- unitid
- rightid
properties:
userid:
type: string
unitid:
type: integer
rightid:
type: integer
type: object
parameters:
q:
name: q
in: query
description: Search term. Use '*' as wildcard.
schema:
type: string
limit:
name: limit
in: query
description: Limit query to specified number of records.
schema:
type: integer
offset:
name: offset
in: query
description: Used to offset queries that are segmented into chunks with limit.
schema:
type: integer
rights:
name: rights
in: query
description: 'Defaults to “1,2” when nothing is sent or the value is invalid.
* When set to “1”, the system will only report users with Full Admin Rights.
* When set to “2”, the system will only report users with Report Rights.
* When set to “1,2” all rights will be returned.'
schema:
type: string
x-refined-from:
- faculty180-swagger.json
- interfolio-faculty180-openapi.yml