Skip to content
Home/Agents/
Get Agents

Fin Custom Helpdesk API (0.0.1)

The Fin Custom Helpdesk API allows you to integrate your custom helpdesk with Fin through a standardized set of API endpoints and webhooks.

Download OpenAPI description
api.json
api.yaml
Overview
URL
https://developers.intercom.com
Languages
Servers
Your Custom Helpdesk API (replace with your actual domain)
https://helpdesk.example.com/api/fin/

Users

Manage end-users in your helpdesk system

Operations

Agents

Manage agents in your helpdesk system

Operations

Get Agents

Request

The customer must choose an Agent from within their own system to act as Fin.

When we tell the customer about responses from Fin, the author ID will be the agent chosen to act as Fin.

Security
BearerAuth
curl -i -X GET \
  https://helpdesk.example.com/api/fin/agents \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Agents retrieved successfully

Bodyapplication/jsonArray [
idstring

Unique identifier for the user in your system

Example: "agent_123456"
user_typestring

Type of user

Value"agent"
namestring or null

User's display name

Example: "Jane Doe"
emailstring or null(email)

User's email address

Example: "jane.doe@example.com"
photo_urlstring or null(uri)

URL to user's avatar/profile picture (displayed in Fin Messenger)

Example: "https://example.com/avatars/jane.jpg"
aliasstring or null

Agent's display alias (shown to end-users instead of real name)

Example: "Support Jane"
]
Response
application/json
[
  {
    "id": "agent_001",
    "user_type": "agent",
    "name": "Sarah Johnson",
    "email": "sarah.johnson@company.com",
    "alias": "Support Sarah",
    "photo_url": "https://example.com/avatars/sarah.jpg"
  },
  {
    "id": "agent_fin",
    "user_type": "agent",
    "name": "Fin AI Assistant",
    "email": "fin@company.com",
    "alias": "Fin",
    "photo_url": "https://example.com/avatars/fin.png"
  }
]

Conversations

Manage conversations between end-users and agents

Operations

Messages

Manage messages within conversations

Operations

Webhooks

Notify Fin when conversations change

Operations

Models

Schemas