SPsponsorunited
User Management

List users for report sharing

Returns a paginated list of users filtered by role orientation, job role, user role, organization, organization type, product, account manager, representative, league, subcategory, genre, subgenre, category, user name, job title, last activity dates, and report received/opened counts and dates. Used to select recipients when sharing custom reports.

post/api/users/for-report-sharing

Request

Request body

role_orientationunknown
user_job_roleunknown
user_roleunknown
organizationunknown
organization_typeunknown
organization_productunknown
organization_account_managerunknown
representativeunknown
leagueunknown
subcategoryunknown
genreunknown
subgenreunknown
categoryunknown
user_namestring

Search by user name (partial match).

job_titlestring

Search by job title (partial match).

last_activity_fromstring date-time

Filter by last activity on or after this date.

last_activity_tostring date-time

Filter by last activity on or before this date.

reports_received_mininteger

Filter by minimum number of reports received.

last_received_date_fromstring date-time

Filter by last received report date on or after this date.

last_received_date_tostring date-time

Filter by last received report date on or before this date.

reports_opened_mininteger

Filter by minimum number of reports opened.

last_opened_date_fromstring date-time

Filter by last opened report date on or after this date.

last_opened_date_tostring date-time

Filter by last opened report date on or before this date.

pageinteger

Page number for pagination

per_pageinteger

Items per page (max 1000)

Response

Paginated list of users for report sharing

current_pageinteger
last_pageinteger
per_pageinteger
totalinteger

Example response

{
  "current_page": 1,
  "last_page": 1,
  "per_page": 50
}

Changes

No recorded changes to this operation across all 2 revisions of this API.