Sign in
Basic

Retrieve task series

Changed on

Retrieve details of a specific task series using its unique identifier. This endpoint allows you to access the properties and series information associated with the specified taskId. It's useful for obtaining detailed information about a task series, including any custom properties.

get/crm/task-series/2026-09/{taskId}

Request

  • Base URL: https://api.hubapi.com
  • URL: https://api.hubapi.com/crm/task-series/2026-09/{taskId}
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: crm.objects.deals.highly_sensitive.read.v2)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: crm.objects.companies.highly_sensitive.read.v2)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: crm.objects.projects.sensitive.read)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: crm.objects.goals.read)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: crm.objects.deals.read)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: crm.objects.line_items.read)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: crm.objects.services.read)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: crm.objects.deals.sensitive.read.v2)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: tickets.highly_sensitive.v2)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: crm.objects.contacts.read)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: crm.objects.projects.highly_sensitive.read)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: crm.objects.courses.read)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: tickets.sensitive.v2)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: crm.objects.companies.read)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: crm.objects.contacts.highly_sensitive.read.v2)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: crm.objects.listings.read)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: crm.objects.appointments.sensitive.read.v2)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: crm.objects.appointments.read)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: crm.objects.contacts.sensitive.read.v2)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: crm.objects.products.read)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: crm.objects.projects.read)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: crm.objects.companies.sensitive.read.v2)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: crm.schemas.tasks.read)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: crm.objects.tasks.read)

Path parameters

taskIdinteger required

The unique identifier of the task series to retrieve. This is required to specify which task series you are interested in.

Query parameters

propertiesstring[]

A comma-separated list of property names to include in the response. This allows you to specify which properties of the task series you want to retrieve.

Response

successful operation

createdAtstring date-time

The date and time when the task series was created, in ISO 8601 format.

idstring required

The unique identifier for the task series, represented as a string.

propertiesobject required

A map of custom property names to their values, where each value is a string.

updatedAtstring date-time

The date and time when the task series was last updated, in ISO 8601 format.

Example response

{
  "series": {
    "repeatInterval": "RRULE:FREQ=WEEKLY;BYDAY=MO,WE,FR"
  }
}

Changes

  • 2026-09505bb3014904Revision changes
    • ○

      the security scope crm.objects.deals.highly_sensitive.read.v2 was added to the endpoint's security scheme oauth2

    • ○

      the security scope crm.objects.tasks.read was removed from the endpoint's security scheme oauth2

  • 2026-09c3e71e808c64Revision changes
    • ○

      the security scope crm.objects.deals.highly_sensitive.read.v2 was added to the endpoint's security scheme oauth2

    • ○

      the security scope crm.objects.tasks.read was removed from the endpoint's security scheme oauth2