How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HighLevel Schedule API

Documentation for invoice API

HighLevel Schedule API is one of 117 APIs that HighLevel publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 60 JSON Schema definitions.

Tagged areas include Schedule. The published artifact set on APIs.io includes an OpenAPI specification and 60 JSON Schemas.

This API exposes 9 operations across 6 paths, and defines 40 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://services.leadconnectorhq.com.

9 operations 6 paths 40 schemas 1 DELETE2 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.gohighlevel.com
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 5

HighLevel Schedule API declares 5 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer). It accepts HTTP bearer tokens (JWT) (Location-Access). It accepts HTTP bearer tokens (JWT) (Location-Access-Only). It accepts HTTP bearer tokens (JWT) (Agency-Access). It accepts HTTP bearer tokens (JWT) (Agency-Access-Only).

  • bearer — Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
  • Location-Access — Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
  • Location-Access-Only — Use the Access Token generated with user type as Sub-Account.
  • Agency-Access — Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.
  • Agency-Access-Only — Use the Access Token generated with user type as Agency.

Paths & Operations 9

Across 6 paths, the API surfaces 9 operations — 1 DELETE, 2 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Schedule 9

Documentation for invoice API

POST
/invoices/schedule
Create Invoice Schedule
create-invoice-schedule 1 param body → 200400401422
GET
/invoices/schedule
List schedules
list-invoice-schedules 10 params → 200400401422
GET
/invoices/schedule/{scheduleId}
Get an schedule
get-invoice-schedule 4 params → 200400401422
PUT
/invoices/schedule/{scheduleId}
Update schedule
update-invoice-schedule 2 params body → 200400401422
DELETE
/invoices/schedule/{scheduleId}
Delete schedule
delete-invoice-schedule 4 params → 200400401422
POST
/invoices/schedule/{scheduleId}/updateAndSchedule
Update scheduled recurring invoice
update-and-schedule-invoice-schedule 2 params → 200400401422
POST
/invoices/schedule/{scheduleId}/schedule
Schedule an schedule invoice
schedule-invoice-schedule 2 params body → 200400401422
POST
/invoices/schedule/{scheduleId}/auto-payment
Manage Auto payment for an schedule invoice
auto-payment-invoice-schedule 2 params body → 200400401422
POST
/invoices/schedule/{scheduleId}/cancel
Cancel an scheduled invoice
cancel-invoice-schedule 2 params body → 200400401422

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are DefaultInvoiceResponseDto (23 properties), UpdateInvoiceScheduleResponseDto (19 properties), GetScheduleResponseDto (19 properties), AutoPaymentInvoiceScheduleResponseDto (19 properties). Each schema is shown below with its type and property counts.

DiscountDto
object
3 properties 1 required
CreateInvoiceScheduleResponseDto
object
19 properties 17 required
BacsDirectDebitDTO
object
2 properties 2 required
CancelInvoiceScheduleResponseDto
object
19 properties 17 required
LateFeesGraceDto
object
2 properties 2 required
CancelInvoiceScheduleDto
object
2 properties 2 required
CustomRRuleOptionsDto
object
14 properties 3 required
ContactDetailsDto
object
8 properties 4 required
ScheduleInvoiceScheduleDto
object
4 properties 3 required
AttachmentsDto
object
5 properties 5 required
USBankAccountDto
object
2 properties 2 required
DefaultInvoiceResponseDto
object
23 properties 19 required
ScheduleOptionsDto
object
2 properties
DeleteInvoiceScheduleResponseDto
object
1 property 1 required
ListSchedulesResponseDto
object
2 properties 2 required
CardDto
object
2 properties 2 required
UpdateInvoiceScheduleResponseDto
object
19 properties 17 required
AutoPaymentInvoiceScheduleResponseDto
object
19 properties 17 required
ProcessingFeeDto
object
3 properties 1 required
ProcessingFeePaidChargeDto
object
4 properties 4 required
ItemTaxDto
object
6 properties 3 required
BecsDirectDebitDTO
object
2 properties 2 required
AdditionalEmailsDto
object
1 property 1 required
ScheduleInvoiceScheduleResponseDto
object
19 properties 17 required
InvoiceItemDto
object
12 properties 4 required
UpdateInvoiceScheduleDto
object
14 properties 10 required
AddressDto
object
6 properties
StripePaymentMethodDto
object
1 property 1 required
PaymentMethodDto
object
1 property 1 required
GetScheduleResponseDto
object
19 properties 17 required
SepaDirectDebitDTO
object
3 properties 3 required
LateFeesMaxFeesDto
object
2 properties 2 required
CreateInvoiceScheduleDto
object
19 properties 10 required
BusinessDetailsDto
object
6 properties
AutoPaymentScheduleDto
object
4 properties 4 required
UpdateAndScheduleInvoiceScheduleResponseDto
object
19 properties 17 required
LateFeesFrequencyDto
object
2 properties 2 required
AutoPaymentDetailsDto
object
11 properties 1 required
TipsConfigurationDto
object
2 properties 2 required
LateFeesConfigurationDto
object
6 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

highlevel-schedule-api-openapi.yml Raw ↑

Other APIs HighLevel publishes across the network.

HighLevel Account API
HighLevel Actions API
HighLevel Affiliates API
HighLevel Agents API
HighLevel App Billing Management API
HighLevel App Management API
HighLevel Appointment Notes API
HighLevel Appointments API
HighLevel Associations API
HighLevel Availability API
HighLevel Blogs API
HighLevel Brand Boards API
Where this information came from

This is an independent, third-party profile of HighLevel Schedule API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.