# SuiteCRM Module API

**Canonical:** https://apis.io/apis/suitecrm/suitecrm-module-api/  
**Provider:** SuiteCRM — https://apis.io/providers/suitecrm/  
**Documentation:** https://docs.suitecrm.com/developer/integration-api/v8/endpoints

SuiteCRM Module API is one of 9 APIs that [SuiteCRM](https://apis.io/providers/suitecrm/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Module. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

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

## Operations (9)

| Method | Path | Summary |
|---|---|---|
| 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) |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/suitecrm/refs/heads/main/openapi/suitecrm-module-api-openapi.yml
- **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

## Other SuiteCRM APIs (8)

- [SuiteCRM Access Token API](https://apis.io/apis/suitecrm/suitecrm-access-token-api/)
- [SuiteCRM Authorize API](https://apis.io/apis/suitecrm/suitecrm-authorize-api/)
- [SuiteCRM Current User API](https://apis.io/apis/suitecrm/suitecrm-current-user-api/)
- [SuiteCRM Listview API](https://apis.io/apis/suitecrm/suitecrm-listview-api/)
- [SuiteCRM Logout API](https://apis.io/apis/suitecrm/suitecrm-logout-api/)
- [SuiteCRM Meta API](https://apis.io/apis/suitecrm/suitecrm-meta-api/)
- [SuiteCRM Search Defs API](https://apis.io/apis/suitecrm/suitecrm-search-defs-api/)
- [SuiteCRM User Preferences API](https://apis.io/apis/suitecrm/suitecrm-user-preferences-api/)

## Tags

Module

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/suitecrm/suitecrm-module-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/suitecrm/.