The Agent IQ Logo
API docs by Redocly

The Agent IQ API (2.0.0)

Download OpenAPI specification:Download

name: info@agentiq.com URL: / License: MIT

The Agent IQ API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. Your API url will be sent to you, along with the keys. For Production, the URL will look like this: api-v2.[FI-domain].agentiq.co and UAT like this: api-v2.[FI-domain]-uat.agentiq.co

Exports

GET /api/exports/conversations

Fetch full conversations that match parameters

Authorizations:
api_key
query Parameters
start_date
string

Timestamp with format YYYY-MM-DDTHH:MM:SSZ

end_date
string

Timestamp with format YYYY-MM-DDTHH:MM:SSZ. default: Now

updated_start_date
string

Timestamp with format YYYY-MM-DDTHH:MM:SSZ

updated_end_date
string

Timestamp with format YYYY-MM-DDTHH:MM:SSZ

customer_id
integer

This is an AgentIQ ID. This is the Customer ID. Customer ID is also referred to as Lynq ID. This is the unique identifier for each customer or member record.

agent_id
integer

Id of agent (Agent IQ id)

header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "conversation_id": 0,
  • "customer_id": 0,
  • "conversation_referer_url": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "agents": [
    ],
  • "entities": {
    },
  • "chat_transcript": {
    }
}

GET /api/exports/customers

Fetch customers that match parameters

Authorizations:
api_key
query Parameters
start_date
string

Timestamp with format YYYY-MM-DDTHH:MM:SSZ

end_date
string

Timestamp with format YYYY-MM-DDTHH:MM:SSZ. default: Now

updated_start_date
string

Timestamp with format YYYY-MM-DDTHH:MM:SSZ

updated_end_date
string

Timestamp with format YYYY-MM-DDTHH:MM:SSZ

customer_id
integer

This is an AgentIQ ID. This is the Customer ID. Customer ID is also referred to as Lynq ID. This is the unique identifier for each customer or member record.

external_id
string

External Id of the customer (Client id).

name
string

First name, last name or full name of the customer.

email
string

Customer email associated with account.

primary_agent_id
integer

Id of primary agent related to customer (Agent IQ id)

header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "phone": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "first_message": "string",
  • "last_message": "string",
  • "last_login": "string",
  • "first_banker_chosen": "string",
  • "last_banker_chosen": "string",
  • "primary_agent": 0,
  • "profile": { },
  • "external_id": "string",
  • "customer_segment": "string"
}

GET /api/exports/agents

Fetch agents that match parameters.

Authorizations:
api_key
query Parameters
start_date
string

Timestamp with format YYYY-MM-DDTHH:MM:SSZ

end_date
string

Timestamp with format YYYY-MM-DDTHH:MM:SSZ. default: Now

updated_start_date
string

Timestamp with format YYYY-MM-DDTHH:MM:SSZ

updated_end_date
string

Timestamp with format YYYY-MM-DDTHH:MM:SSZ

agent_id
integer

This is an AgentIQ ID. The Agent ID is a unique identifier for each agent record.

external_id
string

External Id of the agent (Client id).

name
string

First name, last name or full name of the agent.

email
string

Agent's email associated with account.

header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "phone": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "deleted_at": "string",
  • "deactivated_at": "string",
  • "profile": { },
  • "roles": [
    ],
  • "teams": [
    ],
  • "watcher_teams": [
    ],
  • "external_id": "string",
  • "agent_segment": "string"
}

GET /api/exports/customer_feedback

Fetch customer feedback that match parameters

Authorizations:
api_key
query Parameters
customer_id
integer

This is an AgentIQ ID. This is the Customer ID. Customer ID is also referred to as Lynq ID. This is the unique identifier for each customer or member record.

primary_agent_id
integer

Id of primary agent related to customer when survey was sent (Agent IQ id)

sender_id
integer

Id of agent whom sent the survey (Agent IQ id)

type
string
Enum: "csat" "nps"

Type of survey sent

start_date
string

Timestamp with format YYYY-MM-DDTHH:MM:SSZ

end_date
string

Timestamp with format YYYY-MM-DDTHH:MM:SSZ. default: Now

header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "csat",
  • "customer_id": 0,
  • "primary_agent_id": 0,
  • "sender_id": 0,
  • "time_stamp": "string",
  • "value": 0,
  • "content": {
    }
}

GET /api/exports/agent_availability

Fetch agent availability.

Authorizations:
api_key
query Parameters
start_date
string

Timestamp with format YYYY-MM-DDTHH:MM:SSZ

end_date
string

Timestamp with format YYYY-MM-DDTHH:MM:SSZ. default: Now

agent_id
integer

Id of agent (Agent IQ id).

event_name
string

Name of event.

event_id
integer

Id of event.

executor_id
integer

Id of agent who triggered the event (Agent IQ id).

header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "event_name": "available",
  • "agent_id": 0,
  • "event_id": 0,
  • "executor_id": 0
}

GET /api/exports/agent_actions

Fetch agent assignments, locks along with capacity and availability.

Authorizations:
api_key
query Parameters
start_date
string

Timestamp with format YYYY-MM-DDTHH:MM:SSZ

end_date
string

Timestamp with format YYYY-MM-DDTHH:MM:SSZ. default: Now

agent_id
integer

Id of agent (Agent IQ id).

conversation_id
integer

Id of conversation.

action_type
string
Enum: "assignment" "lock" "unlock"

type of action.

action_id
integer

Id of action event.

header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "action_id": 0,
  • "action_type": "assignment",
  • "action_time": "string",
  • "agent_availability": "string",
  • "agent_capacity": 0,
  • "agent_id": 0,
  • "actor_id": 0,
  • "load": 0,
  • "conversation_id": 0
}

Live

GET /api/agents

Get Agent by id or 'me'

Authorizations:
api_key
query Parameters
query
string
limit
integer
Default: 50
offset
integer
Default: 0
exclude
Array of integers

Array of id's to exclude (can include multiple exclude[] params)

Responses

Response samples

Content type
application/json
{
  • "models": [
    ],
  • "pagination": {
    }
}

Imports

POST /api/ingestion/users

Expect Banker First Name, Banker Last Name, Banker Email (Required if banker info is provided), BankerMapID, BankerTeam, Customer First Name, Customer Last Name, CustomerMapID (Required if customer info is provided), Customer Email, Customer Group, Date Added, Customer Phone in csv

Authorizations:
api_key
Request Body schema: multipart/form-data
file
string <binary>

csv file

Responses

Response samples

Content type
application/json
{
  • "total": [
    ],
  • "success": [
    ],
  • "failure": [
    ],
  • "summary": { }
}

POST /api/ingestion/customers/notes

Expect CustomerMapID, Note in csv

Authorizations:
api_key
Request Body schema: multipart/form-data
file
string <binary>

csv file

Responses

Response samples

Content type
application/json
{
  • "total": [
    ],
  • "success": [
    ],
  • "failure": [
    ],
  • "summary": { }
}

Files

GET /api/files

Download a file that is shared in conversations.

Authorizations:
api_key
query Parameters
key
string

Name of a key to the file

Responses

Response samples

Content type
application/json
"string"