Total Expert

Total Expert Entities API

The Entities API from Total Expert — 3 operation(s) for entities.

Documentation GitHub OpenAPI

Operations 6

GET /v1/entities/{entity_id} Fetch Entity #

PATCH /v1/entities/{entity_id} Update Entity #

DELETE /v1/entities/{entity_id} Delete Entity #

GET /v1/entities Fetch Entities #

POST /v1/entities Create Entity (as Admin) #

GET /v1/entity-relationship-types Fetch Entity Relationship Types #

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-entities-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

openapi: 3.2.0
info:
  title: Total Expert Public Entities 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: Entities
paths:
  /v1/entities/{entity_id}:
    get:
      operationId: fetchEntity
      summary: Fetch Entity
      description: Fetch a specific entity specified by ID.
      tags:
      - Entities
      responses:
        '200':
          description: Success. See the Total Expert Public API documentation for the response shape.
      parameters:
      - name: entity_id
        in: path
        required: true
        schema:
          type: string
    patch:
      operationId: updateEntity
      summary: Update Entity
      description: Update an existing entity by ID.
      tags:
      - Entities
      responses:
        '200':
          description: Success. See the Total Expert Public API documentation for the response shape.
      parameters:
      - name: entity_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              phone: '5558675309'
    delete:
      operationId: deleteEntity
      summary: Delete Entity
      description: Delete an entity by ID.
      tags:
      - Entities
      responses:
        '200':
          description: Success. See the Total Expert Public API documentation for the response shape.
      parameters:
      - name: entity_id
        in: path
        required: true
        schema:
          type: string
  /v1/entities:
    get:
      operationId: fetchEntities
      summary: Fetch Entities
      description: Fetch a page of entities. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.
      tags:
      - Entities
      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: createEntityAsAdmin
      summary: Create Entity (as Admin)
      description: Create an entity.
      tags:
      - Entities
      responses:
        '200':
          description: Success. See the Total Expert Public API documentation for the response shape.
      requestBody:
        content:
          application/json:
            example:
              entity_name: Squiggle Whomp Household
              entity_type:
                system_name: household
              related_entities:
              - relationship_type:
                  system_name: members
                children:
                - external_id: abcd1234
              custom:
              - field_name: gold_star_string
                value: value
  /v1/entity-relationship-types:
    get:
      operationId: fetchEntityRelationshipTypes
      summary: Fetch Entity Relationship Types
      description: Fetch a page of entities. Specify page size and page number via the '?page[size]' and '?page[number]' GET parameters.
      tags:
      - Entities
      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'
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