# Maximizer Developer Portal Documentation > Documentation for Maximizer Developer Portal ## Guides - [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) - [Webhooks](https://developer.maximizer.com/docs/webhooks.md) - [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 - [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. - [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) - [Getting Started with Webhooks API](https://developer.maximizer.com/reference/webhooks-api.md) - [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": "field-value" } $EQ => equal $NE => not equal $GT => greater than $GE => greater than or equal $LT => lower than $LE => lower than or equal $IN => in (list of values) $NIN => not in (list of values) $LIKE => like (with % as the only possible wildcard) $NLIKE => not like (with % as the only possible wildcard) Operators applied to field names Syntax: "operator": "field-name" $EXISTS => field exists in either Original or New data sections $NEXISTS => field does not exist in both Original and New data sections Note about User Defined Fields (UDFs): In the Maximizer CRM, UDFs can be referred to by using three different notations: Udf/$TYPEID(xx) => xx represents an unique integer identifier of the Udf field Udf/$NAME(nn) => nn represents the name of the Udf field Udf/$TAG(tt) => tt represents the tag of the Udf field (for internal use only) As for events, the UDFs are always generated with the default Udf/$TYPEID notation. This means we cannot use the other notations to create filters for events containing UDFs, as they won't be represented that way in the event and there will be no match. If you want to create a filter for a UDF, you must use the Udf/$TYPEID notation. To find out the actual TypeId for the UDF you want to filter, you can use Octopus API to read the object definition using the Metadata/Schema search. Please refer to the Developer Portal for more details on how to use the Octopus API for this purpose. - [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": "field-value" } $EQ => equal $NE => not equal $GT => greater than $GE => greater than or equal $LT => lower than $LE => lower than or equal $IN => in (list of values) $NIN => not in (list of values) $LIKE => like (with % as the only possible wildcard) $NLIKE => not like (with % as the only possible wildcard) Operators applied to field names Syntax: "operator": "field-name" $EXISTS => field exists in either Original or New data sections $NEXISTS => field does not exist in both Original and New data sections Note about User Defined Fields (UDFs): In the Maximizer CRM, UDFs can be referred to by using three different notations: Udf/$TYPEID(xx) => xx represents an unique integer identifier of the Udf field Udf/$NAME(nn) => nn represents the name of the Udf field Udf/$TAG(tt) => tt represents the tag of the Udf field (for internal use only) As for events, the UDFs are always generated with the default Udf/$TYPEID notation. This means we cannot use the other notations to create filters for events containing UDFs, as they won't be represented that way in the event and there will be no match. If you want to create a filter for a UDF, you must use the Udf/$TYPEID notation. To find out the actual TypeId for the UDF you want to filter, you can use Octopus API to read the object definition using the Metadata/Schema search. Please refer to the Developer Portal for more details on how to use the Octopus API for this purpose. - [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) - [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) - [Getting Started with Ferret API](https://developer.maximizer.com/reference/ferret-api.md) - [Usage Examples](https://developer.maximizer.com/reference/usage-examples.md): Some example requests and responses to help you get started with Ferret API - [Authenticate](https://developer.maximizer.com/reference/post_authenticate.md) - [Get field options for AbEntry](https://developer.maximizer.com/reference/get_abentries-fieldoptions.md) - [Get a single AbEntry by key](https://developer.maximizer.com/reference/get_abentries-abentrykey.md) - [Get metadata for AbEntry](https://developer.maximizer.com/reference/get_abentries-metadata.md) - [Get list of AbEntries](https://developer.maximizer.com/reference/get_abentries.md) - [Search for AbEntries](https://developer.maximizer.com/reference/post_abentries-search.md) - [Get a single Address by key](https://developer.maximizer.com/reference/get_addresses-addresskey.md) - [Get field options for Address](https://developer.maximizer.com/reference/get_addresses-fieldoptions.md) - [Get metadata for Address](https://developer.maximizer.com/reference/get_addresses-metadata.md) - [Get list of Addresses](https://developer.maximizer.com/reference/get_addresses.md) - [Search for Addresses](https://developer.maximizer.com/reference/post_addresses-search.md) - [Get a single Case by key](https://developer.maximizer.com/reference/get_cases-casekey.md) - [Get metadata for Case](https://developer.maximizer.com/reference/get_cases-metadata.md) - [Get field options for Case](https://developer.maximizer.com/reference/get_cases-fieldoptions.md) - [Get list of Cases](https://developer.maximizer.com/reference/get_cases.md) - [Search for Cases](https://developer.maximizer.com/reference/post_cases-search.md) - [Get a single InteractionLog by key](https://developer.maximizer.com/reference/get_interactionlogs-interactionlogkey.md) - [Get metadata for InteractionLog](https://developer.maximizer.com/reference/get_interactionlogs-metadata.md) - [Get field options for InteractionLog](https://developer.maximizer.com/reference/get_interactionlogs-fieldoptions.md) - [Get list of InteractionLogs](https://developer.maximizer.com/reference/get_interactionlogs.md) - [Search for InteractionLogs](https://developer.maximizer.com/reference/post_interactionlogs-search.md) - [Follow an opportunity](https://developer.maximizer.com/reference/post_opportunities-opportunitykey-follow.md) - [Get list of Opportunities](https://developer.maximizer.com/reference/get_opportunities.md) - [Get field options for Opportunity](https://developer.maximizer.com/reference/get_opportunities-fieldoptions.md) - [Get a single Opportunity by key](https://developer.maximizer.com/reference/get_opportunities-opportunitykey.md) - [Get metadata for Opportunity](https://developer.maximizer.com/reference/get_opportunities-metadata.md) - [Search for Opportunities](https://developer.maximizer.com/reference/post_opportunities-search.md) - [Get list of SalesProcessSetups](https://developer.maximizer.com/reference/get_salesprocesssetups.md) - [Get a single SalesProcessSetup by key](https://developer.maximizer.com/reference/get_salesprocesssetups-salesprocesssetupkey.md) - [Get metadata for SalesProcessSetup](https://developer.maximizer.com/reference/get_salesprocesssetups-metadata.md) - [Get field options for SalesProcessSetup](https://developer.maximizer.com/reference/get_salesprocesssetups-fieldoptions.md) - [Search for SalesProcessSetups](https://developer.maximizer.com/reference/post_salesprocesssetups-search.md) - [Get list of SalesStageSetups](https://developer.maximizer.com/reference/get_salesstagesetups.md) - [Get a single SalesStageSetup by key](https://developer.maximizer.com/reference/get_salesstagesetups-salesstagesetupkey.md) - [Get metadata for SalesStageSetup](https://developer.maximizer.com/reference/get_salesstagesetups-metadata.md) - [Get field options for SalesStageSetup](https://developer.maximizer.com/reference/get_salesstagesetups-fieldoptions.md) - [Search for SalesStageSetups](https://developer.maximizer.com/reference/post_salesstagesetups-search.md) - [Get list of SalesTeams](https://developer.maximizer.com/reference/get_salesteams.md) - [Get a single SalesTeam by key](https://developer.maximizer.com/reference/get_salesteams-salesteamkey.md) - [Get metadata for SalesTeam](https://developer.maximizer.com/reference/get_salesteams-metadata.md) - [Get field options for SalesTeam](https://developer.maximizer.com/reference/get_salesteams-fieldoptions.md) - [Search for SalesTeams](https://developer.maximizer.com/reference/post_salesteams-search.md) - [Get list of Territories](https://developer.maximizer.com/reference/get_territories.md) - [Get field options for Territory](https://developer.maximizer.com/reference/get_territories-fieldoptions.md) - [Get a single Territory by key](https://developer.maximizer.com/reference/get_territories-territorykey.md) - [Get metadata for Territory](https://developer.maximizer.com/reference/get_territories-metadata.md) - [Search for Territories](https://developer.maximizer.com/reference/post_territories-search.md) - [Get a single CurrencyRate by key](https://developer.maximizer.com/reference/get_currencyrates-currencyratekey.md) - [Get metadata for CurrencyRate](https://developer.maximizer.com/reference/get_currencyrates-metadata.md) - [Get field options for CurrencyRate](https://developer.maximizer.com/reference/get_currencyrates-fieldoptions.md) - [Get list of CurrencyRates](https://developer.maximizer.com/reference/get_currencyrates.md) - [Search for CurrencyRates](https://developer.maximizer.com/reference/post_currencyrates-search.md) - [Get list of SecGroups](https://developer.maximizer.com/reference/get_secgroups.md) - [Get a single SecGroup by key](https://developer.maximizer.com/reference/get_secgroups-secgroupkey.md) - [Get metadata for SecGroup](https://developer.maximizer.com/reference/get_secgroups-metadata.md) - [Get field options for SecGroup](https://developer.maximizer.com/reference/get_secgroups-fieldoptions.md) - [Search for SecGroups](https://developer.maximizer.com/reference/post_secgroups-search.md) - [Get list of Users](https://developer.maximizer.com/reference/get_users.md) - [Get a single User by key](https://developer.maximizer.com/reference/get_users-userkey.md) - [Get metadata for User](https://developer.maximizer.com/reference/get_users-metadata.md) - [Get field options for User](https://developer.maximizer.com/reference/get_users-fieldoptions.md) - [Search for Users](https://developer.maximizer.com/reference/post_users-search.md) - [Get a single Campaign by key](https://developer.maximizer.com/reference/get_campaigns-campaignkey.md) - [Get metadata for Campaign](https://developer.maximizer.com/reference/get_campaigns-metadata.md) - [Get field options for Campaign](https://developer.maximizer.com/reference/get_campaigns-fieldoptions.md) - [Get list of Campaigns](https://developer.maximizer.com/reference/get_campaigns.md) - [Search for Campaigns](https://developer.maximizer.com/reference/post_campaigns-search.md) - [Get a single Lead by key](https://developer.maximizer.com/reference/get_leads-leadkey.md) - [Get metadata for Lead](https://developer.maximizer.com/reference/get_leads-metadata.md) - [Get field options for Lead](https://developer.maximizer.com/reference/get_leads-fieldoptions.md) - [Get list of Leads](https://developer.maximizer.com/reference/get_leads.md) - [Search for Leads](https://developer.maximizer.com/reference/post_leads-search.md) - [Get list of ProcessSetups](https://developer.maximizer.com/reference/get_processsetups.md) - [Get a single ProcessSetup by key](https://developer.maximizer.com/reference/get_processsetups-processsetupkey.md) - [Get metadata for ProcessSetup](https://developer.maximizer.com/reference/get_processsetups-metadata.md) - [Get field options for ProcessSetup](https://developer.maximizer.com/reference/get_processsetups-fieldoptions.md) - [Search for ProcessSetups](https://developer.maximizer.com/reference/post_processsetups-search.md) - [Get list of ProcessStageSetups](https://developer.maximizer.com/reference/get_processstagesetups.md) - [Get a single ProcessStageSetup by key](https://developer.maximizer.com/reference/get_processstagesetups-processstagesetupkey.md) - [Get metadata for ProcessStageSetup](https://developer.maximizer.com/reference/get_processstagesetups-metadata.md) - [Get field options for ProcessStageSetup](https://developer.maximizer.com/reference/get_processstagesetups-fieldoptions.md) - [Search for ProcessStageSetups](https://developer.maximizer.com/reference/post_processstagesetups-search.md) ## Changelog - [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) - [Maximizer CRM (cloud) 2026 M02 release](https://developer.maximizer.com/changelog/2026m02-cloud.md) - [Maximizer CRM (cloud) 2026 M01 release](https://developer.maximizer.com/changelog/2026m01-cloud.md) - [Maximizer CRM (cloud) 2025 M11 release](https://developer.maximizer.com/changelog/2025m11-cloud.md) - [Maximizer CRM (cloud) 2025 M10 release](https://developer.maximizer.com/changelog/2025m10-cloud.md)