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.
openapi: 3.2.0
info:
title: GorillaDesk Sources 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: Sources
paths:
/sources:
get:
operationId: listSources
summary: List all sources
tags:
- Sources
parameters:
- in: query
name: keyword
description: Search sources by name (case-insensitive partial match)
schema:
type: string
maxLength: 255
example: Google
- in: query
name: sort
description: 'Prefix -[field] for descending order. Default: name asc.'
schema:
type: array
items:
type: string
enum:
- name
- id
- created_at
example: name,-created_at
- 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/Source'
has_more:
type: boolean
'400':
$ref: '#/paths/~1jobs/get/responses/403'
'401':
$ref: '#/paths/~1jobs/get/responses/401'
/sources/{sourceId}:
get:
operationId: getSource
summary: Retrieve a source
tags:
- Sources
parameters:
- in: path
name: sourceId
description: Source Id
required: true
schema:
type: string
example: 0nk8PGvAO
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Source'
'401':
$ref: '#/paths/~1jobs/get/responses/401'
'404':
$ref: '#/paths/~1jobs~1%7BjobId%7D/get/responses/404'
components:
schemas:
Source:
type: object
description: A customer source — where a customer originated (e.g. "Website", "Referral").
properties:
id:
type: string
description: The source Id
example: 0nk8PGvAO
name:
type: string
description: Display name of the source.
example: Google Ads
created_at:
type:
- string
- 'null'
format: date-time
description: Created date in ISO 8601 format with timezone offset.
example: '2026-05-15T03:16:33+00:00'
securitySchemes:
Bearer:
type: http
scheme: bearer
x-sidebar-links:
- label: Model Context Protocol (MCP)
url: https://api.gorilladesk.com/mcp/v1/docs
target: _blank