For AI agents: visit https://developer.maximizer.com/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
v4
Guides
API Reference
Changelog
Forums
🐈⬛ GitHub
📫 Postman
IntegerField
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
Powered by
Copy Page
IntegerField
Updated 8 months ago
UidObject
StringItem
Did this page help you?
Yes
No
Updated 8 months ago
UidObject
StringItem
Did this page help you?
Yes
No