GorillaDesk Branches API

openapi: 3.2.0
info:
  title: GorillaDesk Branches 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: Branches
paths:
  /branches:
    get:
      operationId: listBranches
      summary: List all branches
      tags:
      - Branches
      parameters:
      - in: query
        name: keyword
        description: Search branches by name (case-insensitive partial match)
        schema:
          type: string
          maxLength: 255
        example: Downtown
      - in: query
        name: sort
        description: 'Prefix -[field] for descending order. Default: name asc.'
        schema:
          type: array
          items:
            type: string
            enum:
            - name
            - id
            - employee_count
        example: name,-employee_count
      - 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/Branch'
                  has_more:
                    type: boolean
        '400':
          $ref: '#/paths/~1jobs/get/responses/403'
        '401':
          $ref: '#/paths/~1jobs/get/responses/401'
components:
  schemas:
    Branch:
      type: object
      description: A branch of the company.
      properties:
        id:
          type: string
          description: Branch ID.
          example: 0nk8PGvAO
        name:
          type:
          - string
          - 'null'
          description: Branch name.
          example: NT Branch Company
        email:
          type:
          - string
          - 'null'
          description: Branch email address.
          example: branch@domain.com
        phone:
          type:
          - string
          - 'null'
          description: Branch phone number, as entered.
          example: '12054090749'
        employee_count:
          type:
          - integer
          - 'null'
          description: Number of employees in the branch.
          example: 1
        plan:
          type:
          - object
          - 'null'
          description: Subscription plan of the branch.
          properties:
            id:
              type: string
              description: Plan ID.
              example: x1eW6yGmMA
            type:
              type:
              - string
              - 'null'
              description: Name of the subscription plan the branch is on, as returned by GorillaDesk (e.g. `Growth 1`, `Growth 5`). Free-form text, not an enum. `null` when not set.
              example: Growth 1
            period:
              type:
              - string
              - 'null'
              description: Billing period of the plan (e.g. `Month`). Free-form text, not an enum. `null` when not set.
              example: Month
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
x-sidebar-links:
- label: Model Context Protocol (MCP)
  url: https://api.gorilladesk.com/mcp/v1/docs
  target: _blank