List profiles - Scholarly API Documentation

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>",
        "birthdate": "2023-12-25",
        "deceased_on": "2023-12-25",
        "racial_identity": "<string>",
        "primary_employee_id": "<string>",
        "employee_ids": {},
        "emails": [
          "[email protected]",
          "[email protected]"
        ],
        "avatar_url": "<string>",
        "gender_identity": "<string>",
        "custom_fields": {}
      },
      "relationships": {
        "current_department": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": {
            "type": "department",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        },
        "current_primary_appointment": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": {
            "type": "primary_appointment",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        },
        "primary_appointments": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": [
            {
              "type": "primary_appointment",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "additional_appointments": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": [
            {
              "type": "secondary_appointment",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "addresses": {
          "links": {
            "related": "<string>"
          },
          "meta": {}
        },
        "user": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": {
            "type": "user",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        }
      }
    }
  ]
}

GET

api

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>",
        "birthdate": "2023-12-25",
        "deceased_on": "2023-12-25",
        "racial_identity": "<string>",
        "primary_employee_id": "<string>",
        "employee_ids": {},
        "emails": [
          "[email protected]",
          "[email protected]"
        ],
        "avatar_url": "<string>",
        "gender_identity": "<string>",
        "custom_fields": {}
      },
      "relationships": {
        "current_department": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": {
            "type": "department",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        },
        "current_primary_appointment": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": {
            "type": "primary_appointment",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        },
        "primary_appointments": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": [
            {
              "type": "primary_appointment",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "additional_appointments": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": [
            {
              "type": "secondary_appointment",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "addresses": {
          "links": {
            "related": "<string>"
          },
          "meta": {}
        },
        "user": {
          "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[legal_first_name]

string

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

filter[email]

string

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

Show child attributes

data.id

string<uuid>

required

data.type

string

required

Allowed value: "profile"

Example:

"profile"

data.attributes

object

required

Show child attributes

data.attributes.display_name

string | null

required

data.attributes.legal_first_name

string | null

data.attributes.legal_middle_name

string | null

data.attributes.legal_last_name

string | null

data.attributes.legal_maiden_name

string | null

data.attributes.suffix

string | null

data.attributes.birthdate

string<date> | null

data.attributes.deceased_on

string<date> | null

data.attributes.racial_identity

string | null

data.attributes.primary_employee_id

string | null

data.attributes.employee_ids

object

data.attributes.emails

string[] | null

The full list of email addresses for the profile. The first address in the array is the primary email address.

Some special notes about setting emails in Sandboxes:

Emails must be globally unique across all Scholarly accounts, including sandboxes. By default, users created in sandboxes will not have emails copied over from the production account.
Sandbox accounts will still send emails! Scholarly recommends setting sandbox user emails to addresses you control to avoid sending emails to unintended recipients. Example: [email protected] becomes [email protected]

Example:

[
  "[email protected]",
  "[email protected]"
]

data.attributes.avatar_url

string | null

data.attributes.gender_identity

string | null

data.attributes.custom_fields

object

data.relationships

object

Show child attributes

data.relationships.current_department

object

Option 1
Option 2
Option 3

Show child attributes

data.relationships.current_department.links

object

required

Show child attributes

data.relationships.current_department.meta

object

data.relationships.current_department.data

object

Show child attributes

data.relationships.current_department.data.type

string

required

Allowed value: "department"

Example:

"department"

data.relationships.current_department.data.id

string<uuid>

required

data.relationships.current_primary_appointment

object

Option 1
Option 2
Option 3

Show child attributes

data.relationships.current_primary_appointment.links

object

required

Show child attributes

data.relationships.current_primary_appointment.meta

object

data.relationships.current_primary_appointment.data

object

Show child attributes

data.relationships.current_primary_appointment.data.type

string

required

Allowed value: "primary_appointment"

Example:

"primary_appointment"

data.relationships.current_primary_appointment.data.id

string<uuid>

required

data.relationships.primary_appointments

object

Option 1
Option 2
Option 3

Show child attributes

data.relationships.primary_appointments.links

object

required

Show child attributes

data.relationships.primary_appointments.meta

object

data.relationships.primary_appointments.data

object[]

Show child attributes

data.relationships.primary_appointments.data.type

string

required

Allowed value: "primary_appointment"

Example:

"primary_appointment"

data.relationships.primary_appointments.data.id

string<uuid>

required

data.relationships.additional_appointments

object

Option 1
Option 2
Option 3

Show child attributes

data.relationships.additional_appointments.links

object

required

Show child attributes

data.relationships.additional_appointments.meta

object

data.relationships.additional_appointments.data

object[]

Show child attributes

data.relationships.additional_appointments.data.type

string

required

Allowed value: "secondary_appointment"

Example:

"secondary_appointment"

data.relationships.additional_appointments.data.id

string<uuid>

required

data.relationships.addresses

object

Option 1
Option 2

Show child attributes

data.relationships.addresses.links

object

required

Show child attributes

data.relationships.addresses.meta

object

data.relationships.user

object

Option 1
Option 2
Option 3

Show child attributes

data.relationships.user.links

object

required

Show child attributes

data.relationships.user.meta

object

data.relationships.user.data

object

Show child attributes

data.relationships.user.data.type

string

required

Allowed value: "user"

Example:

"user"

data.relationships.user.data.id

string<uuid>

required

Upload profile avatar Create a profile

⌘I

API reference

Authorizations

Headers

Query Parameters

Response