SPsponsorunited
User Management

List all users

Retrieves a paginated list of users with optional filtering.

post/api/users

Request

Request body

namestring

Filter by user name

roleinteger[]

Filter by role IDs

organizationinteger[]

Filter by organization IDs

contract_statusstring[]

Filter by contract status

external0 | 1

Filter by external status (0 or 1)

active0 | 1

Filter by active status (0 or 1)

order_bystring

Field to order results by

order'asc' | 'desc'

Sort order direction

pageinteger

Page number for pagination

Response

Paginated list of users

current_pageinteger
last_pageinteger
per_pageinteger
totalinteger

Example response

{
  "data": [
    {
      "role_orientation": {
        "id": 1,
        "name": "sell_side",
        "label": "Sell-Side"
      }
    }
  ]
}

Changes

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