find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/highlevel:highlevel-recurring-tasks-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Sub-Account (Formerly location) Recurring Tasks API
  description: Documentation for Sub-Account (Formerly location) API
  version: '1.0'
  contact: {}
servers:
- url: https://services.leadconnectorhq.com
tags:
- name: Recurring Tasks
  description: Documentation for Sub-Account (Formerly location) API
paths:
  /locations/{locationId}/recurring-tasks/{id}:
    get:
      operationId: get-recurring-task-by-id
      summary: Get Recurring Task By Id
      parameters:
      - name: Version
        in: header
        description: API Version
        required: true
        schema:
          type: string
          enum:
          - '2021-07-28'
      - name: id
        required: true
        in: path
        description: Recurring Task Id
        schema:
          example: sx6wyHhbFdRXh302Lunr
          type: string
      - name: locationId
        required: true
        in: path
        description: Location Id
        schema:
          example: sx6wyHhbFdRXh302Lunr
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecurringTaskSingleResponseDTO'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/BadRequestDTO
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/UnauthorizedDTO
      tags:
      - Recurring Tasks
      security:
      - bearer: []
    put:
      operationId: update-recurring-task
      summary: Update Recurring Task
      parameters:
      - name: Version
        in: header
        description: API Version
        required: true
        schema:
          type: string
          enum:
          - '2021-07-28'
      - name: id
        required: true
        in: path
        description: Recurring Task Id
        schema:
          example: sx6wyHhbFdRXh302Lunr
          type: string
      - name: locationId
        required: true
        in: path
        description: Location Id
        schema:
          example: sx6wyHhbFdRXh302Lunr
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecurringTaskUpdateDTO'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecurringTaskSingleResponseDTO'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/BadRequestDTO
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/UnauthorizedDTO
      tags:
      - Recurring Tasks
      security:
      - bearer: []
    delete:
      operationId: delete-recurring-task
      summary: Delete Recurring Task
      parameters:
      - name: Version
        in: header
        description: API Version
        required: true
        schema:
          type: string
          enum:
          - '2021-07-28'
      - name: id
        required: true
        in: path
        description: Recurring Task Id
        schema:
          example: sx6wyHhbFdRXh302Lunr
          type: string
      - name: locationId
        required: true
        in: path
        description: Location Id
        schema:
          example: sx6wyHhbFdRXh302Lunr
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteRecurringTaskResponseDTO'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/BadRequestDTO
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/UnauthorizedDTO
      tags:
      - Recurring Tasks
      security:
      - bearer: []
  /locations/{locationId}/recurring-tasks:
    post:
      operationId: create-recurring-task
      summary: Create Recurring Task
      parameters:
      - name: Version
        in: header
        description: API Version
        required: true
        schema:
          type: string
          enum:
          - '2021-07-28'
      - name: locationId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecurringTaskCreateDTO'
      responses:
        '201':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecurringTaskSingleResponseDTO'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/BadRequestDTO
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/UnauthorizedDTO
      tags:
      - Recurring Tasks
      security:
      - bearer: []
components:
  schemas:
    DeleteRecurringTaskResponseDTO:
      type: object
      properties:
        id:
          type: string
          example: sx6wyHhbFdRXh302Lunr
          description: Recurring Task Id
        success:
          type: boolean
          example: true
          description: Success
      required:
      - id
      - success
    CustomRRulesOptions:
      type: object
      properties:
        intervalType:
          type: string
          enum:
          - yearly
          - monthly
          - weekly
          - daily
          - hourly
          example: monthly
        interval:
          type: number
          example: 2
        startDate:
          type: string
          example: '2021-09-30T00:00:00.000Z'
          description: Start Date
        endDate:
          type: string
          example: '2021-09-30T00:00:00.000Z'
          description: End Date
        dayOfMonth:
          type: number
          description: 1, 2, 3, ..., 27, 31
          example: 15
        dayOfWeek:
          type: string
          enum:
          - MO
          - TU
          - WE
          - TH
          - FR
          - SA
          - SU
          example: MO
        monthOfYear:
          type: number
          description: 1, 2, ....., 11, 12
          example: 1
        count:
          type: number
          description: Max number of task executions
          example: 10
        createTaskIfOverDue:
          type: boolean
          example: true
          description: Create Task If Over Due
        dueAfterSeconds:
          type: number
          example: 23404000
          description: Due after seconds
      required:
      - intervalType
      - interval
      - startDate
      - dueAfterSeconds
    RecurringTaskUpdateDTO:
      type: object
      properties:
        title:
          type: string
          example: Task Name
          description: Name of the task
        description:
          type: string
          example: Task Description
          description: Description of the task
        contactIds:
          example:
          - sx6wyHhbFdRXh302Lunr
          description: Contact Id
          type: array
          items:
            type: string
        owners:
          example:
          - sx6wyHhbFdRXh302Lunr
          description: Assigned To
          type: array
          items:
            type: string
        rruleOptions:
          example:
            intervalType: hourly
            interval: 1
            startDate: '2025-07-23T10:00:00.000Z'
            dueAfterSeconds: 600
          description: Recurring rules
          allOf:
          - $ref: '#/components/schemas/CustomRRulesOptions'
        ignoreTaskCreation:
          type: boolean
          example: true
          description: Create initial task or not
    RecurringTaskCreateDTO:
      type: object
      properties:
        title:
          type: string
          example: Task Name
          description: Name of the task
        description:
          type: string
          example: Task Description
          description: Description of the task
        contactIds:
          example:
          - sx6wyHhbFdRXh302Lunr
          description: Contact Id
          type: array
          items:
            type: string
        owners:
          example:
          - sx6wyHhbFdRXh302Lunr
          description: Assigned To
          type: array
          items:
            type: string
        rruleOptions:
          example:
            intervalType: hourly
            interval: 1
            startDate: '2025-07-23T10:00:00.000Z'
            dueAfterSeconds: 600
          description: Recurring rules
          allOf:
          - $ref: '#/components/schemas/CustomRRulesOptions'
        ignoreTaskCreation:
          type: boolean
          example: true
          description: Create initial task or not
      required:
      - title
      - rruleOptions
    RecurringTaskSingleResponseDTO:
      type: object
      properties:
        recurringTask:
          description: Recurring Tasks
          allOf:
          - $ref: '#/components/schemas/RecurringTaskResponseDTO'
      required:
      - recurringTask
    RecurringTaskResponseDTO:
      type: object
      properties:
        id:
          type: string
          example: sx6wyHhbFdRXh302Lunr
          description: Recurring Task Id
        title:
          type: string
          example: Task Name
          description: Name of the task
        description:
          type: string
          example: Task Description
          description: Description of the task
        locationId:
          type: string
          example: sx6wyHhbFdRXh302Lunr
          description: Location Id
        updatedAt:
          type: string
          example: '2021-04-15T10:00:00.000Z'
          description: Updated At
        createdAt:
          type: string
          example: '2021-04-15T10:00:00.000Z'
          description: Created At
        rruleOptions:
          example:
            createTaskIfOverDue: false
            interval: 1
            intervalType: hourly
            startDate: '2024-10-29T12:34:03.000Z'
            dueAfterSeconds: 600
            count: 550
          description: Recurring rules
          allOf:
          - $ref: '#/components/schemas/CustomRRulesOptions'
        totalOccurrence:
          type: number
          example: 10
          description: Total Occurrence
        deleted:
          type: boolean
          example: false
          description: Deleted
        assignedTo:
          type: string
          example: sx6wyHhbFdRXh302Lunr
          description: Assigned To
        contactId:
          type: string
          example: v5cEPM428h8vShlRW1KT
          description: Contact Id
      required:
      - id
      - title
      - description
      - locationId
      - updatedAt
      - createdAt
      - rruleOptions
      - totalOccurrence
      - deleted
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      name: Authorization
      in: header
      description: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
      type: http
    Location-Access:
      scheme: bearer
      bearerFormat: JWT
      name: Authorization
      in: header
      description: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
      type: http
    Location-Access-Only:
      scheme: bearer
      bearerFormat: JWT
      name: Authorization
      in: header
      description: Use the Access Token generated with user type as Sub-Account.
      type: http
    Agency-Access:
      scheme: bearer
      bearerFormat: JWT
      name: Authorization
      in: header
      description: Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.
      type: http
x-tagGroups:
  name: Sub-Account (Formerly location)
  tags:
  - Location
  - Location Tags
  - Custom Field
  - Custom Value
  - Template
  - Tags Search
  - Location Notes
  - Location Tasks
  - Recurring Tasks
  - Location Search
  - Custom Field Search
  - Location Keys
  - Labs
  - Conversation Channel
  - Search
  - Sub-Account (Formerly Location)
  - Tags
  - Tasks Search
  - Timezone
  - ElasticSearch