Skip to main content
GET
/
api
/
v1
/
profiles
List profiles
curl --request GET \
  --url https://api.scholarlysoftware.com/api/v1/profiles \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "profile",
      "attributes": {
        "display_name": "<string>",
        "legal_first_name": "<string>",
        "legal_middle_name": "<string>",
        "legal_last_name": "<string>",
        "legal_maiden_name": "<string>",
        "suffix": "<string>",
        "deceased_on": "2023-12-25",
        "racial_identity": "<string>",
        "primary_employee_id": "<string>",
        "employee_ids": "<any>",
        "avatar_url": "<string>",
        "gender_identity": "<string>",
        "custom_fields": "<any>"
      },
      "relationships": {
        "current_department": {
          "data": {
            "type": "department",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "links": {
            "related": "<string>"
          },
          "meta": {}
        },
        "current_primary_appointment": {
          "data": {
            "type": "primary_appointment",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "links": {
            "related": "<string>"
          },
          "meta": {}
        },
        "primary_appointments": {
          "data": [
            {
              "type": "primary_appointment",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "links": {
            "related": "<string>"
          },
          "meta": {}
        },
        "additional_appointments": {
          "data": [
            {
              "type": "secondary_appointment",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "links": {
            "related": "<string>"
          },
          "meta": {}
        },
        "addresses": {
          "links": {
            "related": "<string>"
          },
          "meta": {}
        }
      }
    }
  ]
}

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[display_name]
string
filter[employee_id]
string
filter[employee_ids]
string

Filter profiles by employee IDs for specific configurations.

Accepts nested parameters where the key is the configuration name and value is the employee ID.

Example when your institution has a employee ID configured named "UID":

?filter[employee_ids][UID]=123456
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

profiles found

data
object[]
required
I