GorillaDesk Customer API

The Customer API from GorillaDesk — 2 operation(s) for customer.

Operations 4

GET /customers List all customers #
POST /customers Create a customer #
GET /customers/{customerId} Retrieve a customer #
PUT /customers/{customerId} Update a customer #

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-customer-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.

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

OpenAPI Specification

gorilladesk-customer-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: GorillaDesk Customer API
  description: '# Introduction

    The GorillaDesk API is organized around REST.'
  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: Customer
paths:
  /customers:
    get:
      summary: List all customers
      tags:
      - Customer
      parameters:
      - in: query
        name: state
        schema:
          type: array
          items:
            type: string
            enum:
            - active
            - deleted
        example: active,deleted
      - in: query
        name: status
        schema:
          type: array
          items:
            type: string
            enum:
            - active
            - inactive
            - lead
        example: active,inactive,lead
      - in: query
        name: account_number
        description: Return results where the account_number field is equal this value.
        schema:
          type: string
        example: '5000'
      - in: query
        name: created[gt]
        description: Return results where the created field is greater than this value.
        schema:
          type: string
          format: date-time
        example: '2023-05-21T17:32:28+00:00'
      - in: query
        name: created[gte]
        description: Return results where the created field is greater than or equal this value.
        schema:
          type: string
          format: date-time
        example: '2023-05-21T17:32:28+00:00'
      - in: query
        name: created[lt]
        description: Return results where the created field is less than this value.
        schema:
          type: string
          format: date-time
        example: '2023-05-21T17:32:28+00:00'
      - in: query
        name: created[lte]
        description: Return results where the created field is less than or equal this value.
        schema:
          type: string
          format: date-time
        example: '2023-05-21T17:32:28+00:00'
      - in: query
        name: updated[gt]
        description: Return results where the updated field is greater than this value.
        schema:
          type: string
          format: date-time
        example: '2023-05-21T17:32:28+00:00'
      - in: query
        name: updated[gte]
        description: Return results where the updated field is greater than or equal this value.
        schema:
          type: string
          format: date-time
        example: '2023-05-21T17:32:28+00:00'
      - in: query
        name: updated[lt]
        description: Return results where the updated field is less than this value.
        schema:
          type: string
          format: date-time
        example: '2023-05-21T17:32:28+00:00'
      - in: query
        name: updated[lte]
        description: Return results where the updated field is less than or equal this value.
        schema:
          type: string
          format: date-time
        example: '2023-05-21T17:32:28+00:00'
      - in: query
        name: include
        schema:
          type: array
          items:
            type: string
            enum:
            - locations
            - contacts
        example: locations,contacts
      - in: query
        name: sort
        description: Prefix -[field] sort order is descending.
        schema:
          type: array
          items:
            type: string
            enum:
            - account_number
            - last_name
            - first_name
            - created
            - updated
        example: account_number,last_name,-created
      - in: query
        name: limit
        schema:
          type: integer
          default: 20
          minimum: 1
          maximum: 100
      - in: query
        name: offset
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Customer'
                  has_more:
                    type: boolean
        '401':
          $ref: '#/paths/~1users/get/responses/401'
        '403':
          $ref: '#/paths/~1users/get/responses/403'
      operationId: getCustomers
      x-operation-id-source: derived
    post:
      summary: Create a customer
      tags:
      - Customer
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/paths/~1customers~1%7BcustomerId%7D/put/requestBody/content/application~1json/schema'
              - type: object
                properties:
                  location:
                    $ref: '#/components/schemas/Location'
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
        '401':
          $ref: '#/paths/~1users/get/responses/401'
        '403':
          $ref: '#/paths/~1users/get/responses/403'
      operationId: postCustomers
      x-operation-id-source: derived
  /customers/{customerId}:
    get:
      summary: Retrieve a customer
      tags:
      - Customer
      parameters:
      - in: path
        name: customerId
        description: Customer Id
        required: true
        schema:
          type: string
      - in: query
        name: include
        schema:
          type: array
          items:
            type: string
            enum:
            - locations
            - contacts
        example: locations,contacts
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Customer'
        '401':
          $ref: '#/paths/~1users/get/responses/401'
        '403':
          $ref: '#/paths/~1users/get/responses/403'
        '404':
          $ref: '#/paths/~1users~1%7BuserId%7D/get/responses/404'
      operationId: getCustomersByCustomerId
      x-operation-id-source: derived
    put:
      summary: Update a customer
      tags:
      - Customer
      parameters:
      - in: path
        name: customerId
        description: Customer Id
        required: true
        schema:
          type: string
      requestBody:
        description: Create a new pet in the store
        content:
          application/json:
            schema:
              type: object
              required:
              - first_name
              - location
              properties:
                account_number:
                  type: string
                  description: Must end with a number
                  example: '5047'
                first_name:
                  type: string
                  example: John
                last_name:
                  type: string
                  example: Doe
                status:
                  type: string
                  enum:
                  - active
                  - inactive
                  - lead
                  example: active
                email:
                  type: string
                  example: example@gmail.com
                phones:
                  type: array
                  items:
                    type: object
                    $ref: '#/components/schemas/CustomerPhone'
                company:
                  type: string
                  example: NL software
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
        '401':
          $ref: '#/paths/~1users/get/responses/401'
        '403':
          $ref: '#/paths/~1users/get/responses/403'
        '404':
          $ref: '#/paths/~1users~1%7BuserId%7D/get/responses/404'
      operationId: putCustomersByCustomerId
      x-operation-id-source: derived
components:
  schemas:
    Location:
      type: object
      required:
      - address_line_1
      - city
      - state
      - zip
      properties:
        id:
          type: string
          example: 5aXrGzNyLY
          readOnly: true
        name:
          type: string
          example: Home
        address_to:
          type: string
          example: John Doe
        address_line_1:
          type: string
          example: 523 East 72nd Street
        address_line_2:
          type: string
          example: ''
        city:
          type: string
          example: New York
        state:
          type: string
          example: NY
        zip:
          type: string
          example: '10021'
        county:
          type: string
          example: ''
        billing_to:
          type: string
          example: John Doe
        billing_address_line_1:
          type: string
          example: 523 East 72nd Street
        billing_address_line_2:
          type: string
          example: ''
        billing_city:
          type: string
          example: New York
        billing_state:
          type: string
          example: NY
        billing_zip:
          type: string
          example: '10021'
        latitude:
          type: string
          example: ''
        longitude:
          type: string
          example: ''
        note:
          type: string
          example: Lorem ipsum dolor sit amet, consectetuer adipiscing eliti
    Customer:
      type: object
      properties:
        id:
          type: string
          description: The customer Id
          example: 0nk8PGvAO
        account_number:
          type: string
          description: Must end with a number
          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 format
        updated:
          type: string
          format: date-time
          description: Updated date in ISO format
          example: '2023-05-21T17:32:28+00:00'
        locations:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/Location'
        contacts:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/Contact'
    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
    Contact:
      type: object
      properties:
        id:
          type: string
          example: 5aXrGzNyLY
        first_name:
          type: string
          example: John
        last_name:
          type: string
          example: Doe
        email:
          type: string
          example: example@gmail.com
        phones:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/CustomerPhone'
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer