Jump to Content
Guides
API Reference
Changelog
Forums
🐈⬛ GitHub
📫 Postman
v1.6
v2
Log In
API Reference
Log In
Ferret v1
Guides
API Reference
Changelog
Forums
🐈⬛ GitHub
📫 Postman
Searching in Octopus API
All
Pages
Start typing to search…
JUMP TO
OVERVIEW
Maximizer APIs
Getting Started
Ferret API
Getting Started with Ferret API
Appointments
Create a new appointment
post
Get a drop-down list of appointment results
get
Get a drop-down list of appointment categories
get
Get a drop-down list of appointment locations
get
Get available appointments time slots by contacts
get
Get available appointments time slots by users
get
Attachments
Create a new attachmenmt
post
Authentication
Authenticate to get a valid token
post
CallLogs
Create a new call log
post
Get a call log by its legacy key
get
Get a drop-down list of call log results
get
Get a drop-down list of call log categories
get
Companies
Create a new company
post
Get a paginated list of companies
get
Get a company by its legacy key
get
Get a drop-down list of companies
get
Contacts
Create a new contact
post
Get a contact by its legacy key
get
Get a list of contacts for the given email addresses
get
Get a drop-down list of contacts
get
Update a contact
put
Get the timeline of a contact by its legacy key
get
Get opportunities details of a contact
get
Get open opportunities summary of a contact
get
Get the upcoming appointments of a contact
get
Get emails summary of a contact
get
Get summary of manually created notes of a contact
get
Get tasks summary of a contact
get
Get calls log of a contact
get
Get a paginated list of notes of a contact
get
Households
Get a drop-down list of contacts
get
Interactions
Get a list of interaction categories
get
Notes
Create a new note
post
Get a note by its legacy key
get
Get a list of note categories
get
Opportunities
Create a new opportunity
post
Pipelines
Get a drop-down list of pipelines
get
Get a drop-down list of stages of a given pipeline
get
Tasks
Create a new task
post
Get a drop-down list of task results
get
Get a drop-down list of task categories
get
Get a drop-down list of task priorities
get
Tenants
Returns the version of the product enabled for the tenant
get
Timelines
Get a drop-down list of timeline event types
get
Get a drop-down list of timeline categories
get
Get a drop-down list of timeline results
get
Users
Get a drop-down list of users
get
Get user details by the current access token
get
Octopus API
Getting Started with Octopus API
Semantic Versioning
Sanitizing Data in Requests
Authentication Methods
Basic Query Syntax
Search Query Syntax
Searching in Octopus API
Search Operator Syntax
Comparison Operators
DateTime Operators
Logical Operators
Searching Nested Objects
Field and Object Types
Key
AttributeField
BooleanField
CurrencyField
DateTimeField
EmailField
EnumField<>
FormulaExpressionField
IntegerField
NumericField
PhoneField
RefStringField
SecAccess2LvlField
SecAccessFieldSchema
StringField
StringItem
UidObject
Powered by
Searching in Octopus API
Ask AI
