Skip to main content
GET
/
api
/
v1
/
admin_assistant_roles
List admin assistant roles
curl --request GET \
  --url https://api.scholarlysoftware.com/api/v1/admin_assistant_roles \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "admin_assistant_role",
      "attributes": {
        "effective_from": "2023-12-25",
        "custom_fields": {},
        "external_id": "AAR-001",
        "effective_to": "2023-12-25"
      },
      "relationships": {
        "admin_assistant": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": {
            "type": "user",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        },
        "faculty_member": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": {
            "type": "user",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        }
      }
    }
  ]
}

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

filter[user_id]
string

Filter by user UUID - returns roles where user is either the admin assistant or faculty member

filter[external_id]
string

Filter by external ID

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

admin assistant roles found

data
object[]
required