List users - Scholarly API Documentation

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>",
        "emails": [
          "[email protected]",
          "[email protected]"
        ]
      },
      "relationships": {
        "profile": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": {
            "type": "profile",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        }
      }
    }
  ]
}

GET

api

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>",
        "emails": [
          "[email protected]",
          "[email protected]"
        ]
      },
      "relationships": {
        "profile": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": {
            "type": "profile",
            "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[display_name]

string

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

users found

data

object[]

required

Show child attributes

data.id

string<uuid>

required

data.type

string

required

Allowed value: "user"

Example:

"user"

data.attributes

object

required

Show child attributes

data.attributes.display_name

string | null

required

data.attributes.emails

string[] | null

The full list of email addresses for the user. 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.relationships

object

Show child attributes

data.relationships.profile

object

Option 1
Option 2
Option 3

Show child attributes

data.relationships.profile.links

object

required

Show child attributes

data.relationships.profile.meta

object

data.relationships.profile.data

object

Show child attributes

data.relationships.profile.data.type

string

required

Allowed value: "profile"

Example:

"profile"

data.relationships.profile.data.id

string<uuid>

required

Update a rank Show a user

⌘I

API reference

Authorizations

Headers

Query Parameters

Response