Skip to main content
GET
/
agents
/
{id}
Get Agent Details
curl --request GET \
  --url https://api.kakiyo.com/v1/agents/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "agent_abcdef123456",
  "name": "John Doe",
  "status": "running",
  "login": "[email protected]",
  "country": "US",
  "avatar": "https://example.com/avatar.jpg",
  "nextTask": "2023-06-16T10:30:00Z",
  "usage": {
    "invitations": 45,
    "invitationsDaily": 15,
    "messages": 120,
    "messagesDaily": 25,
    "nextInvitation": "2023-06-16T10:45:00Z",
    "nextMessage": "2023-06-16T11:15:00Z",
    "workingHours": {
      "days": "1:1:1:1:1:0:0",
      "start": "09:00",
      "stop": "17:00",
      "timezone": 0
    }
  },
  "alerts": [
    {
      "type": "auth",
      "subType": "2fa_required",
      "message": "Please enter the verification code sent by LinkedIn to your email/phone",
      "severity": "warning"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

ID of the agent

Response

Agent details

​
id
string
Example:

"agent_abcdef123456"

​
name
string
Example:

"John Doe"

​
status
enum<string>
Available options:
setup_needed,
auth_needed,
auth_in_progress,
running,
paused,
disabled
Example:

"running"

​
login
string
​
country
string
Example:

"US"

​
avatar
string
Example:

"https://example.com/avatar.jpg"

​
nextTask
string<date-time>
Example:

"2023-06-16T10:30:00Z"

​
usage
object
​
alerts
object[]