Skip to main content
GET
/
api
/
v1
/
admin_assistant_roles
/
{id}
Get an admin assistant role
curl --request GET \
  --url https://api.scholarlysoftware.com/api/v1/admin_assistant_roles/{id} \
  --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

Path Parameters

​
id
string
required

Query Parameters

​
include
string

Comma-separated list of relationships to include. Allowed: admin_assistant, faculty_member

Response

admin assistant role found

​
data
object
required