For AI agents: visit https://developer.maximizer.com/v3/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Guides
API Reference
Changelog
Forums
🐈⬛ GitHub
📫 Postman
Ferret v1
v3
v4
Log In
API Reference
Log In
v3
Guides
API Reference
Changelog
Forums
🐈⬛ GitHub
📫 Postman
StringItem
JUMP TO
OVERVIEW
Maximizer APIs
Maximizer OAuth
Authorization Code Flow
Test Console
OAuth for Maximizer On-Premise
Migrating from the Legacy Cloud Endpoints
Octopus API
Getting Started with Octopus API
Semantic Versioning
Sanitizing Data in Requests
Authentication
Authentication in CRM Live
Authentication on-premise
Token Validation
Read Query Syntax
Scope
Criteria
GroupBy
OrderBy
Write Query Syntax
Create a record
Update a record
Delete a record
Objects
AbEntry
Address
Appointment
Campaign
CampaignSubscriber
Case
ColumnSetup
CurrencyRate
Document
DocumentLibrary
FavoriteList
Folder
InteractionLog
KeyFieldList
KeyFieldDefinition
Lead
Note
Opportunity
Personal Access Token
SalesTeam
Task
Territory
User
Lead V2
SalesProcessSetup
SalesStageSetup
ProcessSetup
ProcessStageSetup
User Defined Fields (Udf) - Definition
RelatedEntry
Interaction
Task V2
Workflow
WorkflowAction
WorkflowStage
WorkflowInstance
WorkflowTaskTemplate
Field and Object Types
Key
AttributeField
BooleanField
CurrencyField
DateTimeField
EmailField
EnumField<>
FormulaExpressionField
IntegerField
NumericField
PhoneField
RefStringField
SecAccess2LvlField
SecAccessFieldSchema
StringField
StringItem
UidObject
IntegerField
StringItem
SecAccessFieldSchema
Advanced
Batch Queries
Schema
System
Webhooks API
Getting Started with Webhooks API
Subscriptions
Create a subscription
post
Get list of subscriptions
get
Update an existing subscription
put
Delete a subscription
del
Add a recipient to a subscription
put
Delete a recipient from a subscription
del
Targets
Create a target
post
Get list of targets
get
Update an existing target
put
Delete an existing target
del
Enable a target
patch
Disable a target
patch
FerretV2 API
Getting Started with Ferret API
Usage Examples
Authenticate
Authenticate
post
Ferret API - CRM
AbEntries
Get field options for AbEntry
get
Get a single AbEntry by key
get
Get metadata for AbEntry
get
Get list of AbEntries
get
Search for AbEntries
post
Addresses
Get a single Address by key
get
Get field options for Address
get
Get metadata for Address
get
Get list of Addresses
get
Search for Addresses
post
Cases
Get a single Case by key
get
Get metadata for Case
get
Get field options for Case
get
Get list of Cases
get
Search for Cases
post
InteractionLogs
Get a single InteractionLog by key
get
Get metadata for InteractionLog
get
Get field options for InteractionLog
get
Get list of InteractionLogs
get
Search for InteractionLogs
post
Opportunities
Follow an opportunity
post
Get list of Opportunities
get
Get field options for Opportunity
get
Get a single Opportunity by key
get
Get metadata for Opportunity
get
Search for Opportunities
post
SalesProcessSetups
Get list of SalesProcessSetups
get
Get a single SalesProcessSetup by key
get
Get metadata for SalesProcessSetup
get
Get field options for SalesProcessSetup
get
Search for SalesProcessSetups
post
SalesStageSetups
Get list of SalesStageSetups
get
Get a single SalesStageSetup by key
get
Get metadata for SalesStageSetup
get
Get field options for SalesStageSetup
get
Search for SalesStageSetups
post
SalesTeams
Get list of SalesTeams
get
Get a single SalesTeam by key
get
Get metadata for SalesTeam
get
Get field options for SalesTeam
get
Search for SalesTeams
post
Territories
Get list of Territories
get
Get field options for Territory
get
Get a single Territory by key
get
Get metadata for Territory
get
Search for Territories
post
Ferret API - SETTINGS
CurrencyRates
Get a single CurrencyRate by key
get
Get metadata for CurrencyRate
get
Get field options for CurrencyRate
get
Get list of CurrencyRates
get
Search for CurrencyRates
post
SecGroups
Get list of SecGroups
get
Get a single SecGroup by key
get
Get metadata for SecGroup
get
Get field options for SecGroup
get
Search for SecGroups
post
Users
Get list of Users
get
Get a single User by key
get
Get metadata for User
get
Get field options for User
get
Search for Users
post
Ferret API - Marketing
Campaigns
Get a single Campaign by key
get
Get metadata for Campaign
get
Get field options for Campaign
get
Get list of Campaigns
get
Search for Campaigns
post
Leads
Get a single Lead by key
get
Get metadata for Lead
get
Get field options for Lead
get
Get list of Leads
get
Search for Leads
post
ProcessSetups
Get list of ProcessSetups
get
Get a single ProcessSetup by key
get
Get metadata for ProcessSetup
get
Get field options for ProcessSetup
get
Search for ProcessSetups
post
ProcessStageSetups
Get list of ProcessStageSetups
get
Get a single ProcessStageSetup by key
get
Get metadata for ProcessStageSetup
get
Get field options for ProcessStageSetup
get
Search for ProcessStageSetups
post
Powered by
StringItem
Copy Page
Updated 4 months ago
UidObject
SecAccessFieldSchema
Did this page help you?
Yes
No
Updated 4 months ago
UidObject
SecAccessFieldSchema
Did this page help you?
Yes
No
