SponsorUnited User Management API

openapi: 3.2.0
info:
  title: SponsorUnited User Management API
  version: v1
  description: User Management
tags:
- name: User Management
  description: User Management
paths:
  /api/me:
    get:
      tags:
      - User Management
      summary: Get current user
      description: Retrieves the authenticated user's profile, permissions, access, entities, and settings.
      operationId: 31b0d32acb524c1d5a56453eb860d66d
      responses:
        '200':
          description: Current user profile with permissions, access, entities, and settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserMeResponse'
        '401':
          description: Unauthenticated
      security:
      - bearerAuth: []
  /api/me/access/{entityType}:
    get:
      tags:
      - User Management
      summary: Get user access permissions
      description: Retrieves the authenticated user's access permissions for a specific entity type.
      operationId: ce3191316a8b980d74a4df910febbb5d
      parameters:
      - name: entityType
        in: path
        description: Entity type to get access for (teams, brands, agencies, markets, property-types)
        required: true
        schema:
          type: string
      responses:
        '200':
          description: User access permissions for the entity type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserAccessResource'
        '401':
          description: Unauthenticated
      security:
      - bearerAuth: []
  /api/entities:
    get:
      tags:
      - User Management
      summary: Get user entities
      description: Retrieves the entities (teams, brands, agencies) available to the authenticated user.
      operationId: 13cd6aa88ab21979affb330d56c503b6
      responses:
        '200':
          description: User entities data
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthenticated
      security:
      - bearerAuth: []
  /api/user/{user_id}:
    get:
      tags:
      - User Management
      summary: Get user by ID
      description: Retrieves a specific user by their ID with profile and relationships.
      operationId: a06a40effd210ef49367ada55a928970
      parameters:
      - name: user_id
        in: path
        description: User ID
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: User details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResource'
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden - Not authorized to view this user
        '404':
          description: User not found
      security:
      - bearerAuth: []
  /api/users:
    post:
      tags:
      - User Management
      summary: List all users
      description: Retrieves a paginated list of users with optional filtering.
      operationId: 9428a8001e09068bab0dc2a6fcd34054
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserAllRequest'
      responses:
        '200':
          description: Paginated list of users
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/UserResource'
                  current_page:
                    type: integer
                  last_page:
                    type: integer
                  per_page:
                    type: integer
                  total:
                    type: integer
                type: object
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden - Not authorized to view users
      security:
      - bearerAuth: []
  /api/user:
    post:
      tags:
      - User Management
      summary: Create new user
      description: Creates a new user with the provided information.
      operationId: f180c4943527271251a17160f5602a89
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCreateRequest'
      responses:
        '200':
          description: User created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResource'
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden - Not authorized to create users
        '422':
          description: Validation error
      security:
      - bearerAuth: []
  /api/user/{id}:
    delete:
      tags:
      - User Management
      summary: Delete user
      description: Soft deletes a user and their associated data.
      operationId: 156d66de1b244d16b2daa335a30ffefb
      parameters:
      - name: id
        in: path
        description: User ID
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: User deleted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResource'
        '400':
          description: Cannot delete user
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden - Not authorized to delete users
        '404':
          description: User not found
      security:
      - bearerAuth: []
  /api/user/{id}/representative:
    get:
      tags:
      - User Management
      summary: Get user representative
      description: Retrieves the representative(s) for a user based on their organization.
      operationId: e6764d61307532449b0aedb7c79a4232
      parameters:
      - name: id
        in: path
        description: User ID
        required: true
        schema:
          type: integer
      - name: search_term
        in: query
        description: Filter representatives by name
        required: false
        schema:
          type: string
      responses:
        '200':
          description: List of representatives
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserRepresentativeResource'
        '401':
          description: Unauthenticated
        '404':
          description: User not found
      security:
      - bearerAuth: []
    put:
      tags:
      - User Management
      summary: Update user representative
      description: Updates the representative(s) for a user.
      operationId: 5973cac744f8def9246a667b80d5566f
      parameters:
      - name: id
        in: path
        description: User ID
        required: true
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                representatives:
                  type: array
                  items:
                    properties:
                      id:
                        type: integer
                      is_main:
                        type: boolean
                      representative_type:
                        type: string
                    type: object
              type: object
      responses:
        '200':
          description: Updated representatives
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserRepresentativeResource'
        '401':
          description: Unauthenticated
        '404':
          description: User not found
      security:
      - bearerAuth: []
    delete:
      tags:
      - User Management
      summary: Delete user representative
      description: Removes the user's custom representative, reverting to organization default.
      operationId: 3bc9d96939d74dc51210159ee97cc6f8
      parameters:
      - name: id
        in: path
        description: User ID
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Representative deleted, showing organization default
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserRepresentativeResource'
        '401':
          description: Unauthenticated
        '404':
          description: User not found
        '500':
          description: Internal server error
      security:
      - bearerAuth: []
  /api/user/{id}/profile/phone/check:
    post:
      tags:
      - User Management
      summary: Check phone number validity
      description: Validates a phone number format without sending verification.
      operationId: c1762c95ea1a53b3b14206aadc746dd9
      parameters:
      - name: id
        in: path
        description: User ID
        required: true
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateUserPhoneNumberRequest'
      responses:
        '200':
          description: Phone number validation result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfilePhoneCheckResource'
        '400':
          description: Invalid phone number format
        '401':
          description: Unauthenticated
      security:
      - bearerAuth: []
  /api/user/{id}/profile/email/validate:
    post:
      tags:
      - User Management
      summary: Initiate email validation
      description: Initiates email validation by sending a verification PIN to the new email address.
      operationId: 47409117d1235835a9cabe9cbb7d2c87
      parameters:
      - name: id
        in: path
        description: User ID
        required: true
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateUserEmailRequest'
      responses:
        '200':
          description: Validation initiated, PIN sent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileFieldMfaResource'
        '400':
          description: Validation error
        '401':
          description: Unauthenticated
        '422':
          description: Validation error
      security:
      - bearerAuth: []
  /api/user/{id}/profile/mfa:
    put:
      tags:
      - User Management
      summary: Update MFA preference
      description: Updates the user's multi-factor authentication preference.
      operationId: af2a4d9e2915e62eda3ba1e0ea5f6c86
      parameters:
      - name: id
        in: path
        description: User ID
        required: true
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserUpdateMfaPreferenceRequest'
      responses:
        '200':
          description: MFA preference updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileMfaUpdateResource'
        '401':
          description: Unauthenticated
        '422':
          description: Validation error
      security:
      - bearerAuth: []
  /api/user/{id}/password:
    put:
      tags:
      - User Management
      summary: Change user password
      description: Changes the password for a user. Users can change their own password with current password verification, or admins can change any user's password.
      operationId: 6269f58e997d88ec71e1791e7d03ba33
      parameters:
      - name: id
        in: path
        description: User ID
        required: true
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                password:
                  description: Current password (required for self-change)
                  type: string
                newPasswordGroup:
                  properties:
                    password:
                      description: New password
                      type: string
                    password_confirmation:
                      description: New password confirmation
                      type: string
                  type: object
              type: object
      responses:
        '200':
          description: Password change result
          content:
            application/json:
              schema:
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  refresh_token:
                    type:
                    - string
                    - 'null'
                type: object
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden
      security:
      - bearerAuth: []
  /api/user/{id}/credentials:
    post:
      tags:
      - User Management
      summary: Send user credentials
      description: Generates a new password and sends credentials email to the user.
      operationId: f036656c76cab76ec0c2580a240c6e93
      parameters:
      - name: id
        in: path
        description: User ID
        required: true
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - template
              properties:
                template:
                  description: Email template slug to use
                  type: string
              type: object
      responses:
        '200':
          description: Credentials sent successfully
          content:
            application/json:
              schema:
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                type: object
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden - Not authorized to send credentials
        '404':
          description: User not found
      security:
      - bearerAuth: []
  /api/user/{fromUserId}/dm-reassign:
    post:
      tags:
      - User Management
      summary: Bulk-reassign Deal Manager profiles and contacts
      description: Reassigns every Deal Manager profile and contact owned by the source user to the target user, within a single organization and database transaction. Used before deactivating a user.
      operationId: 10130677567c18866edd30ae2ef900c6
      parameters:
      - name: fromUserId
        in: path
        description: Id of the user whose Deal Manager profiles and contacts are reassigned.
        required: true
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DealManagerReassignRequest'
      responses:
        '200':
          description: Reassignment completed
          content:
            application/json:
              schema:
                properties:
                  profiles_reassigned:
                    type: integer
                    example: 12
                  contacts_reassigned:
                    type: integer
                    example: 34
                type: object
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden - Not authorized to reassign Deal Manager records
        '404':
          description: User not found
        '422':
          description: Validation error - cross-organization or self-target reassignment
      security:
      - bearerAuth: []
  /api/user/{userId}/dm-assignments/count:
    get:
      tags:
      - User Management
      summary: Count a user's Deal Manager assignments
      description: Returns the number of Deal Manager profiles and contacts owned by the user. Used as a cheap precheck before deactivation to decide whether the reassignment modal must be shown.
      operationId: e51f7b0dfba6af8d14d397ede3c8194c
      parameters:
      - name: userId
        in: path
        description: Id of the user whose Deal Manager assignments are counted.
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Assignment counts
          content:
            application/json:
              schema:
                properties:
                  profiles:
                    type: integer
                    example: 12
                  contacts:
                    type: integer
                    example: 34
                type: object
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden - Not authorized to view this user's Deal Manager assignments
        '404':
          description: User not found
      security:
      - bearerAuth: []
  /api/user/{id}/restore:
    post:
      tags:
      - User Management
      summary: Restore deleted user
      description: Restores a soft-deleted user and their associated data.
      operationId: 392df502a617d3cb0bf5ca193553dc86
      parameters:
      - name: id
        in: path
        description: User ID
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: User restored successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResource'
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden - Not authorized to restore users
        '404':
          description: User not found
      security:
      - bearerAuth: []
  /api/users/export:
    get:
      tags:
      - User Management
      summary: Export users
      description: Exports users to a CSV file with optional filtering.
      operationId: aff36670925ec67b69499b1f73c0b112
      parameters:
      - name: active
        in: query
        description: Filter by active status (0 or 1)
        required: false
        schema:
          type: integer
          enum:
          - 0
          - 1
      - name: order_by
        in: query
        description: Field to order by
        required: false
        schema:
          type: string
      - name: order
        in: query
        description: Sort direction
        required: false
        schema:
          type: string
          enum:
          - asc
          - desc
      responses:
        '200':
          description: CSV file download
          content:
            text/csv:
              schema:
                type: string
                format: binary
        '401':
          description: Unauthenticated
      security:
      - bearerAuth: []
  /api/user/{id}/profile/phone/countries:
    get:
      tags:
      - User Management
      summary: Get countries list
      description: Retrieves a list of countries with phone codes for phone number validation.
      operationId: 72e97ad7438e8f4863022a18e1e02f05
      responses:
        '200':
          description: List of countries with phone codes
          content:
            application/json:
              schema:
                type: array
                items:
                  properties:
                    name:
                      type: string
                    code:
                      type: string
                    dial_code:
                      type: string
                  type: object
        '401':
          description: Unauthenticated
      security:
      - bearerAuth: []
  /api/user/{id}/integration/salesforce:
    get:
      tags:
      - User Management
      summary: Get Salesforce integration status
      description: Retrieves the Salesforce integration status and configuration for a user.
      operationId: d619c947f2abd8328e8e10cd75e9e29a
      parameters:
      - name: id
        in: path
        description: User ID
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Salesforce integration status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSalesforceIntegrationResource'
        '401':
          description: Unauthenticated
        '404':
          description: User not found
      security:
      - bearerAuth: []
  /api/users/intercom-sync:
    post:
      tags:
      - User Management
      summary: Sync users to Intercom
      description: Triggers bulk synchronization of users to Intercom. Returns the total number of users queued for sync.
      operationId: 01abe88ed275b660cadbe0464da5d806
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserIntercomSyncRequest'
      responses:
        '202':
          description: Sync job has been queued
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                    example: Users sync to Intercom has been queued
                  total_users:
                    type: integer
                    example: 123
                type: object
        '403':
          description: Forbidden - User does not have permission
      security:
      - bearerAuth: []
  /api/users/intercom-sync-status:
    get:
      tags:
      - User Management
      summary: Get users Intercom sync status
      description: Returns the Intercom sync status for specified users.
      operationId: af628fcb5305272cb6fd1e3ce3ce0af0
      parameters:
      - name: user_ids
        in: query
        description: Array of user IDs to check status for
        required: false
        schema:
          type: array
          items:
            type: integer
      responses:
        '200':
          description: Sync status for users
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/UserSyncStatusResource'
                type: object
        '403':
          description: Forbidden - User does not have permission
      security:
      - bearerAuth: []
  /api/users/for-report-sharing:
    post:
      tags:
      - User Management
      summary: List users for report sharing
      description: 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.
      operationId: forReportSharing
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserForReportSharingRequest'
      responses:
        '200':
          description: Paginated list of users for report sharing
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/UserForReportSharingResource'
                  current_page:
                    type: integer
                    example: 1
                  last_page:
                    type: integer
                    example: 1
                  per_page:
                    type: integer
                    example: 50
                  total:
                    type: integer
                    example: 0
                type: object
        '401':
          description: Unauthenticated
        '403':
          description: Forbidden - Not authorized to view users
        '422':
          description: Validation error
      security:
      - bearerAuth: []
  /api/user/events:
    get:
      tags:
      - User Management
      summary: List user events
      description: Retrieves a paginated list of user events with optional filtering.
      operationId: c0a5bdc0b689d60bb5cdd0d12329a890
      parameters:
      - name: page
        in: query
        description: Page number for pagination
        required: true
        schema:
          type: integer
      - name: per_page
        in: query
        description: Number of items per page
        required: false
        schema:
          type: integer
      - name: status
        in: query
        description: Filter by event status codes (comma-separated)
        required: false
        schema:
          type: string
      - name: user
        in: query
        description: Filter by user IDs (comma-separated)
        required: false
        schema:
          type: string
      - name: scouting_groups
        in: query
        description: Filter by scouting group IDs (comma-separated)
        required: false
        schema:
          type: string
      - name: season
        in: query
        description: Filter by season IDs (comma-separated)
        required: false
        schema:
          type: string
      - name: type
        in: query
        description: Filter by event type codes (comma-separated)
        required: false
        schema:
          type: string
      - name: property_id
        in: query
        description: Filter by property ID
        required: false
        schema:
          type: integer
      - name: property_name
        in: query
        description: Filter by property name
        required: false
        schema:
          type: string
      - name: order_by
        in: query
        description: Field to order results by
        required: false
        schema:
          type: string
      - name: order
        in: query
        description: Sort order (asc or desc)
        required: false
        schema:
          type: string
          enum:
          - asc
          - desc
      responses:
        '200':
          description: Paginated list of user events
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      type: object
                  current_page:
                    type: integer
                  last_page:
                    type: integer
                  per_page:
                    type: integer
                  total:
                    type: integer
                type: object
        '401':
          description: Unauthenticated
        '422':
          description: Validation error
      security:
      - bearerAuth: []
  /api/user/{user_id}/event/{event_id}/team/{team_id}:
    get:
      tags:
      - User Management
      summary: Get single user event
      description: Retrieves a specific user event by user, event, and team IDs.
      operationId: 7bbb03c61b3c5af244d4c639cbaeb45d
      parameters:
      - name: user_id
        in: path
        description: User ID
        required: true
        schema:
          type: integer
      - name: event_id
        in: path
        description: Event ID
        required: true
        schema:
          type: integer
      - name: team_id
        in: path
        description: Team ID
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: User event details
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthenticated
        '404':
          description: User event not found
      security:
      - bearerAuth: []
    post:
      tags:
      - User Management
      summary: Create or update user event
      description: Creates a new user event or updates an existing one.
      operationId: 6307350b8b21cdf4dcac4a4a3955f4b8
      parameters:
      - name: user_id
        in: path
        description: User ID
        required: true
        schema:
          type: integer
      - name: event_id
        in: path
        description: Event ID
        required: true
        schema:
          type: integer
      - name: team_id
        in: path
        description: Team ID
        required: true
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserEventCreateOrUpdateRequest'
      responses:
        '200':
          description: User event created or updated
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Cannot reassign event with audits
        '401':
          description: Unauthenticated
        '422':
          description: Validation error
      security:
      - bearerAuth: []
    delete:
      tags:
      - User Management
      summary: Delete user event
      description: Deletes a user event. Cannot delete events that have audits.
      operationId: b73c3ac932c400bf4c1d7be4ee040237
      parameters:
      - name: user_id
        in: path
        description: User ID
        required: true
        schema:
          type: integer
      - name: event_id
        in: path
        description: Event ID
        required: true
        schema:
          type: integer
      - name: team_id
        in: path
        description: Team ID
        required: true
        schema:
          type: integer
      responses:
        '204':
          description: User event deleted successfully
        '400':
          description: Cannot delete user events with audits
        '401':
          description: Unauthenticated
        '404':
          description: User event not found
      security:
      - bearerAuth: []
  /api/user/events/download:
    get:
      tags:
      - User Management
      summary: Export user events
      description: Exports user events to a CSV file with optional filtering.
      operationId: a97da5668fccb315a5e42734a466026b
      parameters:
      - name: page
        in: query
        description: Page number (required for validation)
        required: true
        schema:
          type: integer
      - name: status
        in: query
        description: Filter by status codes (comma-separated)
        required: false
        schema:
          type: string
      - name: user
        in: query
        description: Filter by user IDs (comma-separated)
        required: false
        schema:
          type: string
      - name: leagues
        in: query
        description: Filter by league IDs (comma-separated)
        required: false
        schema:
          type: string
      responses:
        '200':
          description: CSV file download
          content:
            text/csv:
              schema:
                type: string
                format: binary
        '401':
          description: Unauthenticated
        '422':
          description: Validation error
      security:
      - bearerAuth: []
  /api/user/settings:
    post:
      tags:
      - User Management
      summary: Create user setting
      description: Creates a new user setting with the provided type and payload.
      operationId: 4a09ccf8120071be7948ae3b6dfcc859
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserSettingCreateRequest'
            example:
              type: company_revenue
              payload: '100000000'
      responses:
        '200':
          description: Setting created successfully
          content:
            application/json:
              schema:
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  payload:
         

# --- truncated at 32 KB (64 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sponsorunited/refs/heads/main/openapi/sponsorunited-user-management-api-openapi.yml