Skip to main content
GET
/
api
/
v1
/
users
List users
curl --request GET \
  --url https://api.scholarlysoftware.com/api/v1/users \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "user",
      "attributes": {
        "display_name": "<string>",
        "custom_fields": {},
        "emails": [
          "primary@example.com",
          "secondary@example.com"
        ]
      },
      "relationships": {
        "profile": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": {
            "type": "profile",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        },
        "employments": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": [
            {
              "type": "employment",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "current_employment": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": {
            "type": "employment",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        },
        "admin_assistant_roles": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": [
            {
              "type": "admin_assistant_role",
              "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[email]
string
​
filter[display_name]
string
​
filter[display_name.neq]
string
​
filter[display_name.cont]
string

Case-insensitive substring match

​
filter[display_name.in]
string

Comma-separated list

​
filter[display_name.nin]
string

Comma-separated list

​
filter[custom_fields.*]
string

Filter by custom field values. Use the format filter[custom_fields.{field_name}] or filter[custom_fields.{field_name}.{operator}].

Available operators depend on field type:

  • String: eq, neq, in, nin, cont
  • Integer/Decimal: eq, neq, lt, lte, gt, gte, in, nin
  • Date/Moment: eq, neq, lt, lte, gt, gte
  • Academic Year: eq, neq, in, nin
  • Boolean: eq
  • Relationship: eq, in

Examples:

  • filter[custom_fields.department_code]=ENG (equality)
  • filter[custom_fields.employee_number.gte]=100 (greater than or equal)
  • filter[custom_fields.status.in]=active,pending (in list)
​
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

users found

​
data
object[]
required