SuiteCRM

SuiteCRM Module API

The Module API from SuiteCRM — 6 operation(s) for module.

GitHub OpenAPI

Operations 9

PATCH /Api/V8/module Update Record (PATCH) #
POST /Api/V8/module Create Record (POST) #
POST /Api/V8/module/Accounts/{id}/relationships/contacts Link Records (POST) #
GET /Api/V8/module/{moduleName} List Records (GET) #
DELETE /Api/V8/module/{moduleName}/{id} Delete Record (DELETE) #
GET /Api/V8/module/{moduleName}/{id} Fetch Single Record (GET) #
GET /Api/V8/module/{moduleName}/{id}/relationships/{linkFieldName} Get Related Records (GET) #
POST /Api/V8/module/{moduleName}/{id}/relationships/{linkFieldName} Link Records (POST) #
DELETE /Api/V8/module/{moduleName}/{id}/relationships/{linkFieldName}/{relatedBeanId} Unlink Records (DELETE) #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/suitecrm/refs/heads/main/openapi/suitecrm-module-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/suitecrm/refs/heads/main/json-schema/suitecrm-post-api-access-token-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/suitecrm/refs/heads/main/json-schema/suitecrm-post-api-access-token-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/suitecrm/refs/heads/main/json-schema/suitecrm-patch-api-v8-module-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/suitecrm/refs/heads/main/json-schema/suitecrm-post-api-v8-module-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/suitecrm/refs/heads/main/json-schema/suitecrm-post-api-v8-module-accounts-id-relationships-contacts-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/suitecrm/refs/heads/main/json-schema/suitecrm-post-api-v8-module-modulename-id-relationships-linkfieldname-request-schema.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/suitecrm:suitecrm-module-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

suitecrm-module-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: SuiteCRM Module API
  version: '2026-09-22'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-09-22: 19 operation(s) read from 2 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; SuiteCRM has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-09-22'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.suitecrm.com/developer/integration-api/v8/endpoints
  - https://docs.suitecrm.com/developer/integration-api/v8/authentication
tags:
- name: Module
paths:
  /Api/V8/module:
    patch:
      operationId: patch_Api_V8_module
      tags:
      - Module
      summary: Update Record (PATCH)
      x-source: https://docs.suitecrm.com/developer/integration-api/v8/endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchApiV8ModuleRequest'
      responses:
        '200':
          description: Success (status as documented)
    post:
      operationId: post_Api_V8_module
      tags:
      - Module
      summary: Create Record (POST)
      x-source: https://docs.suitecrm.com/developer/integration-api/v8/endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV8ModuleRequest'
      responses:
        '201':
          description: Success (status as documented)
  /Api/V8/module/Accounts/{id}/relationships/contacts:
    post:
      operationId: post_Api_V8_module_Accounts_id_relationships_contacts
      tags:
      - Module
      summary: Link Records (POST)
      x-source: https://docs.suitecrm.com/developer/integration-api/v8/endpoints
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV8ModuleAccountsIdRelationshipsContactsRequest'
      responses:
        '201':
          description: Success (status as documented)
  /Api/V8/module/{moduleName}:
    get:
      operationId: get_Api_V8_module_moduleName
      tags:
      - Module
      summary: List Records (GET)
      x-source: https://docs.suitecrm.com/developer/integration-api/v8/endpoints
      parameters:
      - name: moduleName
        in: path
        required: true
        schema:
          type: string
      - name: fields[Module]
        in: query
        required: false
        schema:
          type: string
        description: Comma-separated list of fields (e.g., fields[Accounts]=name,billing_address_city ).
      - name: page[number]
        in: query
        required: false
        schema:
          type: string
        description: The page index (starts at 1).
      - name: page[size]
        in: query
        required: false
        schema:
          type: string
        description: Number of records per page.
      - name: sort
        in: query
        required: false
        schema:
          type: string
        description: Sort field. Use - for descending (e.g., sort=-date_entered ).
      - name: filter
        in: query
        required: false
        schema:
          type: string
        description: Advanced filtering logic (e.g., filter[name][eq]=Acme ).
      responses:
        '200':
          description: Success (status as documented)
  /Api/V8/module/{moduleName}/{id}:
    delete:
      operationId: delete_Api_V8_module_moduleName_id
      tags:
      - Module
      summary: Delete Record (DELETE)
      x-source: https://docs.suitecrm.com/developer/integration-api/v8/endpoints
      parameters:
      - name: moduleName
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
    get:
      operationId: get_Api_V8_module_moduleName_id
      tags:
      - Module
      summary: Fetch Single Record (GET)
      x-source: https://docs.suitecrm.com/developer/integration-api/v8/endpoints
      parameters:
      - name: moduleName
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
  /Api/V8/module/{moduleName}/{id}/relationships/{linkFieldName}:
    get:
      operationId: get_Api_V8_module_moduleName_id_relationships_linkFieldName
      tags:
      - Module
      summary: Get Related Records (GET)
      x-source: https://docs.suitecrm.com/developer/integration-api/v8/endpoints
      parameters:
      - name: moduleName
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: linkFieldName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
    post:
      operationId: post_Api_V8_module_moduleName_id_relationships_linkFieldName
      tags:
      - Module
      summary: Link Records (POST)
      x-source: https://docs.suitecrm.com/developer/integration-api/v8/endpoints
      parameters:
      - name: moduleName
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: linkFieldName
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV8ModuleModulenameIdRelationshipsLinkfieldnameRequest'
      responses:
        '201':
          description: Success (status as documented)
  /Api/V8/module/{moduleName}/{id}/relationships/{linkFieldName}/{relatedBeanId}:
    delete:
      operationId: delete_Api_V8_module_moduleName_id_relationships_linkFieldName_relatedBeanId
      tags:
      - Module
      summary: Unlink Records (DELETE)
      x-source: https://docs.suitecrm.com/developer/integration-api/v8/endpoints
      parameters:
      - name: moduleName
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: linkFieldName
        in: path
        required: true
        schema:
          type: string
      - name: relatedBeanId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
components:
  schemas:
    PostApiV8ModuleModulenameIdRelationshipsLinkfieldnameRequest:
      type: object
      properties:
        data.type:
          type: string
          description: Related module name (e.g., Contacts).
        data.id:
          type: string
          description: ID of the record to link.
      required:
      - data.type
      - data.id
    PostApiV8ModuleAccountsIdRelationshipsContactsRequest:
      type: object
      properties:
        data.type:
          type: string
          description: Related module name (e.g., Contacts).
        data.id:
          type: string
          description: ID of the record to link.
      required:
      - data.type
      - data.id
    PostApiV8ModuleRequest:
      type: object
      properties:
        data.type:
          type: string
          description: Module name (e.g., Lead).
        data.attributes:
          type: string
          description: Attributes for the new record (e.g., last_name, status).
      required:
      - data.type
      - data.attributes
    PatchApiV8ModuleRequest:
      type: object
      properties:
        data.type:
          type: string
          description: Module name (e.g., Accounts).
        data.id:
          type: string
          description: ID of the record to update.
        data.attributes:
          type: string
          description: Attributes to update (e.g., name).
      required:
      - data.type
      - data.id
      - data.attributes