GorillaDesk Recurring Invoices API

The Recurring Invoices API from GorillaDesk — 2 operation(s) for recurring invoices.

GitHub OpenAPI

Operations 2

GET /recurring-invoices List recurring invoices #
GET /recurring-invoices/{recurringInvoiceId} Retrieve a recurring invoice #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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/gorilladesk:gorilladesk-recurring-invoices-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

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

OpenAPI Specification

gorilladesk-recurring-invoices-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: GorillaDesk Recurring Invoices API
  version: 1.0.0
  description: '# Introduction

    The GorillaDesk API is organized around REST.


    Our API has predictable resource-oriented URLs, accepts JSON-encoded and form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs..


    # Authentication


    The GorillaDesk API uses Token authentication. API keys are per-company and can be generated and deleted in the Addons page.


    # Rate Limits


    We enforce API call rate limits to protect our infrastructure from excessive request rates, to keep GorillaDesk fast and stable for everyone. These limits are high enough that typical API workflows aren''t affected. However, please do code your integration to follow the rule below:


    **If you receive a response status code of 429 (Too Many Requests), please sleep/pause for the number of seconds specified by the rate_reset value before making additional requests to that endpoint.**


    Rate limits are enforced per endpoint group. Endpoint groups are used to provide more granular control by grouping endpoint URL paths and methods (e.g. GET, PUT, etc.) together. For instance, GETs to /v1/users/ and POSTs/PUTs to /v1/customers/ may be counted as two different API groups. This allows us to offer a higher limit on lightweight requests than we would be able to on more resource intensive request types.


    API responses will have the following headers to provide rate limiting statistics about the limit it''s closest to hitting.


    - `x-rate-limit-limit`: Request limit enforced for this endpoint, some endpoints may allow bursting over this limit

    - `x-rate-limit-remaining`: Requests left in the enforcement window

    - `x-rate-limit-reset`: Seconds remaining before this enforcement window ends (as a decimal).


    # Model Context Protocol (MCP)


    You can connect AI agents and tools to GorillaDesk via the Model Context Protocol. See the GorillaDesk MCP documentation.'
  x-logo:
    url: https://cdn.gorilladesk.com/assets/images/gorilladesk.png
    altText: GorillaDesk logo
servers:
- url: https://api.gorilladesk.com/v1
security:
- Bearer: []
tags:
- name: Recurring Invoices
paths:
  /recurring-invoices:
    get:
      operationId: listRecurringInvoices
      summary: List recurring invoices
      tags:
      - Recurring Invoices
      parameters:
      - in: query
        name: customer_id
        description: Filter to recurring invoices for one customer.
        schema:
          type: string
          minLength: 10
        example: oae920rywE
      - in: query
        name: job_id
        description: Filter to recurring invoices for one job.
        schema:
          type: string
          minLength: 10
        example: q2egQENWL9
      - in: query
        name: keyword
        description: Free-text search across account number, customer name and invoice number.
        schema:
          type: string
          maxLength: 255
        example: Smith
      - in: query
        name: created[gt]
        description: Return results where the recurrence start date is strictly greater than this value. Ignored when `created[gte]` is also sent.
        schema:
          type: string
          format: date-time
        example: '2026-07-01T00:00:00+00:00'
      - in: query
        name: created[gte]
        description: Return results where the recurrence start date is greater than or equal to this value.
        schema:
          type: string
          format: date-time
      - in: query
        name: created[lt]
        description: Return results where the recurrence start date is strictly less than this value. Ignored when `created[lte]` is also sent.
        schema:
          type: string
          format: date-time
        example: '2026-07-31T23:59:59+00:00'
      - in: query
        name: created[lte]
        description: Return results where the recurrence start date is less than or equal to this value.
        schema:
          type: string
          format: date-time
      - in: query
        name: include
        description: 'Expand related objects.

          '
        schema:
          type: array
          items:
            type: string
            enum:
            - customer
        example: customer
      - in: query
        name: sort
        description: 'Prefix -[field] for descending order. `total` sorts on the billed amount, `job_name` on the job''s name. Default: the order returned by GorillaDesk.'
        schema:
          type: array
          items:
            type: string
            enum:
            - created
            - -created
            - total
            - -total
            - job_name
            - -job_name
        example: -created
      - in: query
        name: limit
        schema:
          type: integer
          default: 20
          minimum: 1
          maximum: 100
      - in: query
        name: offset
        schema:
          type: integer
          default: 0
          minimum: 0
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/RecurringInvoice'
                  has_more:
                    type: boolean
                    example: false
        '400':
          $ref: '#/paths/~1jobs/get/responses/403'
        '401':
          $ref: '#/paths/~1jobs/get/responses/401'
  /recurring-invoices/{recurringInvoiceId}:
    get:
      operationId: getRecurringInvoice
      summary: Retrieve a recurring invoice
      tags:
      - Recurring Invoices
      parameters:
      - in: path
        name: recurringInvoiceId
        description: Recurring invoice id.
        required: true
        schema:
          type: string
          minLength: 10
        example: Rv7nQ4pW2k
      - in: query
        name: include
        description: 'Expand related objects.

          '
        schema:
          type: array
          items:
            type: string
            enum:
            - customer
        example: customer
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/RecurringInvoice'
        '400':
          $ref: '#/paths/~1jobs/get/responses/403'
        '401':
          $ref: '#/paths/~1jobs/get/responses/401'
        '404':
          $ref: '#/paths/~1jobs~1%7BjobId%7D/get/responses/404'
components:
  schemas:
    RecurringInvoice:
      type: object
      description: 'A recurring invoice — the schedule that generates invoices for a job.

        Returned from both list (`/v1/recurring-invoices`) and detail

        (`/v1/recurring-invoices/{id}`) endpoints.

        '
      properties:
        id:
          type: string
          description: Recurring invoice ID.
          example: Rv7nQ4pW2k
        job:
          type:
          - object
          - 'null'
          description: The job this recurrence bills for. Null when the recurrence is not attached to a job.
          properties:
            name:
              type:
              - string
              - 'null'
              description: Job name.
              example: Monthly Service
        recurrence_summary:
          type:
          - string
          - 'null'
          description: 'Human-readable recurrence summary: the repeat rule, followed by any

            exceptions (e.g. Every 2 days, 3 times. Except Jan, Feb).

            '
          example: Every month on the 1st Tuesday, 4 times. Except January, April, September
        total:
          type:
          - number
          - 'null'
          format: float
          description: Amount billed on each occurrence.
          example: 149.5
        created:
          type:
          - string
          - 'null'
          format: date-time
          description: 'Date the recurrence started, in ISO 8601 (UTC). Filter on it with

            `created[gt]` / `created[gte]` / `created[lt]` / `created[lte]`.

            '
          example: '2026-07-22T00:00:00+00:00'
        customer:
          description: Customer the recurrence bills. Only returned with `?include=customer`.
          $ref: '#/components/schemas/Customer/allOf/0'
    CustomerPhone:
      type: object
      required:
      - phone
      - type
      properties:
        id:
          type: string
          description: Phone Id
          example: 0nk8PGvAO
        phone:
          type: string
          example: 212-456-7890
          description: Phone number
        type:
          type: string
          description: Phone type Id
          example: 0nk8PGvAO
    Customer:
      allOf:
      - type: object
        properties:
          id:
            type: string
            description: The customer ID.
            example: 0nk8PGvAO
          account_number:
            type: string
            description: Numeric account identifier for the customer.
            example: '5047'
          last_name:
            type: string
            example: Doe
          first_name:
            type: string
            example: John
          profile_url:
            type: string
            example: https://v3.gorilladesk.com/customers/5393
          email:
            type: string
            example: example@gmail.com
          phones:
            type: array
            items:
              type: object
              $ref: '#/components/schemas/CustomerPhone'
          company:
            type: string
            example: NL software
          source:
            type:
            - object
            - 'null'
            description: Where the customer originated. Null if no source is assigned.
            properties:
              id:
                type: string
                description: Source ID.
                example: aWGl2VlY78
              name:
                type: string
                example: Facebook
          tags:
            type: array
            description: Customer-level tag labels attached to this customer.
            items:
              type: string
            example:
            - super
            - vip
          state:
            type: string
            enum:
            - active
            - deleted
            example: active
          status:
            type: string
            enum:
            - active
            - inactive
            - lead
            example: active
          created:
            type: string
            format: date-time
            example: '2023-05-21T17:32:28+00:00'
            description: Created date in ISO 8601.
          updated:
            type: string
            format: date-time
            description: Updated date in ISO 8601.
            example: '2023-05-21T17:32:28+00:00'
      - type: object
        properties:
          locations:
            type: array
            items:
              type: object
              $ref: '#/components/schemas/Location'
          contacts:
            type: array
            items:
              type: object
              $ref: '#/components/schemas/Contact'
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
x-sidebar-links:
- label: Model Context Protocol (MCP)
  url: https://api.gorilladesk.com/mcp/v1/docs
  target: _blank