openapi: 3.2.0
info:
title: Infusionsoft Task API
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: '1.0'
description: 'Operations tagged Task across 7 of this provider''s published API definitions: infusionsoft-keap-sdk-v2-swagger-original.yml, infusionsoft-rest-v1-2025-11-05-openapi-original.json, infusionsoft-rest-v1-openapi-original.json, infusionsoft-rest-v1-openapi.json, infusionsoft-rest-v2-2025-11-05-openapi-original.json, infusionsoft-rest-v2-openapi-original.json, infusionsoft-rest-v2-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.keap.com/crm
- url: https://api.infusionsoft.com/crm/rest
- url: https://api.infusionsoft.com/crm
tags:
- name: Task
paths:
/rest/v2/tasks:
get:
tags:
- Task
summary: List Tasks
description: Retrieves a list of tasks based on the provided filter. Tasks which are not assigned to a User may be queried with user_id==UNASSIGNED.
operationId: listTasks
parameters:
- name: filter
in: query
description: 'Filter to apply, allowed fields are:
- (String) `contact_id`
- (String) `has_due_date`
- (String) `is_completed`
- (String) `user_id`
- (String) `opportunity_id`
- (String) `task_ids`
- (String) `priority` — one of `CRITICAL`, `ESSENTIAL`, `NONESSENTIAL`
- (String) `since_time`
- (String) `until_time`
- (String) `id` — supports `==`, `>`, `<`, `>=`, `<=`
- (String) `title` — supports prefix wildcard (`title==Foo*`)
Operators must be URL-encoded (`==` → `%3D%3D`, `>` → `%3E`, `<` → `%3C`).
For the filters listed above, here are some examples:
- `filter=contact_id%3D%3D123`
- `filter=has_due_date%3D%3Dtrue`
- `filter=is_completed%3D%3Dtrue`
- `filter=user_id%3D%3D321`
- `filter=opportunity_id%3D%3D321`
- `filter=task_ids%3D%3D1,2,3`
- `filter=priority%3D%3DCRITICAL`
- `filter=since_time%3D%3D2025-04-16T20:33:02.321Z;`
- `filter=until_time%3D%3D2025-08-16T20:33:02.321Z;`
- `filter=id%3E5` (id > 5)
- `filter=id%3C%3D100` (id <= 100)
- `filter=title%3D%3DFollow%2A` (title starts with "Follow")
**Custom fields:** tasks may also be filtered by any custom field defined on the Task record, referenced by its field name (e.g. `filter=cf_priority%3D%3D10`). Both indexed and non-indexed custom fields are filterable. Operators must be URL-encoded, same as the standard fields above. The supported operator and value depend on the field''s data type:
- Text-like fields (Text, Text Area, Name, Email, Website, Phone, Social Security Number) and choice fields with text options (Dropdown, Radio, State) — equals (`==`) and prefix wildcard (e.g. `cf_company%3D%3DAcme%2A`)
- Numeric fields (Whole Number, Decimal, Currency, Percent, Year, Month, Day of Week, User) — equals and comparison (`==`, `>`, `<`, `>=`, `<=`)
- Date and Date/Time fields — equals and comparison; the value must be a full ISO-8601 date-time with milliseconds and a timezone offset (e.g. `cf_renewDate%3C%3D2026-01-01T00:00:00.000Z`). Date-only values such as `2026-01-01` are rejected
- Yes/No fields — equals only, value `0` (No) or `1` (Yes)
- Drilldown fields — equals only, integer value
- Multi-select fields (List Box, User List Box) — equals only, matched as a contains search over the stored selections (e.g. `cf_tags%3D%3Dred`)
A custom field that does not exist, an operator unsupported for the field''s type, or a value that does not match the field''s type returns `400 Bad Request`.
'
required: false
schema:
type: string
- name: order_by
in: query
description: 'Attribute and direction to order items.
One of the following fields:
- `id`
- `create_time`
- `due_time`
- `update_time`
One of the following directions:
- `asc`
- `desc`'
required: false
schema:
type: string
- name: page_size
in: query
description: Total number of items to return per page
required: false
schema:
type: integer
format: int32
maximum: 1000
minimum: 0
example: 0
- name: page_token
in: query
description: Page token
required: false
schema:
type: string
- name: fields
in: query
description: 'Comma-delimited list of optional Task properties to include in the response. Allowed values: custom_fields'
required: false
schema:
type: array
items:
type: string
explode: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ListTasksResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
post:
tags:
- Task
summary: Create a Task
description: Creates a new task as the authenticated user.
operationId: createTask
parameters:
- name: fields
in: query
description: 'Comma-delimited list of optional Task properties to include in the response. Allowed values: custom_fields'
required: false
schema:
type: array
items:
type: string
explode: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTaskRequest'
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
servers:
- url: https://api.keap.com/crm
/rest/v2/tasks/model/customFields:
post:
tags:
- Task
summary: Create a Custom Field
description: 'Creates a custom field of the specified type and options to the Task object
Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.'
operationId: createTaskCustomField
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCustomFieldRequest'
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCustomFieldResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
servers:
- url: https://api.keap.com/crm
/rest/v2/tasks/model/customFields/tabs:
get:
tags:
- Task
summary: List Task Custom Field Tabs
description: 'Retrieves a list of custom field tabs for the Task record type.
Note: Custom Field Tabs for Tasks, Classic Appointments and Notes are combined.'
operationId: listTaskCustomFieldTabs
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ListCustomFieldTabsResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
post:
tags:
- Task
summary: Create a Task Custom Field Tab
description: 'Creates a new custom field tab for the Task record type.
Note: Custom Field Tabs for Tasks, Classic Appointments and Notes are combined.'
operationId: createTaskCustomFieldTab
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCustomFieldTabRequest'
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldTab'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
servers:
- url: https://api.keap.com/crm
/rest/v2/tasks/model/customFields/groups:
get:
tags:
- Task
summary: List Task Custom Field Groups
description: 'Retrieves a list of custom field groups for the Task record type. Optionally filter by tab_id to scope to a specific tab.
Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.'
operationId: listTaskCustomFieldGroups
parameters:
- name: tab_id
in: query
description: Optional tab id to scope groups to a single tab
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ListCustomFieldGroupsResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
post:
tags:
- Task
summary: Create a Task Custom Field Group
description: 'Creates a new custom field group for the Task record type. If `tab_id` is omitted, the group is added to the default ''Custom Fields'' tab.
Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.'
operationId: createTaskCustomFieldGroup
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCustomFieldGroupRequest'
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldGroup'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
servers:
- url: https://api.keap.com/crm
/rest/v2/tasks/{task_id}:
get:
tags:
- Task
summary: Retrieve a Task
description: Retrieves a single task
operationId: getTask
parameters:
- name: task_id
in: path
required: true
schema:
type: string
- name: fields
in: query
description: 'Comma-delimited list of optional Task properties to include in the response. Allowed values: custom_fields'
required: false
schema:
type: array
items:
type: string
explode: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
delete:
tags:
- Task
summary: Delete a Task
description: Deletes a single task
operationId: deleteTask
parameters:
- name: task_id
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
patch:
tags:
- Task
summary: Update a Task
description: Updates a task with only the values provided in the request.
operationId: updateTask
parameters:
- name: task_id
in: path
required: true
schema:
type: string
- name: update_mask
in: query
description: An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped.
required: false
schema:
type: array
items:
type: string
enum:
- id
- title
- description
- type
- priority
- completion_time
- due_time
- remind_time_mins
- assigned_to_user_id
- last_updated_by_user_id
- contact_id
- opportunity_id
- accepted
- completed
- custom_fields
uniqueItems: true
- name: fields
in: query
description: 'Comma-delimited list of optional Task properties to include in the response. Allowed values: custom_fields'
required: false
schema:
type: array
items:
type: string
explode: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUpdateTaskRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTaskResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
servers:
- url: https://api.keap.com/crm
/rest/v2/tasks/model/customFields/{custom_field_id}:
delete:
tags:
- Task
summary: Delete a Custom Field
description: 'Deletes a Custom Field from the Task object
Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.'
operationId: deleteTaskCustomField
parameters:
- name: custom_field_id
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
patch:
tags:
- Task
summary: Update a Task's Custom Field
description: 'Updates a custom field of the specified type and options to the Task object.
Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.'
operationId: updateTaskCustomField
parameters:
- name: custom_field_id
in: path
required: true
schema:
type: string
- name: update_mask
in: query
description: An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped.
required: false
schema:
type: array
items:
type: string
enum:
- group_id
- label
- options
uniqueItems: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCustomFieldMetaDataRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldMetaData'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
servers:
- url: https://api.keap.com/crm
/rest/v2/tasks/model/customFields/tabs/{tab_id}:
get:
tags:
- Task
summary: Retrieve a Task Custom Field Tab
description: 'Retrieves a single custom field tab by id for the Task record type.
Note: Custom Field Tabs for Tasks, Classic Appointments and Notes are combined.'
operationId: getTaskCustomFieldTab
parameters:
- name: tab_id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldTab'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
delete:
tags:
- Task
summary: Delete a Task Custom Field Tab
description: 'Deletes a custom field tab. Returns 409 Conflict if the tab still contains groups.
Note: Custom Field Tabs for Tasks, Classic Appointments and Notes are combined.'
operationId: deleteTaskCustomFieldTab
parameters:
- name: tab_id
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
patch:
tags:
- Task
summary: Update a Task Custom Field Tab
description: 'Updates an existing custom field tab. Only fields listed in `update_mask` are applied.
Note: Custom Field Tabs for Tasks, Classic Appointments and Notes are combined.'
operationId: updateTaskCustomFieldTab
parameters:
- name: tab_id
in: path
required: true
schema:
type: string
- name: update_mask
in: query
description: Comma-separated list of fields to update
required: true
schema:
type: array
items:
type: string
enum:
- name
- order
uniqueItems: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCustomFieldTabRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldTab'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
servers:
- url: https://api.keap.com/crm
/rest/v2/tasks/model/customFields/groups/{group_id}:
get:
tags:
- Task
summary: Retrieve a Task Custom Field Group
description: 'Retrieves a single custom field group by id for the Task record type.
Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.'
operationId: getTaskCustomFieldGroup
parameters:
- name: group_id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldGroup'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
delete:
tags:
- Task
summary: Delete a Task Custom Field Group
description: 'Deletes a custom field group. Returns 409 Conflict if the group still contains custom fields.
Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.'
operationId: deleteTaskCustomFieldGroup
parameters:
- name: group_id
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
patch:
tags:
- Task
summary: Update a Task Custom Field Group
description: 'Updates an existing custom field group. Only fields listed in `update_mask` are applied.
Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.'
operationId: updateTaskCustomFieldGroup
parameters:
- name: group_id
in: path
required: true
schema:
type: string
- name: update_mask
in: query
description: Comma-separated list of fields to update
required: true
schema:
type: array
items:
type: string
enum:
- name
- tab_id
- order
uniqueItems: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCustomFieldGroupRequest'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldGroup'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
servers:
- url: https://api.keap.com/crm
/rest/v2/tasks/model:
get:
tags:
- Task
summary: Retrieve Task Model
description: 'Get the custom fields for the Task object
Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.'
operationId: retrieveTaskModel
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectModel'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'501':
description: Method Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2: []
servers:
- url: https://api.keap.com/crm
/v1/tasks:
get:
tags:
- Task
summary: List Tasks
description: Retrieves a list of all tasks using the specified search criteria
operationId: listTasksUsingGET
parameters:
- name: completed
in: query
description: Sets completed status of items to return
schema:
type: boolean
- name: contact_id
in: query
description: contact_id
schema:
type: integer
format: int64
- name: has_due_date
in: query
description: has_due_date
schema:
type: boolean
- name: limit
in: query
description: Sets a total of items to return
schema:
type: integer
format: int32
example: 0
- name: offset
in: query
description: Sets a beginning range of items to return
schema:
type: integer
format: int32
example: 0
- name: order
in: query
description: Attribute to order items by
schema:
type: string
- name: since
in: query
description: Date to start searching from ex. `2017-01-01T22:17:59.039Z`
schema:
type: string
- name: until
in: query
description: Date to search to ex. `2017-01-01T22:17:59.039Z`
schema:
type: string
- name: user_id
in: query
description: user_id
schema:
type: integer
format: int64
responses:
'200':
description: OK
content:
application/json:
schema:
title: TaskList
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
sync_token:
type: string
tasks:
type: array
items:
title: Task
type: object
properties:
completed:
type: boolean
completion_date:
type: string
format: date-time
contact:
title: BasicContact
type: object
properties:
email:
type: string
first_name:
type: string
id:
type: integer
format: int64
last_name:
type: string
creation_date:
type: string
format: date-time
description:
type: string
due_date:
type: string
format: date-time
funnel_id:
type: integer
format: int64
jgraph_id:
type: integer
format: int64
modification_date:
type: string
format: date-time
priority:
type: integer
format: int32
remind_time:
type: integer
description: "Value in minutes before start_date to show pop-up reminder. \nAcceptable values are in [`5`,`10`,`15`,`30`,`60`,`120`,`240`,`480`,`1440`,`2880`]"
format: int32
title:
type: string
type:
type: string
url:
type: string
user_id:
type: integer
format: int64
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
post:
tags:
- Task
summary: Create a Task
description: "Creates a new task as the authenticated user. \n*Note:* Contact must contain at least one item in the fields `title` and `due_date`. \nAll other attributes are optional. \nThis endpoint does not currently support setting Custom Field values."
operationId: createTaskUsingPOST
requestBody:
description: task
content:
application/json:
schema:
title: Task
type: object
properties:
completed:
type: boolean
completion_date:
type: string
format: date-time
contact:
title: BasicContact
type: object
properties:
email:
type: string
first_name:
type: string
id:
type: integer
format: int64
last_name:
type: string
creation_date:
type: string
format: date-time
description:
type: string
due_date:
type: string
format: date-time
funnel_id:
type: integer
format: int64
jgraph_id:
type: integer
format: int64
modification_date:
type: string
format: date-time
priority:
type: integer
format: int32
remind_time:
type: integer
description: "Value in minutes before start_date to show pop-up reminder. \nAcceptable values are in [`5`,`10`,`15`,`30`,`60`,`120`,`240`,`480`,`1440`,`2880`]"
format: int32
title:
type: string
type:
type: string
url:
type: string
user_id:
type: integer
format: int64
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
title: Task
type: object
properties:
completed:
type: boolean
completion_date:
type: string
format: date-time
contact:
title: BasicContact
type: object
properties:
email:
type: string
first_name:
type: string
id:
type: integer
format: int64
last_name:
type: string
creation_date:
type: string
format: date-time
description:
type: string
due_date:
type: string
format: date-time
funnel_id:
type: integer
format: int64
jgraph_id:
type: integer
format: int64
modification_date:
type: string
format: date-time
priority:
type: integer
format: int32
remind_time:
type: integer
description: "Value in minutes before start_date to show pop-up reminder. \nAcceptable values are in [`5`,`10`,`15`,`30`,`60`,`120`,`240`,`480`,`1440`,`2880`]"
format: int32
title:
type: string
type:
type: string
url:
type: string
user_id:
type: integer
format: int64
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
x-codegen-request-body-name: task
servers:
- url: https://api.infusionsoft.com/crm/rest
/v1/tasks/model:
get:
tags:
- Task
summary: Retrieve Task Model
description: Get the custom fields for the Task object
operationId: retrieveTaskModelUsingGET
responses:
'200':
description: OK
content:
application/json:
schema:
title: ObjectModel
type: object
properties:
custom_fields:
type: array
items:
title: CustomFieldMetaData
type: object
properties:
default_value:
type: string
field_name:
type: string
field_type:
type: string
enum:
- Currency
- Date
- DateTime
- DayOfWeek
- Drilldown
- Email
- Month
- ListBox
- Name
- WholeNumber
- DecimalNumber
- Percent
- PhoneNumber
- Radio
- Dropdown
- SocialSecurityNumber
- State
- Text
- TextArea
- User
- UserListBox
- Website
- Year
- YesNo
id:
type: integer
format: int64
label:
type: string
options:
type: array
items:
title: CustomFieldOption
type: object
properties:
id:
type: string
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CustomFieldOption_2'
record_type:
type: string
enum:
- CONTACT
- REFERRAL_PARTNER
- OPPORTUNITY
- TASK_NOTE_APPOINTMENT
- COMPANY
- ORDER
- SUBSCRIPTION
optional_properties:
type: array
items:
type: string
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
servers:
- url: https://api.infusionsoft.com/crm/rest
/v1/tasks/model/customFields:
post:
tags:
- Task
summary: Create a Custom Field
description: Creates a custom field of the specified type and options to the Task object
operationId: createTaskCustomFieldUsingPOST
requestBody:
description: customField
content:
application/json:
schema:
title: CreateRestCustomField
required:
- field_type
- label
type: object
properties:
field_type:
type: string
enum:
- Currency
- Date
- DateTime
- DayOfWeek
- Drilldown
- Email
- Month
- ListBox
- Name
- WholeNumber
- DecimalNumber
- Percent
- PhoneNumber
- Radio
- Dropdown
- SocialSecurityNumber
- State
- Text
- TextArea
- User
- UserListBox
- Website
- Year
- YesNo
group_id:
type: integer
description: An optional tab group to place the field under in the interface. If not specified, will default to the 'Custom Fields' tab.
format: int64
label:
type: string
options:
type: array
items:
title: CreateRestCustomFieldOption
type: object
properties:
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CreateRestCustomFieldOption'
user_group_id:
type: integer
description: An optional user group to choose from when selecting values for User or UserListBox fields.
format: int64
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
title: CustomFieldMetaData
type: object
properties:
default_value:
type: string
field_name:
type: string
field_type:
type: string
enum:
- Currency
- Date
- DateTime
- DayOfWeek
- Drilldown
- Email
- Month
- ListBox
- Name
- WholeNumber
- DecimalNumber
- Percent
- PhoneNumber
- Radio
- Dropdown
- SocialSecurityNumber
- State
- Text
- TextArea
- User
- UserListBox
- Website
- Year
- YesNo
id:
type: integer
format: int64
label:
type: string
options:
type: array
items:
title: CustomFieldOption
type: object
properties:
id:
type: string
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CustomFieldOption_2'
record_type:
type: string
enum:
- CONTACT
- REFERRAL_PARTNER
- OPPORTUNITY
- TASK_NOTE_APPOINTMENT
- COMPANY
- ORDER
- SUBSCRIPTION
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
x-codegen-request-body-name: customField
servers:
- url: https://api.infusionsoft.com/crm/rest
/v1/tasks/search:
get:
tags:
- Task
summary: Search Tasks
description: Retrieves Tasks belonging to the authenticated user using the specified search criteria
operationId: listTasksForCurrentUserUsingGET
parameters:
- name: completed
in: query
description: Sets completed status of items to return
schema:
type: boolean
- name: contact_id
in: query
description: Returns tasks for the provided contact id
allowEmptyValue: false
schema:
type: integer
format: int64
example: 0
- name: has_due_date
in: query
description: Returns tasks that have an 'action date' when set to true
allowEmptyValue: false
schema:
type: boolean
- name: limit
in: query
description: Sets a total of items to return
schema:
type: integer
format: int32
example: 0
- name: offset
in: query
description: Sets a beginning range of items to return
schema:
type: integer
format: int32
example: 0
- name: order
in: query
description: Attribute to order items by
schema:
type: string
- name: since
in: query
description: Date to start searching from ex. `2017-01-01T22:17:59.039Z`
schema:
type: string
- name: until
in: query
description: Date to search to ex. `2017-01-01T22:17:59.039Z`
schema:
type: string
- name: user_id
in: query
description: Returns tasks for the provided user id
allowEmptyValue: false
schema:
type: integer
format: int64
example: 0
responses:
'200':
description: OK
content:
application/json:
schema:
title: TaskList
type: object
properties:
count:
type: integer
format: int32
next:
type: string
previous:
type: string
sync_token:
type: string
tasks:
type: array
items:
title: Task
type: object
properties:
completed:
type: boolean
completion_date:
type: string
format: date-time
contact:
title: BasicContact
type: object
properties:
email:
type: string
first_name:
type: string
id:
type: integer
format: int64
last_name:
type: string
creation_date:
type: string
format: date-time
description:
type: string
due_date:
type: string
format: date-time
funnel_id:
type: integer
format: int64
jgraph_id:
type: integer
format: int64
modification_date:
type: string
format: date-time
priority:
type: integer
format: int32
remind_time:
type: integer
description: "Value in minutes before start_date to show pop-up reminder. \nAcceptable values are in [`5`,`10`,`15`,`30`,`60`,`120`,`240`,`480`,`1440`,`2880`]"
format: int32
title:
type: string
type:
type: string
url:
type: string
user_id:
type: integer
format: int64
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
servers:
- url: https://api.infusionsoft.com/crm/rest
/v1/tasks/{taskId}:
get:
tags:
- Task
summary: Retrieve a Task
description: Retrieves a single task
operationId: getTaskUsingGET
parameters:
- name: taskId
in: path
description: taskId
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
title: Task
type: object
properties:
completed:
type: boolean
completion_date:
type: string
format: date-time
contact:
title: BasicContact
type: object
properties:
email:
type: string
first_name:
type: string
id:
type: integer
format: int64
last_name:
type: string
creation_date:
type: string
format: date-time
description:
type: string
due_date:
type: string
format: date-time
funnel_id:
type: integer
format: int64
jgraph_id:
type: integer
format: int64
modification_date:
type: string
format: date-time
priority:
type: integer
format: int32
remind_time:
type: integer
description: "Value in minutes before start_date to show pop-up reminder. \nAcceptable values are in [`5`,`10`,`15`,`30`,`60`,`120`,`240`,`480`,`1440`,`2880`]"
format: int32
title:
type: string
type:
type: string
url:
type: string
user_id:
type: integer
format: int64
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
put:
tags:
- Task
summary: Replace a Task
description: "Replaces a task with the values provided in the request. \nThis endpoint does not currently support updating Custom Field values."
operationId: updateTaskUsingPUT
parameters:
- name: taskId
in: path
description: taskId
required: true
schema:
type: string
requestBody:
description: task
content:
application/json:
schema:
title: Task
type: object
properties:
completed:
type: boolean
completion_date:
type: string
format: date-time
contact:
title: BasicContact
type: object
properties:
email:
type: string
first_name:
type: string
id:
type: integer
format: int64
last_name:
type: string
creation_date:
type: string
format: date-time
description:
type: string
due_date:
type: string
format: date-time
funnel_id:
type: integer
format: int64
jgraph_id:
type: integer
format: int64
modification_date:
type: string
format: date-time
priority:
type: integer
format: int32
remind_time:
type: integer
description: "Value in minutes before start_date to show pop-up reminder. \nAcceptable values are in [`5`,`10`,`15`,`30`,`60`,`120`,`240`,`480`,`1440`,`2880`]"
format: int32
title:
type: string
type:
type: string
url:
type: string
user_id:
type: integer
format: int64
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
title: Task
type: object
properties:
completed:
type: boolean
completion_date:
type: string
format: date-time
contact:
title: BasicContact
type: object
properties:
email:
type: string
first_name:
type: string
id:
type: integer
format: int64
last_name:
type: string
creation_date:
type: string
format: date-time
description:
type: string
due_date:
type: string
format: date-time
funnel_id:
type: integer
format: int64
jgraph_id:
type: integer
format: int64
modification_date:
type: string
format: date-time
priority:
type: integer
format: int32
remind_time:
type: integer
description: "Value in minutes before start_date to show pop-up reminder. \nAcceptable values are in [`5`,`10`,`15`,`30`,`60`,`120`,`240`,`480`,`1440`,`2880`]"
format: int32
title:
type: string
type:
type: string
url:
type: string
user_id:
type: integer
format: int64
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
x-codegen-request-body-name: task
delete:
tags:
- Task
summary: Delete a Task
description: Permanently deletes a task
operationId: deleteTaskUsingDELETE
parameters:
- name: taskId
in: path
description: taskId
required: true
schema:
type: string
responses:
'204':
description: No Content
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
patch:
tags:
- Task
summary: Update a Task
description: "Updates a task with only the values provided in the request. \nThis endpoint does not currently support updating Custom Field values."
operationId: updatePropertiesOnTaskUsingPATCH
parameters:
- name: taskId
in: path
description: taskId
required: true
schema:
type: string
requestBody:
description: task
content:
application/json:
schema:
title: Task
type: object
properties:
completed:
type: boolean
completion_date:
type: string
format: date-time
contact:
title: BasicContact
type: object
properties:
email:
type: string
first_name:
type: string
id:
type: integer
format: int64
last_name:
type: string
creation_date:
type: string
format: date-time
description:
type: string
due_date:
type: string
format: date-time
funnel_id:
type: integer
format: int64
jgraph_id:
type: integer
format: int64
modification_date:
type: string
format: date-time
priority:
type: integer
format: int32
remind_time:
type: integer
description: "Value in minutes before start_date to show pop-up reminder. \nAcceptable values are in [`5`,`10`,`15`,`30`,`60`,`120`,`240`,`480`,`1440`,`2880`]"
format: int32
title:
type: string
type:
type: string
url:
type: string
user_id:
type: integer
format: int64
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
title: Task
type: object
properties:
completed:
type: boolean
completion_date:
type: string
format: date-time
contact:
title: BasicContact
type: object
properties:
email:
type: string
first_name:
type: string
id:
type: integer
format: int64
last_name:
type: string
creation_date:
type: string
format: date-time
description:
type: string
due_date:
type: string
format: date-time
funnel_id:
type: integer
format: int64
jgraph_id:
type: integer
format: int64
modification_date:
type: string
format: date-time
priority:
type: integer
format: int32
remind_time:
type: integer
description: "Value in minutes before start_date to show pop-up reminder. \nAcceptable values are in [`5`,`10`,`15`,`30`,`60`,`120`,`240`,`480`,`1440`,`2880`]"
format: int32
title:
type: string
type:
type: string
url:
type: string
user_id:
type: integer
format: int64
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
x-codegen-request-body-name: task
servers:
- url: https://api.infusionsoft.com/crm/rest
/rest/v1/tasks/{taskId}:
get:
tags:
- Task
summary: Retrieve a Task
description: Retrieves a single task
operationId: getTask
parameters:
- name: taskId
in: path
required: true
schema:
type: string
responses:
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'501':
description: Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'406':
description: Not Acceptable
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'412':
description: Precondition Failed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Task_2'
security:
- oauth2: []
put:
tags:
- Task
summary: Replace a Task
description: "Replaces a task with the values provided in the request. \nThis endpoint does not currently support updating Custom Field values."
operationId: updateTask
parameters:
- name: taskId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Task_2'
required: true
responses:
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'501':
description: Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'406':
description: Not Acceptable
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'412':
description: Precondition Failed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Task_2'
security:
- oauth2: []
delete:
tags:
- Task
summary: Delete a Task
description: Permanently deletes a task
operationId: deleteTask
parameters:
- name: taskId
in: path
required: true
schema:
type: string
responses:
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'501':
description: Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'406':
description: Not Acceptable
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'412':
description: Precondition Failed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'204':
description: No Content
security:
- oauth2: []
patch:
tags:
- Task
summary: Update a Task
description: "Updates a task with only the values provided in the request. \nThis endpoint does not currently support updating Custom Field values."
operationId: updatePropertiesOnTask
parameters:
- name: taskId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Task_2'
required: true
responses:
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'501':
description: Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'406':
description: Not Acceptable
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'412':
description: Precondition Failed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Task_2'
security:
- oauth2: []
servers:
- url: https://api.infusionsoft.com/crm
/rest/v1/tasks/model/customFields:
post:
tags:
- Task
summary: Create a Custom Field
description: Creates a custom field of the specified type and options to the Task object
operationId: createTaskCustomField
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateRestCustomField'
required: true
responses:
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'501':
description: Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'406':
description: Not Acceptable
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'412':
description: Precondition Failed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldMetaData_2'
security:
- oauth2: []
servers:
- url: https://api.infusionsoft.com/crm
/rest/v1/tasks:
get:
tags:
- Task
summary: List Tasks
description: Retrieves a list of all tasks using the specified search criteria
operationId: listTasks
parameters:
- name: contact_id
in: query
required: false
schema:
type: integer
format: int64
- name: has_due_date
in: query
required: false
schema:
type: boolean
- name: user_id
in: query
required: false
schema:
type: integer
format: int64
- name: taskSearchCommand
in: query
required: true
schema:
$ref: '#/components/schemas/TaskSearchCommand'
responses:
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'501':
description: Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'406':
description: Not Acceptable
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'412':
description: Precondition Failed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TaskList'
security:
- oauth2: []
post:
tags:
- Task
summary: Create a Task
description: "Creates a new task as the authenticated user. \n*Note:* Contact must contain at least one item in the fields `title` and `due_date`. \nAll other attributes are optional. \nThis endpoint does not currently support setting Custom Field values."
operationId: createTask
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Task_2'
required: true
responses:
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'501':
description: Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'406':
description: Not Acceptable
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'412':
description: Precondition Failed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Task_2'
security:
- oauth2: []
servers:
- url: https://api.infusionsoft.com/crm
/rest/v1/tasks/search:
get:
tags:
- Task
summary: Search Tasks
description: Retrieves Tasks belonging to the authenticated user using the specified search criteria
operationId: listTasksForCurrentUser
parameters:
- name: contact_id
in: query
description: Returns tasks for the provided contact id
required: false
schema:
type: integer
format: int64
example: 0
- name: has_due_date
in: query
description: Returns tasks that have an 'action date' when set to true
required: false
schema:
type: boolean
- name: user_id
in: query
description: Returns tasks for the provided user id
required: false
schema:
type: integer
format: int64
example: 0
- name: taskSearchCommand
in: query
required: true
schema:
$ref: '#/components/schemas/TaskSearchCommand'
responses:
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'501':
description: Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'406':
description: Not Acceptable
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'412':
description: Precondition Failed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TaskList'
security:
- oauth2: []
servers:
- url: https://api.infusionsoft.com/crm
/rest/v1/tasks/model:
get:
tags:
- Task
summary: Retrieve Task Model
description: Get the custom fields for the Task object
operationId: retrieveTaskModel
responses:
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'501':
description: Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'406':
description: Not Acceptable
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'412':
description: Precondition Failed
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAndView'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectModel_2'
security:
- oauth2: []
servers:
- url: https://api.infusionsoft.com/crm
/v2/tasks:
get:
tags:
- Task
summary: List Tasks
description: Retrieves a list of tasks based on the provided filter. Tasks which are not assigned to a User may be queried with user_id==UNASSIGNED.
operationId: listTasksUsingGET_1
parameters:
- name: filter
in: query
description: 'Filter to apply, allowed fields are:
- (String) `contact_id`
- (String) `has_due_date`
- (String) `is_completed`
- (String) `user_id`
- (String) `task_ids`
- (String) `since_time`
- (String) `until_time`
You will need to apply the `==` operator to check the equality of one of the filters with your searched
word, in the encoded form `%3D%3D`. For the filters listed above, here are some examples:
- `filter=contact_id%3D%3D123`
- `filter=has_due_date%3D%3Dtrue`
- `filter=is_completed%3D%3Dtrue`
- `filter=user_id%3D%3D321`
- `filter=task_ids%3D%3D1,2,3`
- `filter=since_time%3D%3D2025-04-16T20:33:02.321Z;`
- `filter=until_time%3D%3D2025-08-16T20:33:02.321Z;`
'
schema:
type: string
- name: order_by
in: query
description: 'Attribute and direction to order items.
One of the following fields:
- `id`
- `create_time`
- `due_time`
One of the following directions:
- `asc`
- `desc`'
schema:
type: string
- name: page_size
in: query
description: Total number of items to return per page
schema:
maximum: 1000
minimum: 1
type: integer
format: int32
example: 0
- name: page_token
in: query
description: Page token
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
title: ListTasksResponse
type: object
properties:
next_page_token:
type: string
tasks:
type: array
items:
title: Task
type: object
properties:
assigned_to_user_id:
type: string
completed:
type: boolean
completion_time:
type: string
contact_id:
type: string
create_time:
type: string
description: On initial object the returned value for this property may not accurately represent the exact stored value.
created_by_user_id:
type: string
description:
type: string
due_time:
type: string
id:
type: string
modification_time:
type: string
priority:
type: string
enum:
- CRITICAL
- ESSENTIAL
- NONESSENTIAL
remind_time_mins:
type: integer
format: int32
title:
type: string
type:
type: string
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
post:
tags:
- Task
summary: Create a Task
description: "Creates a new task as the authenticated user. \nThis endpoint does not currently support setting Custom Field values."
operationId: createTaskUsingPOST_1
requestBody:
description: task
content:
application/json:
schema:
title: CreateTaskRequest
required:
- assigned_to_user_id
type: object
properties:
assigned_to_user_id:
type: string
completed:
type: boolean
completion_time:
type: string
contact_id:
type: string
description:
type: string
due_time:
type: string
priority:
type: string
enum:
- CRITICAL
- ESSENTIAL
- NONESSENTIAL
remind_time_mins:
type: integer
description: Value in minutes before start_date to show pop-up reminder. Acceptable values are [5,10,15,30,60,120,240,480,1440,2880]
format: int32
title:
type: string
type:
type: string
required: false
responses:
'201':
description: Created
content:
application/json:
schema:
title: Task
type: object
properties:
assigned_to_user_id:
type: string
completed:
type: boolean
completion_time:
type: string
contact_id:
type: string
create_time:
type: string
description: On initial object the returned value for this property may not accurately represent the exact stored value.
created_by_user_id:
type: string
description:
type: string
due_time:
type: string
id:
type: string
modification_time:
type: string
priority:
type: string
enum:
- CRITICAL
- ESSENTIAL
- NONESSENTIAL
remind_time_mins:
type: integer
format: int32
title:
type: string
type:
type: string
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
x-codegen-request-body-name: task
servers:
- url: https://api.infusionsoft.com/crm/rest
/v2/tasks/model:
get:
tags:
- Task
summary: Retrieve Task Model
description: 'Get the custom fields for the Task object
Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.'
operationId: retrieveTaskModelUsingGET_1
responses:
'200':
description: OK
content:
application/json:
schema:
title: ObjectModel
type: object
properties:
custom_fields:
type: array
items:
title: CustomFieldMetaData
type: object
properties:
default_value:
type: string
field_name:
type: string
field_type:
type: string
enum:
- CURRENCY
- DATE
- DATE_TIME
- DAY_OF_WEEK
- DECIMAL_NUMBER
- DRILLDOWN
- DROPDOWN
- EMAIL
- LIST_BOX
- MONTH
- NAME
- PERCENT
- PHONE_NUMBER
- RADIO
- SOCIAL_SECURITY_NUMBER
- STATE
- TEXT
- TEXT_AREA
- USER
- USER_LIST_BOX
- WEBSITE
- WHOLE_NUMBER
- YEAR
- YES_NO
group_id:
type: string
id:
type: string
label:
type: string
options:
type: array
items:
title: CustomFieldOption
type: object
properties:
id:
type: string
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CustomFieldOption_3'
record_type:
type: string
enum:
- CONTACT
- REFERRAL_PARTNER
- OPPORTUNITY
- TASK_NOTE_APPOINTMENT
- COMPANY
- ORDER
- SUBSCRIPTION
optional_properties:
type: array
description: These fields are not transmitted by default on this model, but can be requested by specifying them in a comma-separated list in the optional_properties query parameter.
items:
type: string
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
servers:
- url: https://api.infusionsoft.com/crm/rest
/v2/tasks/model/customFields:
post:
tags:
- Task
summary: Create a Custom Field
description: 'Creates a custom field of the specified type and options to the Task object
Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.'
operationId: createTaskCustomFieldUsingPOST_1
requestBody:
description: customField
content:
application/json:
schema:
title: CreateCustomFieldRequest
required:
- field_type
- label
type: object
properties:
field_type:
type: string
enum:
- CURRENCY
- DATE
- DATE_TIME
- DAY_OF_WEEK
- DECIMAL_NUMBER
- DRILLDOWN
- DROPDOWN
- EMAIL
- LIST_BOX
- MONTH
- NAME
- PERCENT
- PHONE_NUMBER
- RADIO
- SOCIAL_SECURITY_NUMBER
- STATE
- TEXT
- TEXT_AREA
- USER
- USER_LIST_BOX
- WEBSITE
- WHOLE_NUMBER
- YEAR
- YES_NO
group_id:
type: string
description: An optional tab group to place the field under in the interface. If not specified, will default to the 'Custom Fields' tab.
label:
type: string
options:
type: array
items:
title: CreateCustomFieldOptionRequest
type: object
properties:
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CreateCustomFieldOptionRequest_2'
user_group_id:
type: string
description: An optional user group to choose from when selecting values for User or UserListBox fields.
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
title: CreateCustomFieldResponse
type: object
properties:
custom_field:
title: CustomFieldMetaData
type: object
properties:
default_value:
type: string
field_name:
type: string
field_type:
type: string
enum:
- CURRENCY
- DATE
- DATE_TIME
- DAY_OF_WEEK
- DECIMAL_NUMBER
- DRILLDOWN
- DROPDOWN
- EMAIL
- LIST_BOX
- MONTH
- NAME
- PERCENT
- PHONE_NUMBER
- RADIO
- SOCIAL_SECURITY_NUMBER
- STATE
- TEXT
- TEXT_AREA
- USER
- USER_LIST_BOX
- WEBSITE
- WHOLE_NUMBER
- YEAR
- YES_NO
group_id:
type: string
id:
type: string
label:
type: string
options:
type: array
items:
title: CustomFieldOption
type: object
properties:
id:
type: string
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CustomFieldOption_3'
record_type:
type: string
enum:
- CONTACT
- REFERRAL_PARTNER
- OPPORTUNITY
- TASK_NOTE_APPOINTMENT
- COMPANY
- ORDER
- SUBSCRIPTION
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
x-codegen-request-body-name: customField
servers:
- url: https://api.infusionsoft.com/crm/rest
/v2/tasks/model/customFields/{custom_field_id}:
delete:
tags:
- Task
summary: Delete a Custom Field
description: 'Deletes a Custom Field from the Task object
Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.'
operationId: deleteTaskCustomFieldUsingDELETE
parameters:
- name: custom_field_id
in: path
description: custom_field_id
required: true
schema:
type: string
responses:
'204':
description: No Content
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
patch:
tags:
- Task
summary: Update a Task's Custom Field
description: 'Updates a custom field of the specified type and options to the Task object.
Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.'
operationId: updateTaskCustomFieldUsingPATCH
parameters:
- name: custom_field_id
in: path
description: custom_field_id
required: true
schema:
type: string
- name: update_mask
in: query
description: An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped.
allowEmptyValue: false
style: form
explode: true
schema:
type: array
items:
type: string
enum:
- group_id
- label
- options
requestBody:
description: request
content:
application/json:
schema:
title: UpdateCustomFieldMetaDataRequest
required:
- group_id
type: object
properties:
group_id:
type: string
label:
type: string
options:
type: array
items:
title: CustomFieldOption
type: object
properties:
id:
type: string
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CustomFieldOption_3'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
title: CustomFieldMetaData
type: object
properties:
default_value:
type: string
field_name:
type: string
field_type:
type: string
enum:
- CURRENCY
- DATE
- DATE_TIME
- DAY_OF_WEEK
- DECIMAL_NUMBER
- DRILLDOWN
- DROPDOWN
- EMAIL
- LIST_BOX
- MONTH
- NAME
- PERCENT
- PHONE_NUMBER
- RADIO
- SOCIAL_SECURITY_NUMBER
- STATE
- TEXT
- TEXT_AREA
- USER
- USER_LIST_BOX
- WEBSITE
- WHOLE_NUMBER
- YEAR
- YES_NO
group_id:
type: string
id:
type: string
label:
type: string
options:
type: array
items:
title: CustomFieldOption
type: object
properties:
id:
type: string
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CustomFieldOption_3'
record_type:
type: string
enum:
- CONTACT
- REFERRAL_PARTNER
- OPPORTUNITY
- TASK_NOTE_APPOINTMENT
- COMPANY
- ORDER
- SUBSCRIPTION
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
x-codegen-request-body-name: request
servers:
- url: https://api.infusionsoft.com/crm/rest
/v2/tasks/{task_id}:
get:
tags:
- Task
summary: Retrieve a Task
description: Retrieves a single task
operationId: getTaskUsingGET_1
parameters:
- name: task_id
in: path
description: task_id
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
title: Task
type: object
properties:
assigned_to_user_id:
type: string
completed:
type: boolean
completion_time:
type: string
contact_id:
type: string
create_time:
type: string
description: On initial object the returned value for this property may not accurately represent the exact stored value.
created_by_user_id:
type: string
description:
type: string
due_time:
type: string
id:
type: string
modification_time:
type: string
priority:
type: string
enum:
- CRITICAL
- ESSENTIAL
- NONESSENTIAL
remind_time_mins:
type: integer
format: int32
title:
type: string
type:
type: string
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
delete:
tags:
- Task
summary: Delete a Task
description: Deletes a single task
operationId: deleteTaskUsingDELETE_1
parameters:
- name: task_id
in: path
description: task_id
required: true
schema:
type: string
responses:
'204':
description: No Content
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
patch:
tags:
- Task
summary: Update a Task
description: "Updates a task with only the values provided in the request. \nThis endpoint does not currently support updating Custom Field values."
operationId: updateTaskUsingPATCH
parameters:
- name: task_id
in: path
description: task_id
required: true
schema:
type: string
- name: update_mask
in: query
description: An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped.
allowEmptyValue: false
style: form
explode: true
schema:
type: array
items:
type: string
enum:
- id
- title
- description
- type
- priority
- completion_time
- due_time
- remind_time_mins
- assigned_to_user_id
- contact_id
- completed
requestBody:
description: task
content:
application/json:
schema:
title: CreateUpdateTaskRequest
type: object
properties:
assigned_to_user_id:
type: string
completed:
type: boolean
completion_time:
type: string
contact_id:
type: string
description:
type: string
due_time:
type: string
priority:
type: string
enum:
- CRITICAL
- ESSENTIAL
- NONESSENTIAL
remind_time_mins:
type: integer
description: Value in minutes before start_date to show pop-up reminder. Acceptable values are [5,10,15,30,60,120,240,480,1440,2880]
format: int32
title:
type: string
type:
type: string
required: false
responses:
'200':
description: OK
content:
application/json:
schema:
title: UpdateTaskResponse
type: object
properties:
assigned_to_user_id:
type: string
completed:
type: boolean
completion_time:
type: string
contact_id:
type: string
create_time:
type: string
description: On initial object the returned value for this property may not accurately represent the exact stored value.
created_by_user_id:
type: string
description:
type: string
due_time:
type: string
id:
type: string
modification_time:
type: string
priority:
type: string
enum:
- CRITICAL
- ESSENTIAL
- NONESSENTIAL
remind_time_mins:
type: integer
format: int32
title:
type: string
type:
type: string
'401':
description: Unauthorized
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'403':
description: Forbidden
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'404':
description: Not Found
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
'500':
description: Internal Server Error
content:
application/json:
schema:
title: Error
type: object
properties:
cause:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
deprecated: false
x-codegen-request-body-name: task
servers:
- url: https://api.infusionsoft.com/crm/rest
components:
schemas:
CustomFieldValueObject:
type: object
properties:
id:
type: string
content:
description: The value of the custom field. Text custom field values have a maximum length of 65535 characters.
UpdateCustomFieldTabRequest:
type: object
properties:
name:
type: string
order:
type: integer
format: int32
CreateCustomFieldGroupRequest:
type: object
properties:
name:
type: string
tab_id:
type: string
CustomFieldGroup:
type: object
properties:
id:
type: string
name:
type: string
order:
type: integer
format: int32
tab_id:
type: string
record_type:
type: string
enum:
- CONTACT
- REFERRAL_PARTNER
- OPPORTUNITY
- TASK_NOTE_APPOINTMENT
- COMPANY
- ORDER
- SUBSCRIPTION
CustomFieldOption:
type: object
properties:
id:
type: string
label:
type: string
CreateTaskRequest:
type: object
description: task
properties:
title:
type: string
description: Task title
example: Follow up on proposal
description:
type: string
description: Task description
example: Review client feedback
type:
type: string
description: Task type
example: CALL
priority:
type: string
description: Task priority
enum:
- CRITICAL
- ESSENTIAL
- NONESSENTIAL
example: ESSENTIAL
completed:
type: boolean
description: Whether task is completed
example: false
completion_time:
type: string
description: Completion timestamp (ISO-8601)
example: '2024-03-20T14:00:00Z'
due_time:
type: string
description: Due date/time (ISO-8601)
example: '2024-03-18T17:00:00Z'
remind_time_mins:
type: integer
format: int32
description: Value in minutes before start_date to show pop-up reminder.
enum:
- '5'
- '10'
- '15'
- '30'
- '60'
- '120'
- '240'
- '480'
- '1440'
- '2880'
example: 30
assigned_to_user_id:
type: string
description: Assigned user ID
example: 456
contact_id:
type: string
description: Associated contact ID
example: 1001
opportunity_id:
type: string
description: Associated opportunity ID
example: 553
accepted:
type: boolean
description: Whether the task has been accepted.
example: true
custom_fields:
type: array
description: Custom field values for the task. An empty array resets all custom fields to their defaults.
example:
- id: '1'
content: Red
items:
$ref: '#/components/schemas/CustomFieldValueObject'
required:
- assigned_to_user_id
UpdateTaskResponse:
type: object
properties:
id:
type: string
description: Task ID
example: 123
title:
type: string
description: Task title
example: Follow up on proposal
description:
type: string
description: Task description. Legacy XML-RPC name for this field was `CreationNotes`
example: Review and respond to client feedback.
type:
type: string
description: Task type
example: CALL
priority:
type: string
description: Task priority
enum:
- CRITICAL
- ESSENTIAL
- NONESSENTIAL
example: CRITICAL
completed:
type: boolean
description: Whether task is completed
example: false
create_time:
type: string
description: Creation timestamp (ISO-8601)
example: '2024-01-10T08:00:00Z'
modification_time:
type: string
description: Last modification timestamp (ISO-8601)
example: '2024-03-15T10:30:00Z'
completion_time:
type: string
description: Completion timestamp (ISO-8601)
example: '2024-03-20T14:00:00Z'
due_time:
type: string
description: Due date/time (ISO-8601)
example: '2024-03-18T17:00:00Z'
remind_time_mins:
type: integer
format: int32
description: Reminder minutes before due.
enum:
- '5'
- '10'
- '15'
- '30'
- '60'
- '120'
- '240'
- '480'
- '1440'
- '2880'
example: 30
assigned_to_user_id:
type: string
description: Assigned user ID
example: 456
created_by_user_id:
type: string
description: Creator user ID
example: 789
last_updated_by_user_id:
type: string
description: User who last updated the task.
example: 77
contact_id:
type: string
description: Associated contact ID
example: 1001
opportunity_id:
type: string
description: Associated opportunity ID
example: 321
accepted:
type: boolean
description: Whether the task has been accepted
example: true
custom_fields:
type: array
description: Custom field values for the task
example:
- id: '1'
content: Red
- id: '2'
content: Preferred
items:
$ref: '#/components/schemas/CustomFieldValueObject'
ListCustomFieldTabsResponse:
type: object
properties:
tabs:
type: array
items:
$ref: '#/components/schemas/CustomFieldTab'
UpdateCustomFieldGroupRequest:
type: object
properties:
name:
type: string
order:
type: integer
format: int32
tab_id:
type: string
CustomFieldTab:
type: object
properties:
id:
type: string
description: The unique identifier of the custom field tab
example: 123
name:
type: string
description: The name of the custom field tab
example: Personal Info
order:
type: integer
format: int32
description: The display order of the tab
example: 1
record_type:
type: string
description: The record type this tab belongs to (e.g., CONTACT, COMPANY, OPPORTUNITY, REFERRAL_PARTNER, ORDER, SUBSCRIPTION, TASK_NOTE_APPOINTMENT)
enum:
- CONTACT
- REFERRAL_PARTNER
- OPPORTUNITY
- TASK_NOTE_APPOINTMENT
- COMPANY
- ORDER
- SUBSCRIPTION
example: CONTACT
CreateUpdateTaskRequest:
type: object
description: task
properties:
title:
type: string
description: Task title
example: Follow up on proposal
description:
type: string
description: Task description
example: Review client feedback
type:
type: string
description: Task type
example: CALL
priority:
type: string
description: Task priority
enum:
- CRITICAL
- ESSENTIAL
- NONESSENTIAL
example: ESSENTIAL
completed:
type: boolean
description: Whether task is completed
example: false
completion_time:
type: string
description: Completion timestamp (ISO-8601)
example: '2024-03-20T14:00:00Z'
due_time:
type: string
description: Due date/time (ISO-8601)
example: '2024-03-18T17:00:00Z'
remind_time_mins:
type: integer
format: int32
description: Value in minutes before start_date to show pop-up reminder.
enum:
- '5'
- '10'
- '15'
- '30'
- '60'
- '120'
- '240'
- '480'
- '1440'
- '2880'
example: 30
assigned_to_user_id:
type: string
description: Assigned user ID
example: 456
contact_id:
type: string
description: Associated contact ID
example: 1001
opportunity_id:
type: string
description: Associated opportunity ID
example: 77
accepted:
type: boolean
description: Whether the task has been accepted. Defaults to false
example: true
custom_fields:
type: array
description: Custom field values for the task. An empty array resets all custom fields to their defaults.
example:
- id: '1'
content: Red
items:
$ref: '#/components/schemas/CustomFieldValueObject'
Error:
type: object
properties:
code:
type: integer
format: int32
message:
type: string
status:
type: string
details:
type: array
items:
$ref: '#/components/schemas/ErrorDetails'
CustomFieldMetaData:
type: object
description: Metadata describing a custom field, including its type and options
properties:
id:
type: string
description: The unique identifier of the custom field
example: 123
label:
type: string
description: The display label of the custom field
example: Favorite Color
options:
type: array
description: The list of available options for select/radio/multiselect/drilldown field types
items:
$ref: '#/components/schemas/CustomFieldOption'
record_type:
type: string
description: The entity type this custom field belongs to (e.g. CONTACT, COMPANY)
enum:
- CONTACT
- REFERRAL_PARTNER
- OPPORTUNITY
- TASK_NOTE_APPOINTMENT
- COMPANY
- ORDER
- SUBSCRIPTION
field_type:
type: string
description: The data type of the custom field (e.g. Text, Number, Date, Select)
enum:
- CURRENCY
- DATE
- DATE_TIME
- DAY_OF_WEEK
- DECIMAL_NUMBER
- DRILLDOWN
- DROPDOWN
- EMAIL
- LIST_BOX
- MONTH
- NAME
- PERCENT
- PHONE_NUMBER
- RADIO
- SOCIAL_SECURITY_NUMBER
- STATE
- TEXT
- TEXT_AREA
- USER
- USER_LIST_BOX
- WEBSITE
- WHOLE_NUMBER
- YEAR
- YES_NO
default_value:
type: string
description: The default value for this custom field, if any
group_id:
type: string
description: The ID of the group this custom field belongs to
example: 45
group_name:
type: string
description: The name of the group this custom field belongs to
example: Personal Info
field_name:
type: string
description: The database column name for this custom field. Use this value when filtering contacts (e.g. for field_name 'firstName1', filter with 'firstName1==John').
example: firstName1
CreateCustomFieldOptionRequest:
type: object
properties:
label:
type: string
CreateCustomFieldTabRequest:
type: object
properties:
name:
type: string
ObjectModel:
type: object
properties:
custom_fields:
type: array
items:
$ref: '#/components/schemas/CustomFieldMetaData'
optional_properties:
type: array
description: These fields are not transmitted by default on this model, but can be requested by specifying them in a comma-separated list in the optional_properties query parameter.
items:
type: string
uniqueItems: true
ErrorDetails:
type: object
properties:
domain:
type: string
resource:
type: string
ListTasksResponse:
type: object
properties:
tasks:
type: array
items:
$ref: '#/components/schemas/Task'
next_page_token:
type: string
Task:
type: object
properties:
id:
type: string
description: Task ID
example: 123
title:
type: string
description: Task title
example: Follow up on proposal
description:
type: string
description: Task description. Legacy XML-RPC name for this field was `CreationNotes`
example: Review and respond to client feedback.
type:
type: string
description: Task type
example: CALL
priority:
type: string
description: Task priority
enum:
- CRITICAL
- ESSENTIAL
- NONESSENTIAL
example: CRITICAL
completed:
type: boolean
description: Whether task is completed
example: false
create_time:
type: string
description: Creation timestamp (ISO-8601)
example: '2024-01-10T08:00:00Z'
modification_time:
type: string
description: Last modification timestamp (ISO-8601)
example: '2024-03-15T10:30:00Z'
completion_time:
type: string
description: Completion timestamp (ISO-8601)
example: '2024-03-20T14:00:00Z'
due_time:
type: string
description: Due date/time (ISO-8601)
example: '2024-03-18T17:00:00Z'
remind_time_mins:
type: integer
format: int32
description: Reminder minutes before due.
enum:
- '5'
- '10'
- '15'
- '30'
- '60'
- '120'
- '240'
- '480'
- '1440'
- '2880'
example: 30
assigned_to_user_id:
type: string
description: Assigned user ID
example: 456
created_by_user_id:
type: string
description: Creator user ID
example: 789
last_updated_by_user_id:
type: string
description: User who last updated the task.
example: 77
contact_id:
type: string
description: Associated contact ID
example: 1001
opportunity_id:
type: string
description: Associated opportunity ID
example: 321
accepted:
type: boolean
description: Whether the task has been accepted
example: true
custom_fields:
type: array
description: Custom field values for the task
example:
- id: '1'
content: Red
- id: '2'
content: Preferred
items:
$ref: '#/components/schemas/CustomFieldValueObject'
CreateCustomFieldRequest:
type: object
properties:
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CreateCustomFieldOptionRequest'
field_type:
type: string
enum:
- CURRENCY
- DATE
- DATE_TIME
- DAY_OF_WEEK
- DECIMAL_NUMBER
- DRILLDOWN
- DROPDOWN
- EMAIL
- LIST_BOX
- MONTH
- NAME
- PERCENT
- PHONE_NUMBER
- RADIO
- SOCIAL_SECURITY_NUMBER
- STATE
- TEXT
- TEXT_AREA
- USER
- USER_LIST_BOX
- WEBSITE
- WHOLE_NUMBER
- YEAR
- YES_NO
group_id:
type: string
description: An optional tab group to place the field under in the interface. If not specified, will default to the 'Custom Fields' tab.
user_group_id:
type: string
description: An optional user group to choose from when selecting values for User or UserListBox fields.
required:
- field_type
- label
UpdateCustomFieldMetaDataRequest:
type: object
properties:
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CustomFieldOption'
group_id:
type: string
required:
- group_id
ListCustomFieldGroupsResponse:
type: object
properties:
groups:
type: array
items:
$ref: '#/components/schemas/CustomFieldGroup'
CreateCustomFieldResponse:
type: object
properties:
custom_field:
$ref: '#/components/schemas/CustomFieldMetaData'
CustomFieldOption_2:
title: CustomFieldOption
type: object
properties:
id:
type: string
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CustomFieldOption_2'
CreateRestCustomFieldOption:
title: CreateRestCustomFieldOption
type: object
properties:
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CreateRestCustomFieldOption'
Throwable:
title: Throwable
type: object
properties:
cause:
$ref: '#/components/schemas/Throwable'
localizedMessage:
type: string
message:
type: string
stackTrace:
type: array
items:
title: StackTraceElement
type: object
properties:
classLoaderName:
type: string
className:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
methodName:
type: string
moduleName:
type: string
moduleVersion:
type: string
nativeMethod:
type: boolean
suppressed:
type: array
items:
$ref: '#/components/schemas/Throwable'
TaskList:
type: object
properties:
tasks:
type: array
items:
$ref: '#/components/schemas/Task_2'
count:
type: integer
format: int32
next:
type: string
previous:
type: string
sync_token:
type: string
ObjectModel_2:
type: object
properties:
custom_fields:
type: array
items:
$ref: '#/components/schemas/CustomFieldMetaData_2'
optional_properties:
type: array
items:
type: string
uniqueItems: true
CustomFieldMetaData_2:
type: object
properties:
id:
type: integer
format: int64
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CustomFieldOption'
record_type:
type: string
enum:
- CONTACT
- REFERRAL_PARTNER
- OPPORTUNITY
- TASK_NOTE_APPOINTMENT
- COMPANY
- ORDER
- SUBSCRIPTION
field_type:
type: string
enum:
- Currency
- Date
- DateTime
- DayOfWeek
- Drilldown
- Email
- Month
- ListBox
- Name
- WholeNumber
- DecimalNumber
- Percent
- PhoneNumber
- Radio
- Dropdown
- SocialSecurityNumber
- State
- Text
- TextArea
- User
- UserListBox
- Website
- Year
- YesNo
field_name:
type: string
default_value:
type: string
DefaultHttpStatusCode:
allOf:
- $ref: '#/components/schemas/HttpStatusCode'
BasicContact:
type: object
properties:
id:
type: integer
format: int64
email:
type: string
first_name:
type: string
last_name:
type: string
ModelAndView:
type: object
properties:
view:
$ref: '#/components/schemas/View'
model:
type: object
additionalProperties: {}
status:
oneOf:
- $ref: '#/components/schemas/DefaultHttpStatusCode'
- $ref: '#/components/schemas/HttpStatus'
modelMap:
type: object
additionalProperties: {}
properties:
empty:
type: boolean
reference:
type: boolean
empty:
type: boolean
viewName:
type: string
HttpStatusCode:
type: object
properties:
error:
type: boolean
is1xxInformational:
type: boolean
is2xxSuccessful:
type: boolean
is3xxRedirection:
type: boolean
is4xxClientError:
type: boolean
is5xxServerError:
type: boolean
HttpStatus:
allOf:
- $ref: '#/components/schemas/HttpStatusCode'
enum:
- 100 CONTINUE
- 101 SWITCHING_PROTOCOLS
- 102 PROCESSING
- 103 EARLY_HINTS
- 200 OK
- 201 CREATED
- 202 ACCEPTED
- 203 NON_AUTHORITATIVE_INFORMATION
- 204 NO_CONTENT
- 205 RESET_CONTENT
- 206 PARTIAL_CONTENT
- 207 MULTI_STATUS
- 208 ALREADY_REPORTED
- 226 IM_USED
- 300 MULTIPLE_CHOICES
- 301 MOVED_PERMANENTLY
- 302 FOUND
- 303 SEE_OTHER
- 304 NOT_MODIFIED
- 307 TEMPORARY_REDIRECT
- 308 PERMANENT_REDIRECT
- 400 BAD_REQUEST
- 401 UNAUTHORIZED
- 402 PAYMENT_REQUIRED
- 403 FORBIDDEN
- 404 NOT_FOUND
- 405 METHOD_NOT_ALLOWED
- 406 NOT_ACCEPTABLE
- 407 PROXY_AUTHENTICATION_REQUIRED
- 408 REQUEST_TIMEOUT
- 409 CONFLICT
- 410 GONE
- 411 LENGTH_REQUIRED
- 412 PRECONDITION_FAILED
- 413 CONTENT_TOO_LARGE
- 413 PAYLOAD_TOO_LARGE
- 414 URI_TOO_LONG
- 415 UNSUPPORTED_MEDIA_TYPE
- 416 REQUESTED_RANGE_NOT_SATISFIABLE
- 417 EXPECTATION_FAILED
- 418 I_AM_A_TEAPOT
- 421 MISDIRECTED_REQUEST
- 422 UNPROCESSABLE_CONTENT
- 422 UNPROCESSABLE_ENTITY
- 423 LOCKED
- 424 FAILED_DEPENDENCY
- 425 TOO_EARLY
- 426 UPGRADE_REQUIRED
- 428 PRECONDITION_REQUIRED
- 429 TOO_MANY_REQUESTS
- 431 REQUEST_HEADER_FIELDS_TOO_LARGE
- 451 UNAVAILABLE_FOR_LEGAL_REASONS
- 500 INTERNAL_SERVER_ERROR
- 501 NOT_IMPLEMENTED
- 502 BAD_GATEWAY
- 503 SERVICE_UNAVAILABLE
- 504 GATEWAY_TIMEOUT
- 505 HTTP_VERSION_NOT_SUPPORTED
- 506 VARIANT_ALSO_NEGOTIATES
- 507 INSUFFICIENT_STORAGE
- 508 LOOP_DETECTED
- 509 BANDWIDTH_LIMIT_EXCEEDED
- 510 NOT_EXTENDED
- 511 NETWORK_AUTHENTICATION_REQUIRED
CreateRestCustomField:
type: object
properties:
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CreateRestCustomFieldOption_2'
field_type:
type: string
enum:
- Currency
- Date
- DateTime
- DayOfWeek
- Drilldown
- Email
- Month
- ListBox
- Name
- WholeNumber
- DecimalNumber
- Percent
- PhoneNumber
- Radio
- Dropdown
- SocialSecurityNumber
- State
- Text
- TextArea
- User
- UserListBox
- Website
- Year
- YesNo
group_id:
type: integer
format: int64
description: An optional tab group to place the field under in the interface. If not specified, will default to the 'Custom Fields' tab.
user_group_id:
type: integer
format: int64
description: An optional user group to choose from when selecting values for User or UserListBox fields.
required:
- field_type
- label
Task_2:
type: object
properties:
title:
type: string
description:
type: string
type:
type: string
priority:
type: integer
format: int32
completed:
type: boolean
contact:
$ref: '#/components/schemas/BasicContact'
url:
type: string
due_date:
type: string
format: date-time
creation_date:
type: string
format: date-time
modification_date:
type: string
format: date-time
completion_date:
type: string
format: date-time
remind_time:
type: integer
format: int32
description: "Value in minutes before start_date to show pop-up reminder. \nAcceptable values are in [`5`,`10`,`15`,`30`,`60`,`120`,`240`,`480`,`1440`,`2880`]"
user_id:
type: integer
format: int64
funnel_id:
type: integer
format: int64
jgraph_id:
type: integer
format: int64
CreateRestCustomFieldOption_2:
type: object
properties:
label:
type: string
View:
type: object
properties:
contentType:
type: string
TaskSearchCommand:
type: object
properties:
since:
type: string
until:
type: string
completed:
type: boolean
limit:
type: integer
format: int32
offset:
type: integer
format: int32
order:
type: string
sinceAsDate:
type: string
format: date-time
untilAsDate:
type: string
format: date-time
TaskList_2:
type: object
properties:
tasks:
type: array
items:
$ref: '#/components/schemas/Task_3'
count:
type: integer
format: int32
next:
type: string
previous:
type: string
sync_token:
type: string
ObjectModel_3:
type: object
properties:
custom_fields:
type: array
items:
$ref: '#/components/schemas/CustomFieldMetaData_3'
optional_properties:
type: array
items:
type: string
uniqueItems: true
CustomFieldMetaData_3:
type: object
properties:
id:
type: integer
format: int64
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CustomFieldOption'
record_type:
type: string
enum:
- CONTACT
- REFERRAL_PARTNER
- OPPORTUNITY
- TASK_NOTE_APPOINTMENT
- COMPANY
- ORDER
- SUBSCRIPTION
field_type:
type: string
enum:
- Currency
- Date
- DateTime
- DayOfWeek
- Drilldown
- Email
- Month
- ListBox
- Name
- WholeNumber
- DecimalNumber
- Percent
- PhoneNumber
- Radio
- Dropdown
- SocialSecurityNumber
- State
- Text
- TextArea
- User
- UserListBox
- Website
- Year
- YesNo
field_name:
type: string
default_value:
type: string
CreateRestCustomField_2:
type: object
properties:
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CreateRestCustomFieldOption_3'
field_type:
type: string
enum:
- Currency
- Date
- DateTime
- DayOfWeek
- Drilldown
- Email
- Month
- ListBox
- Name
- WholeNumber
- DecimalNumber
- Percent
- PhoneNumber
- Radio
- Dropdown
- SocialSecurityNumber
- State
- Text
- TextArea
- User
- UserListBox
- Website
- Year
- YesNo
group_id:
type: integer
format: int64
description: An optional tab group to place the field under in the interface. If not specified, will default to the 'Custom Fields' tab.
user_group_id:
type: integer
format: int64
description: An optional user group to choose from when selecting values for User or UserListBox fields.
required:
- field_type
- label
Task_3:
type: object
properties:
title:
type: string
description:
type: string
type:
type: string
priority:
type: integer
format: int32
completed:
type: boolean
contact:
$ref: '#/components/schemas/BasicContact'
url:
type: string
due_date:
type: string
format: date-time
creation_date:
type: string
format: date-time
modification_date:
type: string
format: date-time
completion_date:
type: string
format: date-time
remind_time:
type: integer
format: int32
description: "Value in minutes before start_date to show pop-up reminder. \nAcceptable values are in [`5`,`10`,`15`,`30`,`60`,`120`,`240`,`480`,`1440`,`2880`]"
user_id:
type: integer
format: int64
funnel_id:
type: integer
format: int64
jgraph_id:
type: integer
format: int64
CreateRestCustomFieldOption_3:
type: object
properties:
label:
type: string
CreateCustomFieldOptionRequest_2:
title: CreateCustomFieldOptionRequest
type: object
properties:
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CreateCustomFieldOptionRequest_2'
CustomFieldOption_3:
title: CustomFieldOption
type: object
properties:
id:
type: string
label:
type: string
options:
type: array
items:
$ref: '#/components/schemas/CustomFieldOption_3'
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://accounts.infusionsoft.com/app/oauth/authorize
tokenUrl: https://api.infusionsoft.com/token
scopes: {}
x-refined-from:
- infusionsoft-keap-sdk-v2-swagger-original.yml
- infusionsoft-rest-v1-2025-11-05-openapi-original.json
- infusionsoft-rest-v1-openapi-original.json
- infusionsoft-rest-v1-openapi.json
- infusionsoft-rest-v2-2025-11-05-openapi-original.json
- infusionsoft-rest-v2-openapi-original.json
- infusionsoft-rest-v2-openapi.json