Skip to main content
GET
/
api
/
v1
/
faculty_activity_configurations
List faculty activity configurations
curl --request GET \
  --url https://api.scholarlysoftware.com/api/v1/faculty_activity_configurations \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "faculty_activity_configuration",
      "attributes": {
        "created_at": "<string>",
        "updated_at": "<string>",
        "start_date_property": "<string>",
        "end_date_property": "<string>",
        "singular_title": "<string>",
        "plural_title": "<string>",
        "key": "<string>",
        "properties": [
          {
            "key": "<string>",
            "label": "<string>",
            "type": "string",
            "choices": [
              "<string>"
            ],
            "allow_multiple": true
          }
        ]
      },
      "relationships": {}
    }
  ],
  "meta": {
    "page": {
      "size": 123
    },
    "total": 123
  },
  "links": {
    "self": "<string>",
    "first": "<string>",
    "next": "<string>",
    "prev": "<string>",
    "last": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Authorization
string
required

Bearer token

Query Parameters

sort
string

Sort order. Prefix with - for descending. Allowed: created_at, updated_at

filter[key]
string

Filter results. Available filters: singular_title, singular_title.neq, singular_title.cont (case-insensitive substring match), singular_title.in (comma-separated list), singular_title.nin (comma-separated list), plural_title, plural_title.neq, plural_title.cont (case-insensitive substring match), plural_title.in (comma-separated list), plural_title.nin (comma-separated list), key, key.neq, key.cont (case-insensitive substring match), key.in (comma-separated list), key.nin (comma-separated list), configuration_properties.

page[size]
integer

Number of items per page (max 100)

page[after]
string

Cursor for next page

page[before]
string

Cursor for previous page

Response

faculty activity configurations found

data
object[]
required
meta
object