Interfolio Activities API

Retrieve details of Activities.

Business capability
Educator Workforce Management BC-4760

Operations 5

GET /api.php/activities Retrieves faculty activity ID's in sections #
GET /api.php/activities/{sectionid} Retrieves activities for a specified section #
GET /api.php/activities_details/{sectionid} Retrieves activities details for a specified section #
GET /api.php/activities/{sectionid}/{activityid} Retrieves details for a given activity #
GET /api.php/activities/{sectionid}/{activityid}/attachments Retrieves details for a given activity attachment(s) #

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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/interfolio:interfolio-activities-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

interfolio-activities-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Interfolio Activities API
  version: 1.0.0
  x-logo:
    url: /images/logo_faculty180_intf.png
  description: 'Operations tagged Activities 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: Activities
  description: Retrieve details of Activities.
paths:
  /api.php/activities:
    get:
      tags:
      - Activities
      summary: Retrieves faculty activity ID's in sections
      description: 'Description


        Retrieve activity ID''s from the ''Activities'' section within Faculty180. A count of activities will be returned if no parameters are specified.


        Example URL(s)


        https://faculty180.interfolio.com/api.php/activities


        https://faculty180.interfolio.com/api.php/activities?sectionid=5&data=summary'
      operationId: activities
      parameters:
      - name: unitid
        in: query
        description: "Retrieve details of a unit with unitid\n  *  When defined, activities are limited to users whose primary unit matches the specified unit. \n  *  When undefined, all activities are returned."
        schema:
          type: integer
      - name: sectionid
        in: query
        description: "Retrieve activities within the provided sections\n  *  When defined, limits the activities to only the specified section(s).\n  *  When undefined, all sections are returned."
        schema:
          type: array
          items:
            type: integer
      - name: verbose
        in: query
        description: "Can be used in conjunction with data=detailed to provide full activity details.\n  *  When defined, and the value is 1 and data=detailed then the full activity details are provided.\n  *  When defined, and the value is 0 and data=detailed then the the activity ids are provided.\n  *  When undefined, and data=detailed then the the activity ids are provided."
        schema:
          type: integer
      - $ref: '#/components/parameters/userlist'
      - name: activityclassificationfilter
        in: query
        description: "Multiple values can be sent as a comma separated list.\n  *  When multiple items are specified, queries are constructed using AND.\n  *  When defined, activities are filtered to those with the specified choice for the specified activity classification.   \n  *  When undefined, activities are not filtered by activity classifications.\n  *  The  activityclassificationidid and activityclassificationchoicevalue are returned by the Activity Classification Details resource in “detailed” output."
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - $ref: '#/components/parameters/termstart'
      - $ref: '#/components/parameters/termfinish'
      - name: includeJournalMetrics
        in: query
        description: "Includes Journal Metrics when data=detailed.\n\nAllowed values are:\n     *  1 - Show\n     *  0 - (default) Do not show "
        schema:
          type: integer
      - name: showHidden
        in: query
        description: "Tells the API whether it should respect the 'Publicly Displayed' activity classification in the activity data set that is output.\n\nAllowed values are: \n  *  1 - The 'Publicly Displayed' activity classification is ignored and those activities that a faculty member requested hidden ARE shown, or \n  *  0 (default) -  The 'Publicly Displayed' activity classification is honored and those activities that a faculty member requested hidden ARE NOT shown"
        schema:
          type: integer
      - name: data
        in: query
        description: "Determines the extent of data that will be returned.\n  *  **Count:** Returns count of all activities found. \n  *  **Summary:** Returns an array of sections and counts of activities within that section.\n  *  **Detailed:** Returns an array of sections and a subarray of activityids for each section."
        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 Activities
          content:
            application/json:
              example:
              - <sectionid:integer>:
                - <activityid:string>
                '-15':
                - m123456
                '5':
                - 250
        default:
          description: an "unexpected" error
    servers:
    - url: https://faculty180.interfolio.com
  /api.php/activities/{sectionid}:
    get:
      tags:
      - Activities
      summary: Retrieves activities for a specified section
      description: 'Description


        Retrieve activity details from the ''Activities'' section within Faculty180. Specifying a section will return data for that section. A count of activities will be returned if no parameters are specified.


        Example URL(s)


        https://faculty180.interfolio.com/api.php/activities/5


        https://faculty180.interfolio.com/api.php/activities/5?data=detailed&activityclassificationfilter=-2,12'
      operationId: activitiesdetails
      parameters:
      - name: sectionid
        in: path
        description: Retrieve activities within a sectionid
        required: true
        schema:
          type: integer
      - name: unitid
        in: query
        description: "Retrieve activities within a unit\n  *  When defined, activities are limited to users whose primary unit matches th specified unit.\n  *  When undefined, all activities are returned."
        schema:
          type: integer
      - $ref: '#/components/parameters/userlist'
      - name: activityclassificationfilter
        in: query
        description: "Multiple values can be sent as a comma separated list.\n  *  When multiple items are specified, queries are constructed using AND.\n  *  When defined, activities are filtered to those with the specified choice for the specified activity classification. \n  *  When undefined, activities are not filtered by activity classifications.\n  *  The activityclassificationidid and activityclassificationchoicevalue are returned by the Activity Classification Details resource in 'detailed' output."
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: activityclassificationpull
        in: query
        description: "Multiple values can be sent as a comma separated list.\n  *  When defined, returned data includes activity classification values for the specified activity classifications.\n  *  When undefined, no activity classification data is included."
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
      - $ref: '#/components/parameters/termstart'
      - $ref: '#/components/parameters/termfinish'
      - name: type
        in: query
        description: "Value should match the exact name of a Scholarly Activity and Creative Productions sub-type\n  *  When defined, limits activities matched to the specified scholarly activity sub-type\n  *  (Note this parameter ONLY applies to records retrieved from sectionid=-21 (i.e. 'Scholarly Activities and Creative Productions').  It is ignored for activities pulled from any other section."
        schema:
          type: string
      - name: showHidden
        in: query
        description: "Tells the API whether it should respect the 'Publicly Displayed' activity classification in the activity data set that is output.\n\nAllowed values are: \n  *  1 - The 'Publicly Displayed' activity classification is ignored and those activities that a faculty member requested hidden ARE shown, or \n  *  0 (default) -  The 'Publicly Displayed' activity classification is honored and those activities that a faculty member requested hidden ARE NOT shown"
        schema:
          type: integer
      - name: data
        in: query
        description: "Determines the extent of data that will be returned.\n  *  **Count:** Returns count of all activities found for the specified section. \n  *  **Summary:** Returns an array of activityids within the specified section.\n  *  **Detailed:** Returns an array of activity details for the specified section."
        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 activities within a section
          content:
            application/json:
              example:
              - <sectionid:integer>:
                  activityid: 5
                  fields:
                    Start Term: 2012/01
                    Organization Name: Toys for Tots
                    Local Counties Serving: Adair, Menifee, Lexington
                    Role of Title: Packer
                    Number of Hours: '4'
                    Description: Participant in local community service
                  facultyid: m123456
                  userid: m123456
        default:
          description: an "unexpected" error
    servers:
    - url: https://faculty180.interfolio.com
  /api.php/activities_details/{sectionid}:
    get:
      tags:
      - Activities
      summary: Retrieves activities details for a specified section
      description: 'Description


        Retrieve activity details from the ''Activities'' section within Faculty180. Specifying a section will return data for that section. This section includes a few important details, last_updated & date_created will return date details of when the activity was created and last updated. This endpoint will also return the ''Origin'' of Scholarly Works (ex. Web of Science, BibTeX, Manual, etc.) A count of activities will be returned if no parameters are specified.


        Example URL(s)


        https://faculty180.interfolio.com/api.php/activities_details/-21


        https://faculty180.interfolio.com/api.php/activities_details/-21?data=detailed&activityclassificationpull=-2,12'
      operationId: activitiesdetailsandsection
      parameters:
      - name: sectionid
        in: path
        description: Retrieve activities details within a sectionid
        required: true
        schema:
          type: integer
      - name: unitid
        in: query
        description: "Retrieve activities details within a unit\n  *  When defined, activities are limited to users whose primary unit matches the specified unit.\n  *  When undefined, all activities are returned."
        schema:
          type: integer
      - $ref: '#/components/parameters/userlist'
      - name: activityclassificationfilter
        in: query
        description: "Multiple values can be sent as a comma separated list.\n  *  When multiple items are specified, queries are constructed using AND.\n  *  When defined, activities are filtered to those with the specified choice for the specified activity classification. \n  *  When undefined, activities are not filtered by activity classifications.\n  *  The activityclassificationidid and activityclassificationchoicevalue are returned by the Activity Classification Details resource in 'detailed' output."
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: activityclassificationpull
        in: query
        description: "Multiple values can be sent as a comma separated list.\n  *  When defined, returned data includes activity classification values for the specified activity classifications.\n  *  When undefined, no activity classification data is included."
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
      - $ref: '#/components/parameters/termstart'
      - $ref: '#/components/parameters/termfinish'
      - name: showHidden
        in: query
        description: "Tells the API whether it should respect the 'Publicly Displayed' activity classification in the activity data set that is output.\n\nAllowed values are: \n  *  1 - The 'Publicly Displayed' activity classification is ignored and those activities that a faculty member requested hidden ARE shown, or \n  *  0 (default) -  The 'Publicly Displayed' activity classification is honored and those activities that a faculty member requested hidden ARE NOT shown"
        schema:
          type: integer
      - name: page
        in: query
        description: Combines with the limit parameter and used to pull a given page of activities.
        schema:
          type: integer
      - name: last_updated
        in: query
        description: "Determines the exact date of when an activity was last updated.\n  *  Accepted format is YYYY-MM-DD \n  *  When provided,the returned activities are limited to those modified on the provided date"
        schema:
          type: string
      - $ref: '#/components/parameters/q'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: A list of activities within a section
          content:
            application/json:
              example:
              - limit: 25000
                page: 1
                total_count: 2148
                results:
                  '-21':
                    activityid: 3502
                    date_created: '2018-01-17 01:05:45'
                    last_updated: '2018-01-17 01:05:45'
                    fields:
                      Type: Journal Publication
                      Title: A Conceptual Framework and Model for Design of End-user Information Systems Curricula
                      Journal: IRMA International
                      Month / Season: Summer
                      Year: 2012
                      Volume: '1'
                      Number: '1'
                      Pages: '10'
                      Description: This paper's objective is to create a better understanding of the need for developing an IT environment in Organizational &amp; End-user Information Systems' (OEIS) programs of study wherein hard skills are paired with soft skills, where qualitative research has as much intrinsic value as quantitative research, and where creative thinking and critical thinking is encouraged. To this end, the coauthors have developed the Management, Technology, and Communication (MTC) Model for Training Knowledge Workers in a Digital Economy. This model complements and reinforces the essential objectives and competencies housed in the Organizational Systems Research Association's newly designed 2004 OEIS Model Curriculum.
                      URL: http://www.faculty180.com
                      Origin: Web of Science
                    facultyid: m123456
                    coauthors:
                      '289':
                        firstname: John
                        middleinitial: L
                        lastname: Doe
                        percentcontribution: 100
                        sameschoolflag: 1
                        facultyid: m123456
                        authorid: 289
                        scholarlyactivityid: 3505
                    status:
                    - id: 3505
                      status: In Progress
                      term: Summer
                      year: 2012
                      termid: 2012/02
                      listingorder: 1
                      completionorder: 1
                    userid: m123456
        default:
          description: an "unexpected" error
    servers:
    - url: https://faculty180.interfolio.com
  /api.php/activities/{sectionid}/{activityid}:
    get:
      tags:
      - Activities
      summary: Retrieves details for a given activity
      description: 'Description


        Retrieve a single activity and its details. A count of the activity will be returned if no parameters are specified.


        Example URL(s)


        https://faculty180.interfolio.com/api.php/activities/5/25


        https://faculty180.interfolio.com/api.php/activities/5/25?data=detailed&activityclassificationpull=-2,12'
      operationId: activitiessectionidactivityid
      parameters:
      - name: sectionid
        in: path
        description: Retrieve an activity within a sectionid
        required: true
        schema:
          type: integer
      - name: activityid
        in: path
        description: Retrieve an activity with an activityid
        required: true
        schema:
          type: integer
      - name: activityclassificationpull
        in: query
        description: "Multiple values can be sent as a comma separated list.\n  *  The integer that is sent should be activityclassificationidid as returned by the Activity Classification resources.\n  *  When defined, returned data includes activity classification values for the specified activity classifications.\n  *  When undefined, no activity classification data is included."
        schema:
          type: integer
      - name: data
        in: query
        description: "Determines the extent of data that will be returned.\n  *  **Count:** Returns value of 1 if desired resource exists or 0 otherwise. \n  *  **Summary:** Returns the same data as 'detailed'.\n  *  **Detailed:** Returns an array of activity details for the specified activity."
        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 specified activity
          content:
            application/json:
              example:
              - activityid: 25
                facultyid: m123456
                userid: m123456
                Year Started: 2004
                Year Ended: 2005
                Organization Name: International Business Accountants Association
        default:
          description: an "unexpected" error
    servers:
    - url: https://faculty180.interfolio.com
  /api.php/activities/{sectionid}/{activityid}/attachments:
    get:
      tags:
      - Activities
      summary: Retrieves details for a given activity attachment(s)
      description: 'Description


        Retrieve attachments within a single activity. A count of attachments will be returned if no parameters are specified.


        Example URL(s)


        https://faculty180.interfolio.com/api.php/activities/5/25


        https://faculty180.interfolio.com/api.php/activities/5/25?data=detailed'
      operationId: activityattachments
      parameters:
      - name: sectionid
        in: path
        description: Retrieve an activity within a sectionid
        required: true
        schema:
          type: integer
      - name: activityid
        in: path
        description: Retrieve an activity with an activityid
        required: true
        schema:
          type: integer
      - name: data
        in: query
        description: "Determines the extent of data that will be returned.\n  *  **Count:** Returns an integer representing the number of attachments associated with this activity. \n  *  **Summary:** Returns an array of attachment filenames and attachment IDs.\n  *  **Detailed:** Returns an array of details for the specified activity's attachments."
        schema:
          type: string
          enum:
          - count
          - summary
          - detailed
          default: count
      - $ref: '#/components/parameters/q'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Attachment(s) linked to an activity
          content:
            application/json:
              example:
              - attachmentid: 100
                mimetype: application/vnd.openxmlformats-officedocument.wordprocessingml.document
                filename: Primary Production.docx
                filesize: 54298
                downloadurl: faculty180.interfolio.com/public/download.php?key=...
        default:
          description: an "unexpected" error
    servers:
    - url: https://faculty180.interfolio.com
components:
  parameters:
    userlist:
      name: userlist
      in: query
      description: 'Multiple values can be sent as a comma separated list.

        *  Values should match the userid of users.

        *  When defined, filter returned data to the specified users.

        *  When undefined, all users are returned.'
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    termstart:
      name: termstart
      in: query
      description: 'Value should match the termid of terms.

        *  When defined, limits classification data to the specified starting term.

        *  When undefined, defaults to the current term.'
      schema:
        type: string
    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
    termfinish:
      name: termfinish
      in: query
      description: 'Value should match the termid of terms.

        *  When defined, limits classification data to the specified ending term.

        *  When undefined, defaults to the current term.'
      schema:
        type: string
x-refined-from:
- faculty180-swagger.json
- interfolio-faculty180-openapi.yml