Total Expert

Total Expert User Endpoints API

The User Endpoints API from Total Expert — 9 operation(s) for user endpoints.

GitHub OpenAPI

Operations 14

GET /v1/users/{user_id} Fetch User #
PATCH /v1/users/{user_id} Update User #
GET /v1/users Fetch Users #
POST /v1/users Create Users #
GET /v1/user-roles Fetch User Roles #
GET /v1/user-roles/{user_role_id} Fetch User Role #
GET /v1/role-permissions/{role_id} Fetch Permissions for User Role #
GET /v1/teams/{team_id} Fetch Team #
PATCH /v1/teams/{team_id} Update Team #
DELETE /v1/teams/{team_id} Delete Team #
GET /v1/teams Fetch Teams #
POST /v1/teams Create Team #
GET /v1/permissions Fetch Permissions #
GET /v1/permissions/{permission_id} Fetch Permission #

Documentation

📖
Documentation
https://documenter.getpostman.com/view/1929166/total-expert-public-api/6Z2RYyU

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/total-expert/refs/heads/main/openapi/total-expert-user-endpoints-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/total-expert/refs/heads/main/postman/total-expert-public-api.postman_collection.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/total-expert-user-endpoints-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

total-expert-user-endpoints-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Total Expert Public User Endpoints API
  version: v1
  description: The Total Expert REST API allows you to programmatically create, retrieve, update, and delete information through various endpoints.
  contact:
    url: https://developer.totalexpert.net
servers:
- url: https://public.totalexpert.net
  description: Total Expert external API — production
- url: https://public.vt.totalexpert.net
  description: Total Expert external API — development/sandbox domain (isolated from live data; per the Vendor OAuth Integration Guide)
security:
- oauth2: []
tags:
- name: User Endpoints
paths:
  /v1/users/{user_id}:
    get:
      operationId: fetchUser
      summary: Fetch User
      description: Fetch a specific user by ID.
      tags:
      - User Endpoints
      responses:
        '200':
          description: Success. See the Total Expert Public API documentation for the response shape.
      parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
    patch:
      operationId: updateUser
      summary: Update User
      description: Update a user
      tags:
      - User Endpoints
      responses:
        '200':
          description: Success. See the Total Expert Public API documentation for the response shape.
      parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              info:
                job_title: Manager
              settings_marketing:
                weekly_spend_threshold: '400'
              licenses:
              - license_name: MN
                content: LIC 12345
              remove_licenses:
              - license_name: IA
                content: LIC 54321
              disclaimers:
              - disclaimer_name: Flyer Disclaimer
                content: Subject to change
                type:
                  name: Print Disclaimer
              remove_disclaimers:
              - disclaimer_name: New Customer Email Disclaimer
                content: Subject to change
                type:
                  name: Email Disclaimer
              teams:
              - team_name: Fred's Team
                managers:
                - username: freddy
              remove_teams:
              - team_name: Alice Sunny's Team
                managers:
                - username: alice
  /v1/users:
    get:
      operationId: fetchUsers
      summary: Fetch Users
      description: Fetch a page of users. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.
      tags:
      - User Endpoints
      responses:
        '200':
          description: Success. See the Total Expert Public API documentation for the response shape.
      parameters:
      - name: page[number]
        in: query
        required: false
        schema:
          type: string
        example: '1'
      - name: page[size]
        in: query
        required: false
        schema:
          type: string
        example: '10'
    post:
      operationId: createUsers
      summary: Create Users
      description: 'Create a user.


        Required Attributes:


        email


        type


        Required Relationships:


        info


        role'
      tags:
      - User Endpoints
      responses:
        '200':
          description: Success. See the Total Expert Public API documentation for the response shape.
      requestBody:
        content:
          application/json:
            example:
              email: fred@example.com
              status: 0
              type: Lender
              role:
                role_name: Real Estate Lender
              info:
                job_title: Real Estate Loan Officer
                first_name: Fred
                last_name: Smith
                company: Big Lender
                website: http://biglender.com/freddy
                testimonial_url: http://biglender.com/freddy/testimonials
                phone_cell: 612-100-200
                phone_fax: 612-300-400
                phone_office: 612-500-600
                address: 123 Main St.
                address_2: Suite 1
                city: Eden Prairie
                state: MN
                zip_code: '55346'
                cost_center: '18'
                timezone_name: America/Chicago
                location_id: '1'
              settings_marketing:
                agent_bio: Freddy is a loan officer
                application_url: apply.biglender.com
                disclaimer: Freddy disclaimer text
                icon_one_img_url: https://totalexpert.com/icon1.jpg
                icon_two_img_url: https://totalexpert.com/icon2.jpg
                icon_three_img_url: https://totalexpert.com/icon3.jpg
                logo_img_url: https://totalexpert.com/freddy_logo.jpg
                license_title: Bonafide loan officer
                profile_img_url: https://totalexpert.com/freddy_profile.jpg
                short_name: FreddyS
                social_facebook: freddy.facebook.com
                social_twitter: freddy.twitter.com
                social_google: freddy.google.com
                social_linkedin: freddy.linkedin.com
                daily_spend_threshold: '200'
                user_quote: Changing the world, one close at a time
                weekly_spend_threshold: '800'
                wistia_id: XYZ
              expenditure_approver:
                username: cadence
              licenses:
              - license_name: MN
                content: LIC 12345
              - license_name: IA
                content: LIC 54321
              disclaimers:
              - disclaimer_name: Flyer Disclaimer
                content: Subject to change
                type:
                  name: Print Disclaimer
              - disclaimer_name: New Customer Email Disclaimer
                content: Subject to change
                type:
                  name: Email Disclaimer
              teams:
              - team_name: Alice Sunny Team
                managers:
                - username: alice
              - team_name: Regional Team - West
                managers:
                - username: grant
                - username: dominic
  /v1/user-roles:
    get:
      operationId: fetchUserRoles
      summary: Fetch User Roles
      description: Fetch a page of user roles. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.
      tags:
      - User Endpoints
      responses:
        '200':
          description: Success. See the Total Expert Public API documentation for the response shape.
      parameters:
      - name: page[number]
        in: query
        required: false
        schema:
          type: string
        example: '1'
      - name: page[size]
        in: query
        required: false
        schema:
          type: string
        example: '10'
  /v1/user-roles/{user_role_id}:
    get:
      operationId: fetchUserRole
      summary: Fetch User Role
      description: Fetch a specific user role specified by ID.
      tags:
      - User Endpoints
      responses:
        '200':
          description: Success. See the Total Expert Public API documentation for the response shape.
      parameters:
      - name: user_role_id
        in: path
        required: true
        schema:
          type: string
  /v1/role-permissions/{role_id}:
    get:
      operationId: fetchPermissionsForUserRole
      summary: Fetch Permissions for User Role
      description: ''
      tags:
      - User Endpoints
      responses:
        '200':
          description: Success. See the Total Expert Public API documentation for the response shape.
      parameters:
      - name: role_id
        in: path
        required: true
        schema:
          type: string
  /v1/teams/{team_id}:
    get:
      operationId: fetchTeam
      summary: Fetch Team
      description: Fetch a team by ID.
      tags:
      - User Endpoints
      responses:
        '200':
          description: Success. See the Total Expert Public API documentation for the response shape.
      parameters:
      - name: team_id
        in: path
        required: true
        schema:
          type: string
    patch:
      operationId: updateTeam
      summary: Update Team
      description: Update an existing team by ID.
      tags:
      - User Endpoints
      responses:
        '200':
          description: Success. See the Total Expert Public API documentation for the response shape.
      parameters:
      - name: team_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              remove_managers:
              - username: rickyg
    delete:
      operationId: deleteTeam
      summary: Delete Team
      description: Deletes a team by ID.
      tags:
      - User Endpoints
      responses:
        '200':
          description: Success. See the Total Expert Public API documentation for the response shape.
      parameters:
      - name: team_id
        in: path
        required: true
        schema:
          type: string
  /v1/teams:
    get:
      operationId: fetchTeams
      summary: Fetch Teams
      description: Fetch a page of teams. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.
      tags:
      - User Endpoints
      responses:
        '200':
          description: Success. See the Total Expert Public API documentation for the response shape.
      parameters:
      - name: page[number]
        in: query
        required: false
        schema:
          type: string
        example: '1'
      - name: page[size]
        in: query
        required: false
        schema:
          type: string
        example: '10'
    post:
      operationId: createTeam
      summary: Create Team
      description: 'Create a Team.


        Required Attributes:


        team_name'
      tags:
      - User Endpoints
      responses:
        '200':
          description: Success. See the Total Expert Public API documentation for the response shape.
      requestBody:
        content:
          application/json:
            example:
              team_name: Harry N's Team
              managers:
              - username: harryn
              - username: rickyg
  /v1/permissions:
    get:
      operationId: fetchPermissions
      summary: Fetch Permissions
      description: ''
      tags:
      - User Endpoints
      responses:
        '200':
          description: Success. See the Total Expert Public API documentation for the response shape.
      parameters:
      - name: page[number]
        in: query
        required: false
        schema:
          type: string
        example: '1'
      - name: page[size]
        in: query
        required: false
        schema:
          type: string
        example: '10'
  /v1/permissions/{permission_id}:
    get:
      operationId: fetchPermission
      summary: Fetch Permission
      description: ''
      tags:
      - User Endpoints
      responses:
        '200':
          description: Success. See the Total Expert Public API documentation for the response shape.
      parameters:
      - name: permission_id
        in: path
        required: true
        schema:
          type: string
components:
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0. Obtain a token from POST /v1/token using HTTP Basic (client_id:client_secret base64-encoded) plus a grant_type body. Access tokens are bearer tokens, expires_in 3600.
      flows:
        clientCredentials:
          tokenUrl: https://public.totalexpert.net/v1/token
          scopes:
            crm: Documented example scope (Vendor OAuth Integration Guide authorize example)
            leadInteraction: Lead interaction access (documented in the collection token examples)
            loanInteraction: Loan interaction access (documented in the collection token examples)
            leadSurveyInteraction: Lead survey interaction access (documented example in the Vendor OAuth Integration Guide)
            postLeads: Post leads access (documented example in the Vendor OAuth Integration Guide)
        authorizationCode:
          authorizationUrl: https://public.totalexpert.net/v1/authorize
          tokenUrl: https://public.totalexpert.net/v1/token
          refreshUrl: https://public.totalexpert.net/v1/token
          scopes:
            crm: Documented example scope (Vendor OAuth Integration Guide authorize example)
            leadInteraction: Lead interaction access (documented in the collection token examples)
            loanInteraction: Loan interaction access (documented in the collection token examples)
            leadSurveyInteraction: Lead survey interaction access (documented example in the Vendor OAuth Integration Guide)
            postLeads: Post leads access (documented example in the Vendor OAuth Integration Guide)
externalDocs:
  description: Total Expert Public API documentation (Postman)
  url: https://documenter.getpostman.com/view/1929166/total-expert-public-api/6Z2RYyU