# Perfex CRM REST API Guide

> Official reference for the REST API for Perfex CRM (v3.1.0), a commercial Perfex CRM module by Themesic Interactive. 146 documented endpoints across 31 sections, plus an MCP server, outgoing webhooks and batch operations for AI agents and automation platforms.

The module is installed into a self-hosted Perfex CRM, so the base URL is the customer's own domain - `https://your-crm.com/api/`. There is no shared or vendor-hosted endpoint and no account to create here: each installation runs its own copy. This site documents what that installation exposes.

Every endpoint page has a plain-markdown twin. Append `.md` to any endpoint URL to get the same content as clean text - no layout, no navigation - which is usually the cheapest thing to read:

```
https://perfexcrm.themesic.com/apiguide/customers/get-customer/     HTML
https://perfexcrm.themesic.com/apiguide/customers/get-customer.md   markdown
```

## Authentication

Every request requires an `authtoken` HTTP header. Tokens are created in the Perfex admin area under Setup > API > API Management, and are scoped by per-feature permissions (get, create, update, delete). Custom database tables are scoped individually, read and write per table, so a token can be granted one table without being granted the rest. A request outside a token's grants is refused with 403 rather than partially applied.

Example:

```
curl -X GET "https://your-crm.com/api/customers" -H "authtoken: YOUR_API_TOKEN"
```

## Machine-readable resources

- [OpenAPI 3.0.3 specification](https://raw.githubusercontent.com/themesic/perfex-rest-api-examples/main/openapi/perfex-rest-api.openapi.json): the full contract - paths, parameters, request bodies field by field, and responses. Generated from the same source as this guide. Import it into any OpenAPI client, or point a code generator at it.
- [Postman collection](https://raw.githubusercontent.com/themesic/perfex-rest-api-examples/main/postman/perfex-rest-api.postman_collection.json): every operation as a ready-to-send request, generated from the specification above.
- [Postman environment](https://raw.githubusercontent.com/themesic/perfex-rest-api-examples/main/postman/perfex-rest-api.postman_environment.json): the matching variables - fill in your own base URL and token.
- [Code examples](https://github.com/themesic/perfex-rest-api-examples): runnable requests in cURL, PHP, Python and JavaScript, covering authentication, pagination, filtering and error handling.
- [n8n community node](https://github.com/themesic/n8n-nodes-perfex-crm): the official node for n8n, published to npm as `@themesic/n8n-nodes-perfex-crm`, with webhook and polling triggers and AI-agent support.
- [MCP server](https://perfexcrm.themesic.com/apiguide/mcp/mcp-server/): Model Context Protocol over Streamable HTTP, exposing the CRM as permission-filtered tools to Claude, ChatGPT, Cursor, n8n and any other MCP client. Disabled by default; enabled under Setup > API > Settings.

## MCP

- [POST /api/mcp](https://perfexcrm.themesic.com/apiguide/mcp/mcp-server/): Model Context Protocol server over Streamable HTTP (JSON-RPC 2.0). Exposes 148 permission-filtered CRM tools (list/get/search/create/update/delete across 22 resources, plus lookups and utilities) to Claude Desktop, ChatGPT, Cursor, n8n AI Agent and any MCP client. Supported methods: initialize, ping, tools/list (single page), tools/call. Batches and notifications follow the JSON-RPC spec. Tool errors are returned as isError results so agents can react. Disabled by default - enable it under Setup > API > Settings. Configure your MCP client with this URL and the authtoken header.

## Automation

- [GET /api/zapier/{method}/{resource}](https://perfexcrm.themesic.com/apiguide/automation/zapier-route-handler/): This is a routing method that maps to specific Zapier endpoints. Use the direct endpoints (poll_get, test_get, resources_get) instead.
- [GET /api/zapier/poll/{resource}](https://perfexcrm.themesic.com/apiguide/automation/poll-data/): Polling endpoint used by automation platforms (Zapier, Make.com, n8n) to retrieve new or updated records. Returns records that were created or modified after the specified timestamp.
- [GET /api/zapier/resources](https://perfexcrm.themesic.com/apiguide/automation/list-resources/): Returns a list of all available resources that can be used for polling and testing. This endpoint is used by automation platforms to discover available triggers.
- [GET /api/zapier/test/{resource}](https://perfexcrm.themesic.com/apiguide/automation/test-trigger/): Returns sample data for testing automation triggers. Used by automation platforms to validate trigger configuration and show sample data structure to users.

## Batch

- [POST /api/batch](https://perfexcrm.themesic.com/apiguide/batch/batch-operations/): Execute up to 50 operations in one request, in order, with continue-on-error. Operations use the same names, arguments and per-operation permission rules as the MCP tools (e.g. customers_create, invoices_get, leads_search). Each item returns status plus result or error, with completed/failed counters in the envelope.

## Leads

- [DELETE /api/delete/leads/{id}](https://perfexcrm.themesic.com/apiguide/leads/delete-lead/): Delete a Lead
- [POST /api/leads](https://perfexcrm.themesic.com/apiguide/leads/post-lead/): Add New Lead
- [GET /api/leads/](https://perfexcrm.themesic.com/apiguide/leads/get-leads/): Request all Leads
- [GET /api/leads/{id}](https://perfexcrm.themesic.com/apiguide/leads/get-lead/): Request Lead information
- [PUT /api/leads/{id}](https://perfexcrm.themesic.com/apiguide/leads/put-lead/): Update a lead
- [GET /api/leads/search/{keysearch}](https://perfexcrm.themesic.com/apiguide/leads/get-lead-search/): Search Lead Information

## Invoices

- [POST /api/invoices](https://perfexcrm.themesic.com/apiguide/invoices/post-invoice/): Add New invoice
- [DELETE /api/invoices/{id}](https://perfexcrm.themesic.com/apiguide/invoices/delete-invoice/): Delete invoice
- [GET /api/invoices/{id}](https://perfexcrm.themesic.com/apiguide/invoices/get-invoice/): Request invoice information
- [PUT /api/invoices/{id}](https://perfexcrm.themesic.com/apiguide/invoices/put-invoice/): Update invoice
- [POST /api/invoices/{id}/send](https://perfexcrm.themesic.com/apiguide/invoices/send-invoice/): Emails the invoice to the customer using Perfex's own invoice email template, PDF attachment and SMTP configuration, and marks the invoice as sent. Requires the Invoices "Send email" permission. Send an Idempotency-Key header to make retries safe. The customer must have at least one contact flagged to receive invoice emails, and Setup -> Email (SMTP) must be configured or nothing is sent.
- [GET /api/invoices/search/{keysearch}](https://perfexcrm.themesic.com/apiguide/invoices/get-invoice-search/): Search invoice information

## Customers

- [POST /api/customers](https://perfexcrm.themesic.com/apiguide/customers/post-customer/): Add New Customer
- [GET /api/customers/{id}](https://perfexcrm.themesic.com/apiguide/customers/get-customer/): Request customer information
- [PUT /api/customers/{id}](https://perfexcrm.themesic.com/apiguide/customers/put-customer/): Update a Customer
- [GET /api/customers/search/{keysearch}](https://perfexcrm.themesic.com/apiguide/customers/get-customer-search/): Search Customer Information
- [DELETE /api/delete/customers/{id}](https://perfexcrm.themesic.com/apiguide/customers/delete-customer/): Delete a Customer

## Calendar Events

- [GET /api/calendar/](https://perfexcrm.themesic.com/apiguide/calendar-events/get-calendar-events/): Get All Calendar Events
- [POST /api/calendar/](https://perfexcrm.themesic.com/apiguide/calendar-events/post-calendar-event/): Create a new Calendar Event
- [DELETE /api/calendar/{id}](https://perfexcrm.themesic.com/apiguide/calendar-events/delete-calendar-event/): Delete a Calendar Event
- [GET /api/calendar/{id}](https://perfexcrm.themesic.com/apiguide/calendar-events/get-calendar-event/): Request Specific Event Information
- [PUT /api/calendar/{id}](https://perfexcrm.themesic.com/apiguide/calendar-events/update-calendar-event/): Update a Calendar Event

## Common

- [GET /api/common/{type}](https://perfexcrm.themesic.com/apiguide/common/get-common-data/): Retrieves common system data based on the specified type. This is a routing method that calls the appropriate helper method.

## Contacts

- [POST /api/contacts/](https://perfexcrm.themesic.com/apiguide/contacts/post-contact/): Add New Contact
- [GET /api/contacts/{customer_id}/{contact_id}](https://perfexcrm.themesic.com/apiguide/contacts/get-contact/): List all Contacts of a Customer
- [PUT /api/contacts/{id}](https://perfexcrm.themesic.com/apiguide/contacts/put-contact/): Update Contact Information
- [GET /api/contacts/search/{keysearch}](https://perfexcrm.themesic.com/apiguide/contacts/get-contact-search/): Search Contact Information
- [DELETE /api/delete/contacts/{id}](https://perfexcrm.themesic.com/apiguide/contacts/delete-contact/): Delete Contact

## Contracts

- [POST /api/contracts](https://perfexcrm.themesic.com/apiguide/contracts/post-contract/): Add New Contract
- [DELETE /api/contracts/{id}](https://perfexcrm.themesic.com/apiguide/contracts/delete-contract/): Delete Contract
- [GET /api/contracts/{id}](https://perfexcrm.themesic.com/apiguide/contracts/get-contract/): Request Contract information
- [GET /api/contracts/search/{keysearch}](https://perfexcrm.themesic.com/apiguide/contracts/get-contract-search/): Search contracts

## Credit Notes

- [POST /api/credit_notes](https://perfexcrm.themesic.com/apiguide/credit-notes/post-credit-notes/): Add New Credit Notes
- [PUT /api/credit_notes](https://perfexcrm.themesic.com/apiguide/credit-notes/put-credit-notes/): Update a Credit Note
- [DELETE /api/credit_notes/{id}](https://perfexcrm.themesic.com/apiguide/credit-notes/delete-credit-note/): Delete Credit Note
- [GET /api/credit_notes/{id}](https://perfexcrm.themesic.com/apiguide/credit-notes/get-credit-notes/): Request Credit notes information
- [GET /api/credit_notes/search/{keysearch}](https://perfexcrm.themesic.com/apiguide/credit-notes/get-credit-notes-search/): Search credit notes item information

## Estimates

- [POST /api/estimates](https://perfexcrm.themesic.com/apiguide/estimates/post-estimates/): Add New Estimates
- [DELETE /api/estimates/{id}](https://perfexcrm.themesic.com/apiguide/estimates/delete-estimate/): Delete Estimate
- [GET /api/estimates/{id}](https://perfexcrm.themesic.com/apiguide/estimates/get-estimate/): Request Estimate information
- [PUT /api/estimates/{id}](https://perfexcrm.themesic.com/apiguide/estimates/put-estimate/): Update a estimate
- [GET /api/estimates/search/{keysearch}](https://perfexcrm.themesic.com/apiguide/estimates/get-estimate-search/): Search Estimate information

## Expense Categories

- [GET /api/common/expense_category](https://perfexcrm.themesic.com/apiguide/expense-categories/get-expense-category/): Request Expense category

## Expenses

- [POST /api/expenses](https://perfexcrm.themesic.com/apiguide/expenses/add-expense/): Add Expense
- [PUT /api/expenses](https://perfexcrm.themesic.com/apiguide/expenses/put-expense/): Update a Expense
- [DELETE /api/expenses/{id}](https://perfexcrm.themesic.com/apiguide/expenses/delete-expenses/): Delete Expense
- [GET /api/expenses/{id}](https://perfexcrm.themesic.com/apiguide/expenses/get-expense/): Request Expense information
- [GET /api/expenses/search/{keysearch}](https://perfexcrm.themesic.com/apiguide/expenses/get-expense-search/): Search Expenses information

## Items

- [DELETE /api/delete/items/{id}](https://perfexcrm.themesic.com/apiguide/items/delete-item/): Delete an Item
- [POST /api/items](https://perfexcrm.themesic.com/apiguide/items/post-item/): Create New Item
- [GET /api/items/{id}](https://perfexcrm.themesic.com/apiguide/items/get-item/): Request Item information
- [PUT /api/items/{id}](https://perfexcrm.themesic.com/apiguide/items/put-item/): Update an Item
- [GET /api/items/search/{keysearch}](https://perfexcrm.themesic.com/apiguide/items/get-item-search/): Search Items

## Knowledge Base

- [GET /api/knowledge_base](https://perfexcrm.themesic.com/apiguide/knowledge-base/get-kb-articles/): List Knowledge Base Articles
- [POST /api/knowledge_base](https://perfexcrm.themesic.com/apiguide/knowledge-base/post-kb-article/): Add New Article
- [DELETE /api/knowledge_base/{id}](https://perfexcrm.themesic.com/apiguide/knowledge-base/delete-kb-article/): Delete an Article
- [GET /api/knowledge_base/{id}](https://perfexcrm.themesic.com/apiguide/knowledge-base/get-kb-article/): Request Article Information
- [PUT /api/knowledge_base/{id}](https://perfexcrm.themesic.com/apiguide/knowledge-base/put-kb-article/): Partial update - unknown fields are ignored.
- [GET /api/knowledge_base/groups](https://perfexcrm.themesic.com/apiguide/knowledge-base/get-kb-groups/): List Knowledge Base Groups
- [POST /api/knowledge_base/groups](https://perfexcrm.themesic.com/apiguide/knowledge-base/post-kb-group/): Add New Group
- [DELETE /api/knowledge_base/groups/{id}](https://perfexcrm.themesic.com/apiguide/knowledge-base/delete-kb-group/): Returns 409 while articles are still attached to the group.
- [PUT /api/knowledge_base/groups/{id}](https://perfexcrm.themesic.com/apiguide/knowledge-base/put-kb-group/): Update a Group

## Milestones

- [DELETE /api/delete/milestones/{id}](https://perfexcrm.themesic.com/apiguide/milestones/delete-milestone/): Delete a Milestone
- [POST /api/milestones](https://perfexcrm.themesic.com/apiguide/milestones/post-milestone/): Add New Milestone
- [GET /api/milestones/{id}](https://perfexcrm.themesic.com/apiguide/milestones/get-milestones/): Request Milestones information
- [PUT /api/milestones/{id}](https://perfexcrm.themesic.com/apiguide/milestones/put-milestone/): Update a Milestone
- [GET /api/milestones/search/{keysearch}](https://perfexcrm.themesic.com/apiguide/milestones/get-milestone-search/): Search Milestones Information

## Notes

- [POST /api/notes](https://perfexcrm.themesic.com/apiguide/notes/post-note/): Add New Note
- [DELETE /api/notes/{id}](https://perfexcrm.themesic.com/apiguide/notes/delete-note/): Delete a Note
- [GET /api/notes/{id}](https://perfexcrm.themesic.com/apiguide/notes/get-note/): Request Note Information
- [PUT /api/notes/{id}](https://perfexcrm.themesic.com/apiguide/notes/put-note/): Update a Note
- [GET /api/notes/{rel_type}/{rel_id}](https://perfexcrm.themesic.com/apiguide/notes/get-notes-by-relation/): List Notes of an Entity

## Payment Modes

- [GET /api/common/payment_mode](https://perfexcrm.themesic.com/apiguide/payment-modes/get-payment-mode/): Request Payment Modes

## Payments

- [POST /api/payments](https://perfexcrm.themesic.com/apiguide/payments/post-payment/): Add New Payment
- [GET /api/payments/{id}](https://perfexcrm.themesic.com/apiguide/payments/get-payment/): List all Payments
- [GET /api/payments/search/{keysearch}](https://perfexcrm.themesic.com/apiguide/payments/get-payment-search/): Search Payments Information

## Projects

- [DELETE /api/delete/projects/{id}](https://perfexcrm.themesic.com/apiguide/projects/delete-project/): Delete a Project
- [POST /api/projects](https://perfexcrm.themesic.com/apiguide/projects/post-project/): Add New Project
- [GET /api/projects/{id}](https://perfexcrm.themesic.com/apiguide/projects/get-project/): Request project information
- [PUT /api/projects/{id}](https://perfexcrm.themesic.com/apiguide/projects/put-project/): Update a project
- [GET /api/projects/search/{keysearch}](https://perfexcrm.themesic.com/apiguide/projects/get-project-search/): Search Project Information

## Proposals

- [PUT /api/proposal/{id}](https://perfexcrm.themesic.com/apiguide/proposals/put-proposal/): Update a proposal
- [GET /api/proposals](https://perfexcrm.themesic.com/apiguide/proposals/get-proposal/): Request Proposal information
- [POST /api/proposals](https://perfexcrm.themesic.com/apiguide/proposals/post-proposals/): Add New Proposals
- [DELETE /api/proposals/{id}](https://perfexcrm.themesic.com/apiguide/proposals/delete-proposal/): Delete Proposal
- [GET /api/proposals/search/{keysearch}](https://perfexcrm.themesic.com/apiguide/proposals/get-proposal-search/): Search proposals information

## Staffs

- [DELETE /api/delete/staffs/{id}](https://perfexcrm.themesic.com/apiguide/staffs/delete-staff/): Delete a Staff
- [POST /api/staffs](https://perfexcrm.themesic.com/apiguide/staffs/post-staffs/): Add New Staff
- [GET /api/staffs/{id}](https://perfexcrm.themesic.com/apiguide/staffs/get-staff/): Request Staff information
- [PUT /api/staffs/{id}](https://perfexcrm.themesic.com/apiguide/staffs/put-staff/): Update a Staff
- [GET /api/staffs/search/{keysearch}](https://perfexcrm.themesic.com/apiguide/staffs/get-staff-search/): Search Staff Information

## Subscriptions

- [GET /api/subscriptions/](https://perfexcrm.themesic.com/apiguide/subscriptions/request-subscriptions/): Request all Subscriptions
- [POST /api/subscriptions/](https://perfexcrm.themesic.com/apiguide/subscriptions/add-new-subscription/): Add New Subscription
- [DELETE /api/subscriptions/{id}](https://perfexcrm.themesic.com/apiguide/subscriptions/delete-a-subscription/): Delete a Subscription
- [GET /api/subscriptions/{id}](https://perfexcrm.themesic.com/apiguide/subscriptions/request-subscription-information/): Request Subscription Information
- [PUT /api/subscriptions/{id}](https://perfexcrm.themesic.com/apiguide/subscriptions/update-a-subscription/): Update a Subscription

## Tasks

- [DELETE /api/delete/tasks/{id}](https://perfexcrm.themesic.com/apiguide/tasks/delete-task/): Delete a Task
- [POST /api/tasks](https://perfexcrm.themesic.com/apiguide/tasks/post-task/): Add New Task
- [GET /api/tasks/{id}](https://perfexcrm.themesic.com/apiguide/tasks/get-task/): Request Task information
- [PUT /api/tasks/{id}](https://perfexcrm.themesic.com/apiguide/tasks/put-task/): Update a task
- [GET /api/tasks/{id}/checklist](https://perfexcrm.themesic.com/apiguide/tasks/get-task-checklist/): Get Task Checklist Items
- [POST /api/tasks/{id}/checklist](https://perfexcrm.themesic.com/apiguide/tasks/post-task-checklist/): Add Checklist Item to Task
- [GET /api/tasks/{id}/comments](https://perfexcrm.themesic.com/apiguide/tasks/get-task-comments/): Returns the comment thread of a task, oldest first. Requires the Tasks "get" permission.
- [POST /api/tasks/{id}/comments](https://perfexcrm.themesic.com/apiguide/tasks/post-task-comment/): Adds a comment to a task, authored by the token's staff member. Requires the Tasks "post" permission. Send an Idempotency-Key header to make retries safe.
- [DELETE /api/tasks/{task_id}/checklist/{item_id}](https://perfexcrm.themesic.com/apiguide/tasks/delete-task-checklist/): Delete Checklist Item
- [PUT /api/tasks/{task_id}/checklist/{item_id}](https://perfexcrm.themesic.com/apiguide/tasks/put-task-checklist/): Update Checklist Item
- [DELETE /api/tasks/{task_id}/comments/{comment_id}](https://perfexcrm.themesic.com/apiguide/tasks/delete-task-comment/): Deletes a task comment. Requires the Tasks "delete" permission.
- [PUT /api/tasks/{task_id}/comments/{comment_id}](https://perfexcrm.themesic.com/apiguide/tasks/put-task-comment/): Updates the text of an existing task comment. Requires the Tasks "put" permission.
- [GET /api/tasks/search/{keysearch}](https://perfexcrm.themesic.com/apiguide/tasks/get-task-search/): Search Tasks Information

## Taxes

- [GET /api/common/tax_data](https://perfexcrm.themesic.com/apiguide/taxes/get-taxes/): Request Taxes

## Thirdparty

- [GET /api/thirdparty/customtable/{table_name}](https://perfexcrm.themesic.com/apiguide/thirdparty/get-custom-table-records/): Retrieves all records from the specified custom table. The table name should be the exact name as it exists in the database (no prefix will be added).
- [POST /api/thirdparty/customtable/{table_name}](https://perfexcrm.themesic.com/apiguide/thirdparty/post-custom-table-record/): Inserts a new record into the specified custom table. All columns in the request body must exist in the table, otherwise an error will be returned.
- [DELETE /api/thirdparty/customtable/{table_name}/{id}](https://perfexcrm.themesic.com/apiguide/thirdparty/delete-custom-table-record/): Deletes a record from the specified custom table by its ID.
- [GET /api/thirdparty/customtable/{table_name}/{id}](https://perfexcrm.themesic.com/apiguide/thirdparty/get-custom-table-record-by-id/): Retrieves a specific record from the custom table by its ID.
- [PUT /api/thirdparty/customtable/{table_name}/{id}](https://perfexcrm.themesic.com/apiguide/thirdparty/put-custom-table-record/): Updates an existing record in the specified custom table. All columns in the request body must exist in the table, otherwise an error will be returned.

## Tickets

- [DELETE /api/delete/tickets/{id}](https://perfexcrm.themesic.com/apiguide/tickets/delete-ticket/): Delete a Ticket
- [POST /api/tickets](https://perfexcrm.themesic.com/apiguide/tickets/post-ticket/): Add New Ticket
- [GET /api/tickets/{id}](https://perfexcrm.themesic.com/apiguide/tickets/get-ticket/): Get Ticket(s)
- [PUT /api/tickets/{id}](https://perfexcrm.themesic.com/apiguide/tickets/put-ticket/): Update a ticket
- [POST /api/tickets/reply/{id}](https://perfexcrm.themesic.com/apiguide/tickets/post-ticket-reply/): Add reply to a ticket
- [GET /api/tickets/search/{keysearch}](https://perfexcrm.themesic.com/apiguide/tickets/get-ticket-search/): Search Ticket Information

## Timesheets

- [GET /api/timesheets/](https://perfexcrm.themesic.com/apiguide/timesheets/request-all-timesheets/): Request all Timesheets
- [POST /api/timesheets/](https://perfexcrm.themesic.com/apiguide/timesheets/add-new-timesheet/): Add New Timesheet
- [DELETE /api/timesheets/{id}](https://perfexcrm.themesic.com/apiguide/timesheets/delete-a-timesheet/): Delete a Timesheet
- [GET /api/timesheets/{id}](https://perfexcrm.themesic.com/apiguide/timesheets/request-timesheet-information/): Request Timesheet Information
- [PUT /api/timesheets/{id}](https://perfexcrm.themesic.com/apiguide/timesheets/update-a-timesheet/): Update a Timesheet

## Webhooks

- [GET /api/webhooks](https://perfexcrm.themesic.com/apiguide/webhooks/get-webhooks/): List all configured webhooks. Secrets are never returned (has_secret flag only). Supports page/per_page, sort, fields and date filters.
- [POST /api/webhooks](https://perfexcrm.themesic.com/apiguide/webhooks/post-webhook/): Create a Webhook
- [DELETE /api/webhooks/{id}](https://perfexcrm.themesic.com/apiguide/webhooks/delete-webhook/): Deletes the webhook together with its delivery logs and queued jobs.
- [GET /api/webhooks/{id}](https://perfexcrm.themesic.com/apiguide/webhooks/get-webhook/): Request Webhook Information
- [PUT /api/webhooks/{id}](https://perfexcrm.themesic.com/apiguide/webhooks/put-webhook/): Partial update - only the provided fields change; same validation as create.
- [GET /api/webhooks/{id}/logs](https://perfexcrm.themesic.com/apiguide/webhooks/get-webhook-logs/): Latest 500 delivery attempts with status, response code and error details. Paginated via page/per_page.
- [POST /api/webhooks/{id}/toggle](https://perfexcrm.themesic.com/apiguide/webhooks/toggle-webhook/): Enable/Disable a Webhook
- [GET /api/webhooks/events](https://perfexcrm.themesic.com/apiguide/webhooks/get-webhook-events/): The authoritative catalog: 124 events across 22 resource groups (invoice_created, lead_status_changed, ticket_reply_created, kb_article_created...).

## Custom Fields

- [GET /api/custom_fields/{FieldBelongsto}/{id}](https://perfexcrm.themesic.com/apiguide/custom-fields/get-custom-fieldswith-value/): Request Values of Custom Fields
- [DELETE /N/A](https://perfexcrm.themesic.com/apiguide/custom-fields/delete-action-example/): To remove particular custom field value you can use Update action and an empty value in the custom field. Note: When you delete any record the corresponding custom field data will be automatically deleted .
- [GET /N/A](https://perfexcrm.themesic.com/apiguide/custom-fields/get-action-example/): Custom fields' data will be returned combined with other request's information during the initial GET request of each available endpoint (Contacts, Invoices etc) with their respective label and value key
- [GET /N/A](https://perfexcrm.themesic.com/apiguide/custom-fields/search-action-example/): Custom fields' data will be returned combined with other request's information during the initial SEARCH request of each available endpoint (Contacts, Invoices etc) with their respective label and value key
- [POST /N/A](https://perfexcrm.themesic.com/apiguide/custom-fields/post-action-example/): Submit URL for POST request of the custom fields remains the same for each endpoint (ie api/contacts for Contacts endpoint, api/invoices for Invoices endpoint, etc..) In this example, we will use the following form data which corresponds to the following custom field types: custom_fields[invoice][1] = Input Type custom_fields[invoice][2] = Number custom_fields[invoice][3] = Textarea custom_fields[invoice][4] = Radio custom_fields[invoice][5] = Checkbox custom_fields[invoice][6] = Multiselect custom_fields[invoice][7] = Date custom_fields[invoice][8] = Datetime custom_fields[invoice][9] = Color custom_fields[invoice][10] = Link
- [PUT /N/A](https://perfexcrm.themesic.com/apiguide/custom-fields/put-action-example/): Submit URL for PUT request of the custom fields remains the same for each endpoint (ie api/contacts for Contacts endpoint, api/invoices for Invoices endpoint, etc..) In this example, we will use the following form data which corresponds to the following custom field types: custom_fields[invoice][1] = Input Type custom_fields[invoice][2] = Number custom_fields[invoice][3] = Textarea custom_fields[invoice][4] = Radio custom_fields[invoice][5] = Checkbox custom_fields[invoice][6] = Multiselect custom_fields[invoice][7] = Date custom_fields[invoice][8] = Datetime custom_fields[invoice][9] = Color custom_fields[invoice][10] = Link

## Optional

- [Full endpoint index](https://perfexcrm.themesic.com/apiguide/): every endpoint on one page.
- [Product page](https://themesic.com/product/rest-api-module-for-perfex-crm-connect-your-perfex-crm-with-third-party-applications/): licensing and what the module includes.
- [Support](https://themesic.com/support): licence and technical questions.