> ## Documentation Index
> Fetch the complete documentation index at: https://br.developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# List
> Read a page of tasks. Control what is returned via the `properties` query param.
export const ScopesList = ({scopes = [], description = "Esta API requer um dos seguintes escopos:"}) => {
if (!scopes || scopes.length === 0) {
return null;
}
const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
return
;
};
## OpenAPI
````yaml specs/legacy/v3/crm-tasks-v3.json GET /crm/v3/objects/tasks
openapi: 3.0.1
info:
title: Tasks
description: >-
CRM objects such as companies, contacts, deals, line items, products,
tickets, and quotes are standard objects in HubSpot’s CRM. These core
building blocks support custom properties, store critical information, and
play a central role in the HubSpot application.
## Supported Object Types
This API provides access to collections of CRM objects, which return a map
of property names to values. Each object type has its own set of default
properties, which can be found by exploring the [CRM Object Properties
API](https://developers.hubspot.com/docs/methods/crm-properties/crm-properties-overview).
|Object Type |Properties returned by default |
|--|--|
| `companies` | `name`, `domain` |
| `contacts` | `firstname`, `lastname`, `email` |
| `deals` | `dealname`, `amount`, `closedate`, `pipeline`, `dealstage` |
| `products` | `name`, `description`, `price` |
| `tickets` | `content`, `hs_pipeline`, `hs_pipeline_stage`,
`hs_ticket_category`, `hs_ticket_priority`, `subject` |
Find a list of all properties for an object type using the [CRM Object
Properties](https://developers.hubspot.com/docs/methods/crm-properties/get-properties)
API. e.g. `GET https://api.hubapi.com/properties/v2/companies/properties`.
Change the properties returned in the response using the `properties` array
in the request body.
version: v3
x-hubspot-product-tier-requirements:
marketing: FREE
sales: FREE
service: FREE
cms: FREE
commerce: FREE
crmHub: FREE
dataHub: FREE
x-hubspot-api-use-case: >-
If you're using a third-party service for project management, you can create
and manage any tasks associated with your CRM records by logging them in
HubSpot.
x-hubspot-related-documentation:
- name: Tasks Guide
url: https://developers.hubspot.com/docs/guides/api/crm/engagements/tasks
x-hubspot-introduction: >-
Use the tasks API to associate tasks with your CRM records. You can assign
tasks to specific users in your account, keep track of their status, and
organize them using different priorities and types.
servers:
- url: https://api.hubapi.com
security: []
tags:
- name: Basic
- name: Batch
- name: Search
paths:
/crm/v3/objects/tasks:
get:
tags:
- Basic
summary: List
description: >-
Read a page of tasks. Control what is returned via the `properties`
query param.
operationId: get-/crm/v3/objects/tasks_getPage
parameters:
- name: after
in: query
description: >-
The paging cursor token of the last successfully read resource will
be returned as the `paging.next.after` JSON property of a paged
response containing more results.
required: false
style: form
explode: true
schema:
type: string
- name: archived
in: query
description: Whether to return only results that have been archived.
required: false
style: form
explode: true
schema:
type: boolean
default: false
- name: associations
in: query
description: >-
A comma separated list of object types to retrieve associated IDs
for. If any of the specified associations do not exist, they will be
ignored.
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: limit
in: query
description: The maximum number of results to display per page.
required: false
style: form
explode: true
schema:
type: integer
format: int32
default: 10
- name: properties
in: query
description: >-
A comma separated list of the properties to be returned in the
response. If any of the specified properties are not present on the
requested object(s), they will be ignored.
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: propertiesWithHistory
in: query
description: >-
A comma separated list of the properties to be returned along with
their history of previous values. If any of the specified properties
are not present on the requested object(s), they will be ignored.
Usage of this parameter will reduce the maximum number of objects
that can be read by a single request.
required: false
style: form
explode: true
schema:
type: array
items:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: >-
#/components/schemas/CollectionResponseSimplePublicObjectWithAssociationsForwardPaging
default:
$ref: '#/components/responses/Error'
description: ''
security: []
components:
schemas:
CollectionResponseSimplePublicObjectWithAssociationsForwardPaging:
required:
- results
type: object
properties:
paging:
$ref: '#/components/schemas/ForwardPaging'
results:
type: array
description: >-
An array of simple public objects that are included in the current
page of the response. Each object may include its associated data.
items:
$ref: '#/components/schemas/SimplePublicObjectWithAssociations'
description: >-
Represents a paginated collection response that includes simple public
objects with their associations. This component is used to handle the
results and pagination details when retrieving a list of objects from
the API.
ForwardPaging:
type: object
properties:
next:
$ref: '#/components/schemas/NextPage'
description: >-
Paging information for forward-only pagination. Contains the next page
reference when more results are available; omitted or empty on the last
page.
SimplePublicObjectWithAssociations:
required:
- archived
- createdAt
- id
- properties
- updatedAt
type: object
properties:
archived:
type: boolean
description: Whether the object is archived.
archivedAt:
type: string
description: The timestamp when the object was archived, in ISO 8601 format.
format: date-time
associations:
type: object
additionalProperties:
$ref: '#/components/schemas/CollectionResponseAssociatedId'
description: A map of associated object types to their associated IDs.
createdAt:
type: string
description: The timestamp when the object was created, in ISO 8601 format.
format: date-time
id:
type: string
description: The unique ID of the object.
objectWriteTraceId:
type: string
description: >-
An identifier used for tracing the creation or update request of the
object.
properties:
type: object
additionalProperties:
type: string
description: Key value pairs representing the properties of the object.
propertiesWithHistory:
type: object
additionalProperties:
type: array
items:
$ref: '#/components/schemas/ValueWithTimestamp'
description: >-
Key-value pairs representing the properties of the object along with
their history.
updatedAt:
type: string
description: The timestamp when the object was last updated, in ISO 8601 format.
format: date-time
url:
type: string
description: The URL link to access this object.
warnings:
type: array
items:
$ref: '#/components/schemas/PublicObjectWarning'
description: >-
Represents a CRM object along with its properties, timestamps, and a set
of associated object IDs grouped by association type.
Error:
required:
- category
- correlationId
- message
type: object
properties:
category:
type: string
description: The error category
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Context about the error condition
example: >-
{invalidPropertyName=[propertyValue], missingScopes=[scope1,
scope2]}
correlationId:
type: string
description: >-
A unique identifier for the request. Include this value with any
error reports or support tickets
format: uuid
example: aeb5f871-7f07-4993-9211-075dc63e7cbf
errors:
type: array
description: further information about the error
items:
$ref: '#/components/schemas/ErrorDetail'
links:
type: object
additionalProperties:
type: string
description: >-
A map of link names to associated URIs containing documentation
about the error or recommended remediation steps
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate
example: An error occurred
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error
description: >-
Represents an error response returned by the API when an operation
fails. This component is used in various endpoints to provide detailed
information about the error encountered.
example:
message: Invalid input (details will vary based on the error)
correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
category: VALIDATION_ERROR
links:
knowledge-base: https://www.hubspot.com/products/service/knowledge-base
NextPage:
required:
- after
type: object
properties:
after:
type: string
description: A paging cursor token for retrieving subsequent pages.
link:
type: string
description: A URL that can be used to retrieve the next page results.
description: >-
Specifies the paging information needed to retrieve the next set of
results in a paginated API response
example:
after: NTI1Cg%3D%3D
link: '?after=NTI1Cg%3D%3D'
CollectionResponseAssociatedId:
required:
- results
type: object
properties:
paging:
$ref: '#/components/schemas/Paging'
results:
type: array
description: A list of associated IDs retrieved from the API request.
items:
$ref: '#/components/schemas/AssociatedId'
description: >-
Represents a collection of associated IDs returned by an API request,
including pagination details for navigating through the results.
ValueWithTimestamp:
required:
- sourceType
- timestamp
- value
type: object
properties:
sourceId:
type: string
description: A string identifier for the specific source of the value.
sourceLabel:
type: string
description: A human-readable label.
sourceType:
type: string
description: >-
A string indicating the type of source from which the value
originated.
timestamp:
type: string
description: The timestamp when the property was updated, in ISO 8601 format.
format: date-time
updatedByUserId:
type: integer
description: The ID of the user who last updated the property.
format: int32
value:
type: string
description: The property value.
description: Property model that includes timestamp.
PublicObjectWarning:
required:
- category
- context
- message
type: object
properties:
category:
type: string
description: >-
The classification of the warning, indicating the type or nature of
the issue.
context:
type: object
additionalProperties:
type: string
description: >-
Additional information or metadata about the warning, providing
context for understanding the issue.
message:
type: string
description: >-
The text of the warning message, providing information about the
issue or alert.
description: >-
Represents a warning message related to a public object in HubSpot,
providing details about the nature and context of the warning.
ErrorDetail:
required:
- message
type: object
properties:
code:
type: string
description: The status code associated with the error detail
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Context about the error condition
example: '{missingScopes=[scope1, scope2]}'
in:
type: string
description: The name of the field or parameter in which the error was found.
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error
description: >-
Represents detailed information about an error that occurred in the API.
This component is used to provide additional context and specifics about
errors, typically as part of an error response.
Paging:
type: object
properties:
next:
$ref: '#/components/schemas/NextPage'
prev:
$ref: '#/components/schemas/PreviousPage'
description: >-
Represents the pagination information for navigating through a list of
results in the API. It provides details on how to access the previous or
next set of results.
AssociatedId:
required:
- id
- type
type: object
properties:
id:
type: string
description: The unique identifier for the associated object.
type:
type: string
description: The type of associations.
example: deal_to_contact
description: Contains the id and type of an association
PreviousPage:
required:
- before
type: object
properties:
before:
type: string
description: A paging cursor token for retrieving previous pages.
link:
type: string
description: A URL that can be used to retrieve the previous pages' results.
description: >-
specifies the paging information needed to retrieve the previous set of
results in a paginated API response
responses:
Error:
description: An error occurred.
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
````
{product.name} -
{product.level}
)}