Interfolio User Data API

openapi: 3.2.0
info:
  title: Interfolio User Data API
  version: 1.0.0
  x-logo:
    url: /images/logo_faculty180_intf.png
  description: 'Operations tagged User Data 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: User Data
  description: Retrieves a users activity information.
paths:
  /api.php/userdata:
    get:
      tags:
      - User Data
      summary: Retrieves all of the user’s activities with section information
      description: 'Description


        Retrieve details on users within your institution. A list of all user data will be provided unless specified otherwise by parameters.


        Example URL(s)


        https://faculty180.interfolio.com/api.php/userdata?userlist=m123456,m789123


        https://faculty180.interfolio.com/api.php/userdata?userlist=m123456,m789123&category=activity_input'
      operationId: userdata
      parameters:
      - name: unitid
        in: query
        description: "Retrieve a unit with a specific unitid.\n  *  When defined, sections are limited to those found at the specified unit.\n  *  When undefined, all sections are returned."
        schema:
          type: integer
      - name: sectionid
        in: query
        description: "Retrieve a section with a specific sectionid.\n  *  When defined, limits the sections to only the specified section.\n  *  When undefined, all sections are returned."
        schema:
          type: integer
      - name: category
        in: query
        description: "Valid values are profile and activity_input.\n  *  When defined, limits the sections to the specified form.\n  *  When undefined, all sections are returned."
        schema:
          type: string
      - name: category
        in: query
        description: "Valid values are profile and activity_input.\n  *  When defined, limits the sections to the specified form.\n  *  When undefined, all sections are returned."
        schema:
          type: string
      - name: termstart
        in: query
        description: "Value should match the termid of terms.\n  *  When defined, limits activities to the specified starting term.\n  *  When undefined, the furthest back term is used."
        schema:
          type: string
      - name: termfinish
        in: query
        description: "Value should match the termid of terms.\n  *  When defined, limits activities to the specified ending term.\n  *  When undefined, defaults to the current term."
        schema:
          type: string
      - $ref: '#/components/parameters/userlist'
      - $ref: '#/components/parameters/q'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: A list of all sections with field details and associated activity details.
          content:
            application/json:
              example:
              - section:
                  name: Memberships
                  fields:
                  - field_title: Faculty ID
                    field_name: facultyid
                    field_type: text
                  - field_title: Year Started
                    field_name: yearstarted
                    field_type: year
                  - field_title: Year Ended
                    field_name: yearended
                    field_type: year
                  - field_title: Organization Name
                    field_name: organizationname
                    field_type: text
                  section_category: profile
                  section_resource: Membership.inc
                activities:
                - activityid: 32
                  fields:
                    Year Started: 2010
                    Year Ended: 2015
                    Organization Name: International Business Accountants Association
                    Description: An association of international business accountants
                  facultyid: m123456
                  userid: m123456
                  attachments:
                    attachmentid: 1000
                    mimetype: application/msword
                    filename: business.doc
                    filesize: ''
                    downloadurl: ''
        default:
          description: an "unexpected" error
    servers:
    - url: https://faculty180.interfolio.com
components:
  parameters:
    offset:
      name: offset
      in: query
      description: Used to offset queries that are segmented into chunks with limit.
      schema:
        type: integer
    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
    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
x-refined-from:
- faculty180-swagger.json
- interfolio-faculty180-openapi.yml