# Maximizer Developer Portal Documentation

> Documentation for Maximizer Developer Portal

## Guides: Documentation
- [Getting Started](https://developer.maximizer.com/docs/getting-started.md)
- [How-to get access to the Maximizer API](https://developer.maximizer.com/docs/api-access.md)
- [How-to become an integrator with Maximizer](https://developer.maximizer.com/docs/develop-third-party.md)
- [Maximizer MCP Server](https://developer.maximizer.com/docs/maximizer-mcp-server.md)
- [Webhooks](https://developer.maximizer.com/docs/webhooks.md)

## Guides: How-to
- [Deeplinks](https://developer.maximizer.com/docs/deeplinks.md)
- [Personal Access Token](https://developer.maximizer.com/docs/personal-access-token.md)
- [Maximizer and PowerBI](https://developer.maximizer.com/docs/maximizer-and-powerbi.md)
- [Migration: Ferret API v1 to Octopus API](https://developer.maximizer.com/docs/migration-guide-ferret-v1-to-octopus-api.md)

## API Reference: OVERVIEW
- [Maximizer APIs](https://developer.maximizer.com/reference/maximizer-api.md)
- [Maximizer OAuth](https://developer.maximizer.com/reference/oauth.md): Secure, delegated access to Maximizer data using the OAuth 2.0 Authorization Code Grant.
  - [Authorization Code Flow](https://developer.maximizer.com/reference/authorization-code-flow.md): Step-by-step guide to obtaining, using, and refreshing tokens with Maximizer OAuth.
  - [Test Console](https://developer.maximizer.com/reference/test-console.md): A browser-based console for trying the full OAuth flow against the real endpoints, without writing any code.
  - [OAuth for Maximizer On-Premise](https://developer.maximizer.com/reference/oauth-on-premise.md): Client setup and endpoint URLs for Maximizer On-Premise installations.
  - [Migrating from the Legacy Cloud Endpoints](https://developer.maximizer.com/reference/migrating-from-legacy-endpoints.md): How to move an existing integration from the region-specific OAuth endpoints to the current Maximizer Cloud endpoints.

## API Reference: Octopus API
- [Getting Started with Octopus API](https://developer.maximizer.com/reference/octopus-api.md)
- [Authentication](https://developer.maximizer.com/reference/octopus-api-docs-authentication.md)
  - [Authentication in CRM Live](https://developer.maximizer.com/reference/octopus-api-docs-authentication-authentication-in-crm-live.md)
  - [Authentication on-premise](https://developer.maximizer.com/reference/octopus-api-docs-authentication-authentication-on-premise.md)
  - [Token Validation](https://developer.maximizer.com/reference/octopus-api-docs-authentication-token-validation.md)
- [Read Query Syntax](https://developer.maximizer.com/reference/octopus-api-docs-read-query-syntax.md)
  - [Scope](https://developer.maximizer.com/reference/octopus-api-docs-read-query-syntax-scope.md)
  - [Criteria](https://developer.maximizer.com/reference/octopus-api-docs-read-query-syntax-criteria.md)
  - [GroupBy](https://developer.maximizer.com/reference/octopus-api-docs-read-query-syntax-groupby.md)
  - [OrderBy](https://developer.maximizer.com/reference/octopus-api-docs-read-query-syntax-orderby.md)
- [Write Query Syntax](https://developer.maximizer.com/reference/octopus-api-docs-write-query-syntax.md)
  - [Create a record](https://developer.maximizer.com/reference/octopus-api-docs-write-query-syntax-create-a-record.md)
  - [Update a record](https://developer.maximizer.com/reference/octopus-api-docs-write-query-syntax-update-a-record.md)
  - [Delete a record](https://developer.maximizer.com/reference/octopus-api-docs-write-query-syntax-delete-a-record.md)
- [Objects](https://developer.maximizer.com/reference/octopus-api-docs-objects.md)
  - [AbEntry](https://developer.maximizer.com/reference/octopus-api-docs-objects-abentry.md)
  - [Address](https://developer.maximizer.com/reference/octopus-api-docs-objects-address.md)
  - [Appointment](https://developer.maximizer.com/reference/octopus-api-docs-objects-appointment.md)
  - [Campaign](https://developer.maximizer.com/reference/octopus-api-docs-objects-campaign.md)
  - [CampaignSubscriber](https://developer.maximizer.com/reference/octopus-api-docs-objects-campaignsubscriber.md)
  - [Case](https://developer.maximizer.com/reference/octopus-api-docs-objects-case.md)
  - [ColumnSetup](https://developer.maximizer.com/reference/octopus-api-docs-objects-columnsetup.md)
  - [CurrencyRate](https://developer.maximizer.com/reference/octopus-api-docs-objects-currencyrate.md)
  - [Document](https://developer.maximizer.com/reference/octopus-api-docs-objects-document.md)
  - [DocumentLibrary](https://developer.maximizer.com/reference/octopus-api-docs-objects-documentlibrary.md)
  - [FavoriteList](https://developer.maximizer.com/reference/octopus-api-docs-objects-favoritelist.md)
  - [Folder](https://developer.maximizer.com/reference/octopus-api-docs-objects-folder.md)
  - [InteractionLog](https://developer.maximizer.com/reference/octopus-api-docs-objects-interactionlog.md)
  - [KeyFieldList](https://developer.maximizer.com/reference/octopus-api-docs-objects-keyfieldlist.md)
  - [KeyFieldDefinition](https://developer.maximizer.com/reference/octopus-api-docs-objects-keyfielddefinition.md)
  - [Lead](https://developer.maximizer.com/reference/octopus-api-docs-objects-lead.md)
  - [Note](https://developer.maximizer.com/reference/octopus-api-docs-objects-note.md)
  - [Opportunity](https://developer.maximizer.com/reference/octopus-api-docs-objects-opportunity.md)
  - [Personal Access Token](https://developer.maximizer.com/reference/octopus-api-docs-objects-personal-access-token.md)
  - [SalesTeam](https://developer.maximizer.com/reference/octopus-api-docs-objects-salesteam.md)
  - [Task](https://developer.maximizer.com/reference/octopus-api-docs-objects-task.md)
  - [Territory](https://developer.maximizer.com/reference/octopus-api-docs-objects-territory.md)
  - [User](https://developer.maximizer.com/reference/octopus-api-docs-objects-user.md)
  - [Lead V2](https://developer.maximizer.com/reference/octopus-api-docs-objects-lead-v.md)
  - [SalesProcessSetup](https://developer.maximizer.com/reference/octopus-api-docs-objects-salesprocesssetup.md)
  - [SalesStageSetup](https://developer.maximizer.com/reference/octopus-api-docs-objects-salesstagesetup.md)
  - [ProcessSetup](https://developer.maximizer.com/reference/octopus-api-docs-objects-processsetup.md)
  - [ProcessStageSetup](https://developer.maximizer.com/reference/octopus-api-docs-objects-processstagesetup.md)
  - [User Defined Fields (Udf) - Definition](https://developer.maximizer.com/reference/octopus-api-docs-objects-user-defined-fields-udf-definition.md)
  - [RelatedEntry](https://developer.maximizer.com/reference/octopus-api-docs-objects-relatedentry.md)
  - [Interaction](https://developer.maximizer.com/reference/octopus-api-docs-objects-interaction.md)
  - [Task V2](https://developer.maximizer.com/reference/octopus-api-docs-objects-task-v.md)
  - [Workflow](https://developer.maximizer.com/reference/octopus-api-docs-objects-workflow.md)
  - [WorkflowAction](https://developer.maximizer.com/reference/octopus-api-docs-objects-workflowaction.md)
  - [WorkflowStage](https://developer.maximizer.com/reference/octopus-api-docs-objects-workflowstage.md)
  - [WorkflowInstance](https://developer.maximizer.com/reference/octopus-api-docs-objects-workflowinstance.md)
  - [WorkflowTaskTemplate](https://developer.maximizer.com/reference/octopus-api-docs-objects-workflowtasktemplate.md)
- [Field and Object Types](https://developer.maximizer.com/reference/octopus-api-docs-field-and-object-types.md)
  - [Key](https://developer.maximizer.com/reference/octopus-api-docs-field-and-object-types-key.md)
  - [AttributeField](https://developer.maximizer.com/reference/octopus-api-docs-field-and-object-types-attributefield.md)
  - [BooleanField](https://developer.maximizer.com/reference/octopus-api-docs-field-and-object-types-booleanfield.md)
  - [CurrencyField](https://developer.maximizer.com/reference/octopus-api-docs-field-and-object-types-currencyfield.md)
  - [DateTimeField](https://developer.maximizer.com/reference/octopus-api-docs-field-and-object-types-datetimefield.md)
  - [EmailField](https://developer.maximizer.com/reference/octopus-api-docs-field-and-object-types-emailfield.md)
  - [EnumField<>](https://developer.maximizer.com/reference/octopus-api-docs-field-and-object-types-enumfield.md)
  - [FormulaExpressionField](https://developer.maximizer.com/reference/octopus-api-docs-field-and-object-types-formulaexpressionfield.md)
  - [IntegerField](https://developer.maximizer.com/reference/octopus-api-docs-field-and-object-types-integerfield.md)
  - [NumericField](https://developer.maximizer.com/reference/octopus-api-docs-field-and-object-types-numericfield.md)
  - [PhoneField](https://developer.maximizer.com/reference/octopus-api-docs-field-and-object-types-phonefield.md)
  - [RefStringField](https://developer.maximizer.com/reference/octopus-api-docs-field-and-object-types-refstringfield.md)
  - [SecAccess2LvlField](https://developer.maximizer.com/reference/octopus-api-docs-field-and-object-types-secaccess-lvlfield.md)
  - [SecAccessFieldSchema](https://developer.maximizer.com/reference/octopus-api-docs-field-and-object-types-secaccessfieldschema.md)
  - [StringField](https://developer.maximizer.com/reference/octopus-api-docs-field-and-object-types-stringfield.md)
  - [StringItem](https://developer.maximizer.com/reference/octopus-api-docs-field-and-object-types-stringitem.md)
  - [UidObject](https://developer.maximizer.com/reference/octopus-api-docs-field-and-object-types-uidobject.md)
- [Advanced](https://developer.maximizer.com/reference/octopus-api-docs-advanced.md)
  - [Batch Queries](https://developer.maximizer.com/reference/octopus-api-docs-advanced-batch-queries.md)
  - [Schema](https://developer.maximizer.com/reference/octopus-api-docs-advanced-schema.md)
  - [System](https://developer.maximizer.com/reference/octopus-api-docs-advanced-system.md)

## API Reference: Webhooks API
- [Getting Started with Webhooks API](https://developer.maximizer.com/reference/webhooks-api.md)
- Subscriptions
  - [Create a subscription](https://developer.maximizer.com/reference/post_v1-subscriptions.md): Combination of TargetId + Entity + Op must be unique.  Filter operators:  Operators applied to field values Supported field types: string, bool, int, float  Syntax: "field-name": { "operator":…
  - [Get list of subscriptions](https://developer.maximizer.com/reference/getlistofsubscriptions.md)
  - [Update an existing subscription](https://developer.maximizer.com/reference/put_v1-subscriptions-subscriptionid.md): Combination of TargetId + Entity + Op must be unique.  Filter operators:  Operators applied to field values Supported field types: string, bool, int, float  Syntax: "field-name": { "operator":…
  - [Delete a subscription](https://developer.maximizer.com/reference/delete_v1-subscriptions-subscriptionid.md)
  - [Add a recipient to a subscription](https://developer.maximizer.com/reference/put_v1-subscriptions-subscriptionid-recipients-recipient.md)
  - [Delete a recipient from a subscription](https://developer.maximizer.com/reference/delete_v1-subscriptions-subscriptionid-recipients-recipient.md)
- Targets
  - [Create a target](https://developer.maximizer.com/reference/post_v1-targets.md)
  - [Get list of targets](https://developer.maximizer.com/reference/getlistoftargets.md)
  - [Update an existing target](https://developer.maximizer.com/reference/put_v1-targets-targetid.md)
  - [Delete an existing target](https://developer.maximizer.com/reference/delete_v1-targets-targetid.md)
  - [Enable a target](https://developer.maximizer.com/reference/patch_v1-targets-targetid-enable.md)
  - [Disable a target](https://developer.maximizer.com/reference/patch_v1-targets-targetid-disable.md)

## Changelog
- [Maximizer CRM (cloud) 2026 M09 release](https://developer.maximizer.com/changelog/2026m09-cloud.md)
- [Connect AI assistants to Maximizer with the new MCP Server](https://developer.maximizer.com/changelog/introducing-the-maximizer-mcp-server.md)
- [Ferret API v2 (beta) documentation retired](https://developer.maximizer.com/changelog/ferret-api-v2-documentation-retired.md)
- [Maximizer CRM (cloud) 2026 M08 release](https://developer.maximizer.com/changelog/2026m08-cloud.md)
- [Introducing the New Maximizer OAuth Sign-In Experience](https://developer.maximizer.com/changelog/introducing-the-new-maximizer-oauth-sign-in-experience.md)
- [Maximizer CRM (cloud) 2026 M07 release](https://developer.maximizer.com/changelog/2026m07-cloud.md)
- [Maximizer CRM (cloud) 2026 M06 release](https://developer.maximizer.com/changelog/2026m06-cloud.md)
- [Maximizer CRM (cloud) 2026 M05 release](https://developer.maximizer.com/changelog/2026m05-cloud.md)
- [Maximizer CRM (cloud) 2026 M04 release](https://developer.maximizer.com/changelog/2026m04-cloud.md)
- [Maximizer CRM (cloud) 2026 M03 release](https://developer.maximizer.com/changelog/2026m03-cloud.md)