Agent Management

List Agents

get

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstring · uuidRequired

The unique identifier of the workspace.

Query parameters

limitinteger · max: 100Optional

Limits the number of results to return.

Default: 25

pageTokenstringOptional

The cursor that keeps track of the current position in the results.

reversebooleanOptional

Reverses the order in which the results are returned.

Default: false

sortBystring · enumOptional

Sort by field specified

Possible values:

namestringOptional

Filter by agent name

emailstringOptional

Filter by agent email

roleIdsstring · uuid[]Optional

Filter by agent role ids

lastStatusActivitySincestringOptional

To filter agents by their last status change since.

lastStatusActivityUptostringOptional

To filter agents by their last status change activity time.

agentIdsstring · uuid[]Optional

To find specific agents by their ids. If this is specified, other parameters are ignored.

Responses

200

OK

application/json

nextPageTokenstringOptional

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

totalintegerOptional

The total number of results across all pages.

404

The requested resource was not found.

application/json

get

/workspaces/{workspaceId}/agents

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/agents HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "results": [
    {
      "id": "text",
      "status": "active",
      "statusBeforeOffline": "active",
      "name": "text",
      "overrideName": true,
      "workspaceId": "text",
      "type": "user",
      "userEmails": [
        "text"
      ],
      "bio": "text",
      "avatarUrl": "text",
      "dropVms": [
        null
      ],
      "tagCount": 1,
      "wrapUpTime": 1,
      "lastAssignedAt": "2026-05-16T21:13:22.833Z",
      "lastSetToAwayAt": "2026-05-16T21:13:22.833Z",
      "teams": [
        {
          "id": "text",
          "name": "text",
          "memberSince": "2026-05-16T21:13:22.833Z",
          "activeMemberCount": 1,
          "pendingMemberCount": 1
        }
      ],
      "workload": {
        "id": "text",
        "workload": {
          "messaging": 1,
          "email": 1
        },
        "rule": {
          "id": "text",
          "workspaceId": "text",
          "name": "text",
          "description": "text",
          "default": true,
          "capacity": {
            "messaging": 1,
            "email": 1
          },
          "assignedAgentIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "createdAt": "text",
          "updatedAt": "text"
        },
        "ruleId": "text",
        "updatedAt": "2026-05-16T21:13:22.833Z"
      },
      "createdAt": "2026-05-16T21:13:22.833Z",
      "updatedAt": "2026-05-16T21:13:22.833Z",
      "availability": {
        "status": "active",
        "activity": "available",
        "activityTtl": 1,
        "activityText": "text",
        "lastStatusSet": "text",
        "lastActivitySet": "text",
        "updatedAt": "2026-05-16T21:13:22.833Z"
      },
      "timezone": "text",
      "defaultCountryCode": "text",
      "defaultCallerId": "text",
      "forwardNumber": {
        "enabled": true,
        "number": "text",
        "maskCaller": true
      },
      "transcriptionLocale": "ar-AE",
      "roles": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "organization",
          "workspaces": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ],
      "user": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "avatarUrl": "text",
        "defaultEmail": "text",
        "phoneNumber": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "weeklySchedule": {
        "monday": {
          "from": {
            "hour": 1,
            "minute": 1
          },
          "to": {
            "hour": 1,
            "minute": 1
          }
        },
        "tuesday": {
          "from": {
            "hour": 1,
            "minute": 1
          },
          "to": {
            "hour": 1,
            "minute": 1
          }
        },
        "wednesday": {
          "from": {
            "hour": 1,
            "minute": 1
          },
          "to": {
            "hour": 1,
            "minute": 1
          }
        },
        "thursday": {
          "from": {
            "hour": 1,
            "minute": 1
          },
          "to": {
            "hour": 1,
            "minute": 1
          }
        },
        "friday": {
          "from": {
            "hour": 1,
            "minute": 1
          },
          "to": {
            "hour": 1,
            "minute": 1
          }
        },
        "saturday": {
          "from": {
            "hour": 1,
            "minute": 1
          },
          "to": {
            "hour": 1,
            "minute": 1
          }
        },
        "sunday": {
          "from": {
            "hour": 1,
            "minute": 1
          },
          "to": {
            "hour": 1,
            "minute": 1
          }
        }
      },
      "holidays": [
        {
          "name": "text",
          "day": 1,
          "month": 1
        }
      ],
      "assignedSkills": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "selectedValues": [
            {
              "icon": "text",
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "value": "text"
            }
          ],
          "valueType": "single"
        }
      ],
      "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
      "outOfOfficeResponse": "text"
    }
  ],
  "nextPageToken": "text",
  "total": 1
}

Create Agent

post

Create a new agent with specified details like name, role, and basic bio.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstring · uuidRequired

The unique identifier of the workspace.

Body

application/json

or

or

Responses

201

Created

application/json

404

The requested resource was not found.

application/json

409

The request conflicts with the current state of the resource.

application/json

422

The request contains invalid parameters or body fields.

application/json

post

/workspaces/{workspaceId}/agents

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/agents HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 730

{
  "name": "text",
  "bio": "text",
  "type": "user",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "teamIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "timezone": "text",
  "defaultCountryCode": "text",
  "weeklySchedule": {
    "monday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "tuesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "wednesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "thursday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "friday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "saturday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "sunday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    }
  },
  "holidays": [
    {
      "name": "text",
      "day": 1,
      "month": 1
    }
  ]
}

{
  "id": "text",
  "status": "active",
  "statusBeforeOffline": "active",
  "name": "text",
  "overrideName": true,
  "workspaceId": "text",
  "type": "user",
  "userEmails": [
    "text"
  ],
  "bio": "text",
  "avatarUrl": "text",
  "dropVms": [
    null
  ],
  "tagCount": 1,
  "wrapUpTime": 1,
  "lastAssignedAt": "2026-05-16T21:13:22.833Z",
  "lastSetToAwayAt": "2026-05-16T21:13:22.833Z",
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2026-05-16T21:13:22.833Z",
      "activeMemberCount": 1,
      "pendingMemberCount": 1
    }
  ],
  "workload": {
    "id": "text",
    "workload": {
      "messaging": 1,
      "email": 1
    },
    "rule": {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "default": true,
      "capacity": {
        "messaging": 1,
        "email": 1
      },
      "assignedAgentIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "createdAt": "text",
      "updatedAt": "text"
    },
    "ruleId": "text",
    "updatedAt": "2026-05-16T21:13:22.833Z"
  },
  "createdAt": "2026-05-16T21:13:22.833Z",
  "updatedAt": "2026-05-16T21:13:22.833Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 1,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2026-05-16T21:13:22.833Z"
  },
  "timezone": "text",
  "defaultCountryCode": "text",
  "defaultCallerId": "text",
  "forwardNumber": {
    "enabled": true,
    "number": "text",
    "maskCaller": true
  },
  "transcriptionLocale": "ar-AE",
  "roles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "avatarUrl": "text",
    "defaultEmail": "text",
    "phoneNumber": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "weeklySchedule": {
    "monday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "tuesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "wednesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "thursday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "friday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "saturday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "sunday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    }
  },
  "holidays": [
    {
      "name": "text",
      "day": 1,
      "month": 1
    }
  ],
  "assignedSkills": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "selectedValues": [
        {
          "icon": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "value": "text"
        }
      ],
      "valueType": "single"
    }
  ],
  "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
  "outOfOfficeResponse": "text"
}

List All Agents

get

Lists all agents for a workspace returning only minimal fields for each agent.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstring · uuidRequired

The unique identifier of the workspace.

Responses

200

OK

application/json

get

/workspaces/{workspaceId}/all-agents

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/all-agents HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "results": [
    {
      "id": "text",
      "status": "active",
      "activity": "available",
      "name": "text",
      "avatarUrl": "text",
      "createdAt": "2026-05-16T21:13:22.833Z"
    }
  ]
}

Get Agent

get

Retrieve information about a specific agent, including their name, bio, status.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstring · uuidRequired

The unique identifier of the workspace.

agentIdstringRequired

Responses

200

OK

application/json

idstringRequired

statusstring · enumOptionalPossible values:

statusBeforeOfflinestring · enumOptionalPossible values:

namestring · min: 1 · max: 50Optional

overrideNamebooleanOptional

workspaceIdstringRequired

typestring · enumOptionalPossible values:

userEmailsstring[]Optional

biostring · max: 240Optional

avatarUrlstringOptional

tagCountintegerOptional

wrapUpTimeinteger · max: 900Optional

rootItemAssignedCountintegerOptionalDeprecated

lastAssignedAtstring · date-timeOptional

lastSetToAwayAtstring · date-timeOptional

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

timezonestringOptional

defaultCountryCodestringOptional

defaultCallerIdstringOptional

transcriptionLocalestring · enumOptional

Curated set of BCP47 locale identifiers supported by Bird speech-to-text products

Possible values:

defaultSenderIdstring · uuidOptional

The default Sender Profile to select for this agent when composing a new message.

outOfOfficeResponsestring · max: 1000Optional

404

The requested resource was not found.

application/json

get

/workspaces/{workspaceId}/agents/{agentId}

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/agents/{agentId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "status": "active",
  "statusBeforeOffline": "active",
  "name": "text",
  "overrideName": true,
  "workspaceId": "text",
  "type": "user",
  "userEmails": [
    "text"
  ],
  "bio": "text",
  "avatarUrl": "text",
  "dropVms": [
    null
  ],
  "tagCount": 1,
  "wrapUpTime": 1,
  "lastAssignedAt": "2026-05-16T21:13:22.833Z",
  "lastSetToAwayAt": "2026-05-16T21:13:22.833Z",
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2026-05-16T21:13:22.833Z",
      "activeMemberCount": 1,
      "pendingMemberCount": 1
    }
  ],
  "workload": {
    "id": "text",
    "workload": {
      "messaging": 1,
      "email": 1
    },
    "rule": {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "default": true,
      "capacity": {
        "messaging": 1,
        "email": 1
      },
      "assignedAgentIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "createdAt": "text",
      "updatedAt": "text"
    },
    "ruleId": "text",
    "updatedAt": "2026-05-16T21:13:22.833Z"
  },
  "createdAt": "2026-05-16T21:13:22.833Z",
  "updatedAt": "2026-05-16T21:13:22.833Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 1,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2026-05-16T21:13:22.833Z"
  },
  "timezone": "text",
  "defaultCountryCode": "text",
  "defaultCallerId": "text",
  "forwardNumber": {
    "enabled": true,
    "number": "text",
    "maskCaller": true
  },
  "transcriptionLocale": "ar-AE",
  "roles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "avatarUrl": "text",
    "defaultEmail": "text",
    "phoneNumber": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "weeklySchedule": {
    "monday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "tuesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "wednesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "thursday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "friday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "saturday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "sunday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    }
  },
  "holidays": [
    {
      "name": "text",
      "day": 1,
      "month": 1
    }
  ],
  "assignedSkills": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "selectedValues": [
        {
          "icon": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "value": "text"
        }
      ],
      "valueType": "single"
    }
  ],
  "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
  "outOfOfficeResponse": "text"
}

Get url to upload profile avatar to

get

Retrieve the url and form data to post profile avatar directly.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstring · uuidRequired

The unique identifier of the workspace.

agentIdstringRequired

Responses

200

OK

application/json

Url and Form data needed to upload an image

mediaUrlstring · max: 5000Optional

URL to download the media from

fileIdstring · uuidOptional

File ID

urlstring · max: 5000Required

URL to post the image to

expectedFieldsstring[]Optional

get

/workspaces/{workspaceId}/agents/{agentId}/presigned-upload

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/agents/{agentId}/presigned-upload HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "mediaUrl": "text",
  "fileId": "123e4567-e89b-12d3-a456-426614174000",
  "url": "text",
  "formData": {
    "policy": "eyAiZXhwaXJhdGlvbiI6ICIyMDE1LTEyLTMwVDEyOjAwOjAwLjAwMFoiLA0KICAiY29uZGl0aW9ucyI6IFsNCiAgICB7ImJ1Y2tldCI6ICJzaWd2NGV4YW",
    "x-amz-algorithm": "AWS4-HMAC-SHA256",
    "x-amz-credential": "AKIAIOSFODNN7EXAMPLE/20151229/us-east-1/s3/aws4_request",
    "x-amz-date": "20151229T000000Z",
    "x-amz-signature": "8afdbf4008c03f22c2cd3cdb72e4afbb1f6a588f3255ac628749a66d7f09699e"
  },
  "expectedFields": [
    "text"
  ]
}

Get url to upload audio files

post

Retrieve the url and form data to post audio files directly.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstring · uuidRequired

The unique identifier of the workspace.

agentIdstringRequired

Responses

200

OK

application/json

Url and Form data needed to upload an image

mediaUrlstring · max: 5000Optional

URL to download the media from

fileIdstring · uuidOptional

File ID

urlstring · max: 5000Required

URL to post the image to

expectedFieldsstring[]Optional

post

/workspaces/{workspaceId}/agents/{agentId}/presigned-upload/audio

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/agents/{agentId}/presigned-upload/audio HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "mediaUrl": "text",
  "fileId": "123e4567-e89b-12d3-a456-426614174000",
  "url": "text",
  "formData": {
    "policy": "eyAiZXhwaXJhdGlvbiI6ICIyMDE1LTEyLTMwVDEyOjAwOjAwLjAwMFoiLA0KICAiY29uZGl0aW9ucyI6IFsNCiAgICB7ImJ1Y2tldCI6ICJzaWd2NGV4YW",
    "x-amz-algorithm": "AWS4-HMAC-SHA256",
    "x-amz-credential": "AKIAIOSFODNN7EXAMPLE/20151229/us-east-1/s3/aws4_request",
    "x-amz-date": "20151229T000000Z",
    "x-amz-signature": "8afdbf4008c03f22c2cd3cdb72e4afbb1f6a588f3255ac628749a66d7f09699e"
  },
  "expectedFields": [
    "text"
  ]
}

Get agent media download

get

Get media download from an agent

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

agentIdstringRequired

fileIdstringRequired

Query parameters

redirectbooleanOptional

Responses

200

Return file location

302

Redirect to file location

400

The request was malformed.

application/json

404

The requested resource was not found.

application/json

get

/workspaces/{workspaceId}/agents/{agentId}/media/{fileId}/download

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/agents/{agentId}/media/{fileId}/download HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update Agent

patch

Modify the details of a specific agent, such as their name, bio, status.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstring · uuidRequired

The unique identifier of the workspace.

agentIdstringRequired

Body

application/json

namestring · min: 1 · max: 50Optional

biostring · max: 240Optional

statusstring · enumOptionalPossible values:

avatarUrlstringOptional

wrapUpTimeinteger · max: 900Optional

timezonestringOptional

defaultCountryCodestringOptional

defaultCallerIdstringOptional

transcriptionLocalestring · enumOptional

Curated set of BCP47 locale identifiers supported by Bird speech-to-text products

Possible values:

defaultSenderIdstring · uuidOptional

The default Sender Profile to select for this agent when composing a new message.

outOfOfficeResponsestring · max: 1000Optional

Responses

200

Updated

application/json

idstringRequired

statusstring · enumOptionalPossible values:

statusBeforeOfflinestring · enumOptionalPossible values:

namestring · min: 1 · max: 50Optional

overrideNamebooleanOptional

workspaceIdstringRequired

typestring · enumOptionalPossible values:

userEmailsstring[]Optional

biostring · max: 240Optional

avatarUrlstringOptional

tagCountintegerOptional

wrapUpTimeinteger · max: 900Optional

rootItemAssignedCountintegerOptionalDeprecated

lastAssignedAtstring · date-timeOptional

lastSetToAwayAtstring · date-timeOptional

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

timezonestringOptional

defaultCountryCodestringOptional

defaultCallerIdstringOptional

transcriptionLocalestring · enumOptional

Curated set of BCP47 locale identifiers supported by Bird speech-to-text products

Possible values:

defaultSenderIdstring · uuidOptional

The default Sender Profile to select for this agent when composing a new message.

outOfOfficeResponsestring · max: 1000Optional

404

The requested resource was not found.

application/json

422

The request contains invalid parameters or body fields.

application/json

patch

/workspaces/{workspaceId}/agents/{agentId}

HTTPcURLJavaScriptPython

PATCH /workspaces/{workspaceId}/agents/{agentId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1088

{
  "name": "text",
  "bio": "text",
  "status": "active",
  "avatarUrl": "text",
  "dropVms": [
    null
  ],
  "wrapUpTime": 1,
  "timezone": "text",
  "defaultCountryCode": "text",
  "defaultCallerId": "text",
  "forwardNumber": {
    "enabled": true,
    "number": "text",
    "maskCaller": true
  },
  "transcriptionLocale": "ar-AE",
  "weeklySchedule": {
    "monday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "tuesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "wednesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "thursday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "friday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "saturday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "sunday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    }
  },
  "holidays": [
    {
      "name": "text",
      "day": 1,
      "month": 1
    }
  ],
  "assignedSkills": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "selectedValues": [
        {
          "icon": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "value": "text"
        }
      ],
      "valueType": "single"
    }
  ],
  "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
  "outOfOfficeResponse": "text"
}

{
  "id": "text",
  "status": "active",
  "statusBeforeOffline": "active",
  "name": "text",
  "overrideName": true,
  "workspaceId": "text",
  "type": "user",
  "userEmails": [
    "text"
  ],
  "bio": "text",
  "avatarUrl": "text",
  "dropVms": [
    null
  ],
  "tagCount": 1,
  "wrapUpTime": 1,
  "lastAssignedAt": "2026-05-16T21:13:22.833Z",
  "lastSetToAwayAt": "2026-05-16T21:13:22.833Z",
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2026-05-16T21:13:22.833Z",
      "activeMemberCount": 1,
      "pendingMemberCount": 1
    }
  ],
  "workload": {
    "id": "text",
    "workload": {
      "messaging": 1,
      "email": 1
    },
    "rule": {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "default": true,
      "capacity": {
        "messaging": 1,
        "email": 1
      },
      "assignedAgentIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "createdAt": "text",
      "updatedAt": "text"
    },
    "ruleId": "text",
    "updatedAt": "2026-05-16T21:13:22.833Z"
  },
  "createdAt": "2026-05-16T21:13:22.833Z",
  "updatedAt": "2026-05-16T21:13:22.833Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 1,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2026-05-16T21:13:22.833Z"
  },
  "timezone": "text",
  "defaultCountryCode": "text",
  "defaultCallerId": "text",
  "forwardNumber": {
    "enabled": true,
    "number": "text",
    "maskCaller": true
  },
  "transcriptionLocale": "ar-AE",
  "roles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "avatarUrl": "text",
    "defaultEmail": "text",
    "phoneNumber": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "weeklySchedule": {
    "monday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "tuesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "wednesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "thursday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "friday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "saturday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "sunday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    }
  },
  "holidays": [
    {
      "name": "text",
      "day": 1,
      "month": 1
    }
  ],
  "assignedSkills": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "selectedValues": [
        {
          "icon": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "value": "text"
        }
      ],
      "valueType": "single"
    }
  ],
  "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
  "outOfOfficeResponse": "text"
}

Delete Agent

delete

Remove a specific agent from the system, permanently deleting their profile and associated data.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstring · uuidRequired

The unique identifier of the workspace.

agentIdstringRequired

Responses

204

Deleted

404

The requested resource was not found.

application/json

delete

/workspaces/{workspaceId}/agents/{agentId}

HTTPcURLJavaScriptPython

DELETE /workspaces/{workspaceId}/agents/{agentId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Agent

get

Retrieve information about a specific agent, including their name, bio, status.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstring · uuidRequired

The unique identifier of the workspace.

Responses

200

OK

application/json

idstringRequired

statusstring · enumOptionalPossible values:

statusBeforeOfflinestring · enumOptionalPossible values:

namestring · min: 1 · max: 50Optional

overrideNamebooleanOptional

workspaceIdstringRequired

typestring · enumOptionalPossible values:

userEmailsstring[]Optional

biostring · max: 240Optional

avatarUrlstringOptional

tagCountintegerOptional

wrapUpTimeinteger · max: 900Optional

rootItemAssignedCountintegerOptionalDeprecated

lastAssignedAtstring · date-timeOptional

lastSetToAwayAtstring · date-timeOptional

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

timezonestringOptional

defaultCountryCodestringOptional

defaultCallerIdstringOptional

transcriptionLocalestring · enumOptional

Curated set of BCP47 locale identifiers supported by Bird speech-to-text products

Possible values:

defaultSenderIdstring · uuidOptional

The default Sender Profile to select for this agent when composing a new message.

outOfOfficeResponsestring · max: 1000Optional

404

The requested resource was not found.

application/json

get

/workspaces/{workspaceId}/agents/me

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/agents/me HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "status": "active",
  "statusBeforeOffline": "active",
  "name": "text",
  "overrideName": true,
  "workspaceId": "text",
  "type": "user",
  "userEmails": [
    "text"
  ],
  "bio": "text",
  "avatarUrl": "text",
  "dropVms": [
    null
  ],
  "tagCount": 1,
  "wrapUpTime": 1,
  "lastAssignedAt": "2026-05-16T21:13:22.833Z",
  "lastSetToAwayAt": "2026-05-16T21:13:22.833Z",
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2026-05-16T21:13:22.833Z",
      "activeMemberCount": 1,
      "pendingMemberCount": 1
    }
  ],
  "workload": {
    "id": "text",
    "workload": {
      "messaging": 1,
      "email": 1
    },
    "rule": {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "default": true,
      "capacity": {
        "messaging": 1,
        "email": 1
      },
      "assignedAgentIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "createdAt": "text",
      "updatedAt": "text"
    },
    "ruleId": "text",
    "updatedAt": "2026-05-16T21:13:22.833Z"
  },
  "createdAt": "2026-05-16T21:13:22.833Z",
  "updatedAt": "2026-05-16T21:13:22.833Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 1,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2026-05-16T21:13:22.833Z"
  },
  "timezone": "text",
  "defaultCountryCode": "text",
  "defaultCallerId": "text",
  "forwardNumber": {
    "enabled": true,
    "number": "text",
    "maskCaller": true
  },
  "transcriptionLocale": "ar-AE",
  "roles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "avatarUrl": "text",
    "defaultEmail": "text",
    "phoneNumber": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "weeklySchedule": {
    "monday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "tuesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "wednesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "thursday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "friday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "saturday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "sunday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    }
  },
  "holidays": [
    {
      "name": "text",
      "day": 1,
      "month": 1
    }
  ],
  "assignedSkills": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "selectedValues": [
        {
          "icon": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "value": "text"
        }
      ],
      "valueType": "single"
    }
  ],
  "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
  "outOfOfficeResponse": "text"
}

Update Agent

patch

Modify the details of a specific agent, such as their name, bio, status.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstring · uuidRequired

The unique identifier of the workspace.

Body

application/json

namestring · min: 1 · max: 50Optional

biostring · max: 240Optional

statusstring · enumOptionalPossible values:

avatarUrlstringOptional

wrapUpTimeinteger · max: 900Optional

timezonestringOptional

defaultCountryCodestringOptional

defaultCallerIdstringOptional

transcriptionLocalestring · enumOptional

Curated set of BCP47 locale identifiers supported by Bird speech-to-text products

Possible values:

defaultSenderIdstring · uuidOptional

The default Sender Profile to select for this agent when composing a new message.

outOfOfficeResponsestring · max: 1000Optional

Responses

200

Updated

application/json

idstringRequired

statusstring · enumOptionalPossible values:

statusBeforeOfflinestring · enumOptionalPossible values:

namestring · min: 1 · max: 50Optional

overrideNamebooleanOptional

workspaceIdstringRequired

typestring · enumOptionalPossible values:

userEmailsstring[]Optional

biostring · max: 240Optional

avatarUrlstringOptional

tagCountintegerOptional

wrapUpTimeinteger · max: 900Optional

rootItemAssignedCountintegerOptionalDeprecated

lastAssignedAtstring · date-timeOptional

lastSetToAwayAtstring · date-timeOptional

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

timezonestringOptional

defaultCountryCodestringOptional

defaultCallerIdstringOptional

transcriptionLocalestring · enumOptional

Curated set of BCP47 locale identifiers supported by Bird speech-to-text products

Possible values:

defaultSenderIdstring · uuidOptional

The default Sender Profile to select for this agent when composing a new message.

outOfOfficeResponsestring · max: 1000Optional

404

The requested resource was not found.

application/json

422

The request contains invalid parameters or body fields.

application/json

patch

/workspaces/{workspaceId}/agents/me

HTTPcURLJavaScriptPython

PATCH /workspaces/{workspaceId}/agents/me HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1088

{
  "name": "text",
  "bio": "text",
  "status": "active",
  "avatarUrl": "text",
  "dropVms": [
    null
  ],
  "wrapUpTime": 1,
  "timezone": "text",
  "defaultCountryCode": "text",
  "defaultCallerId": "text",
  "forwardNumber": {
    "enabled": true,
    "number": "text",
    "maskCaller": true
  },
  "transcriptionLocale": "ar-AE",
  "weeklySchedule": {
    "monday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "tuesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "wednesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "thursday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "friday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "saturday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "sunday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    }
  },
  "holidays": [
    {
      "name": "text",
      "day": 1,
      "month": 1
    }
  ],
  "assignedSkills": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "selectedValues": [
        {
          "icon": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "value": "text"
        }
      ],
      "valueType": "single"
    }
  ],
  "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
  "outOfOfficeResponse": "text"
}

{
  "id": "text",
  "status": "active",
  "statusBeforeOffline": "active",
  "name": "text",
  "overrideName": true,
  "workspaceId": "text",
  "type": "user",
  "userEmails": [
    "text"
  ],
  "bio": "text",
  "avatarUrl": "text",
  "dropVms": [
    null
  ],
  "tagCount": 1,
  "wrapUpTime": 1,
  "lastAssignedAt": "2026-05-16T21:13:22.833Z",
  "lastSetToAwayAt": "2026-05-16T21:13:22.833Z",
  "teams": [
    {
      "id": "text",
      "name": "text",
      "memberSince": "2026-05-16T21:13:22.833Z",
      "activeMemberCount": 1,
      "pendingMemberCount": 1
    }
  ],
  "workload": {
    "id": "text",
    "workload": {
      "messaging": 1,
      "email": 1
    },
    "rule": {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "default": true,
      "capacity": {
        "messaging": 1,
        "email": 1
      },
      "assignedAgentIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "createdAt": "text",
      "updatedAt": "text"
    },
    "ruleId": "text",
    "updatedAt": "2026-05-16T21:13:22.833Z"
  },
  "createdAt": "2026-05-16T21:13:22.833Z",
  "updatedAt": "2026-05-16T21:13:22.833Z",
  "availability": {
    "status": "active",
    "activity": "available",
    "activityTtl": 1,
    "activityText": "text",
    "lastStatusSet": "text",
    "lastActivitySet": "text",
    "updatedAt": "2026-05-16T21:13:22.833Z"
  },
  "timezone": "text",
  "defaultCountryCode": "text",
  "defaultCallerId": "text",
  "forwardNumber": {
    "enabled": true,
    "number": "text",
    "maskCaller": true
  },
  "transcriptionLocale": "ar-AE",
  "roles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "organization",
      "workspaces": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "avatarUrl": "text",
    "defaultEmail": "text",
    "phoneNumber": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "weeklySchedule": {
    "monday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "tuesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "wednesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "thursday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "friday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "saturday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "sunday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    }
  },
  "holidays": [
    {
      "name": "text",
      "day": 1,
      "month": 1
    }
  ],
  "assignedSkills": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "selectedValues": [
        {
          "icon": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "value": "text"
        }
      ],
      "valueType": "single"
    }
  ],
  "defaultSenderId": "123e4567-e89b-12d3-a456-426614174000",
  "outOfOfficeResponse": "text"
}

Get Agent Availability

get

Retrieve information about availability of a specific agent.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstring · uuidRequired

The unique identifier of the workspace.

agentIdstringRequired

Responses

200

OK

application/json

statusstring · enumOptionalPossible values:

activitystring · enumOptionalPossible values:

activityTtlinteger · min: 10 · max: 86400Optional

activityTextstring · max: 48Optional

lastStatusSetstringOptional

lastActivitySetstringOptional

updatedAtstring · date-timeOptional

404

The requested resource was not found.

application/json

get

/workspaces/{workspaceId}/agents/{agentId}/availability

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/agents/{agentId}/availability HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "active",
  "activity": "available",
  "activityTtl": 1,
  "activityText": "text",
  "lastStatusSet": "text",
  "lastActivitySet": "text",
  "updatedAt": "2026-05-16T21:13:22.833Z"
}

Update Agent Availability

patch

Modify the availability of a specific agent.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstring · uuidRequired

The unique identifier of the workspace.

agentIdstringRequired

Body

application/json

statusstring · enumRequiredPossible values:

activitystring · enumOptionalPossible values:

activityTtlinteger · min: 10 · max: 86400Optional

activityTextstring · max: 48Optional

Responses

200

Updated

application/json

statusstring · enumOptionalPossible values:

activitystring · enumOptionalPossible values:

activityTtlinteger · min: 10 · max: 86400Optional

activityTextstring · max: 48Optional

lastStatusSetstringOptional

lastActivitySetstringOptional

updatedAtstring · date-timeOptional

404

The requested resource was not found.

application/json

422

The request contains invalid parameters or body fields.

application/json

patch

/workspaces/{workspaceId}/agents/{agentId}/availability

HTTPcURLJavaScriptPython

PATCH /workspaces/{workspaceId}/agents/{agentId}/availability HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "status": "active",
  "activity": "available",
  "activityTtl": 1,
  "activityText": "text"
}

{
  "status": "active",
  "activity": "available",
  "activityTtl": 1,
  "activityText": "text",
  "lastStatusSet": "text",
  "lastActivitySet": "text",
  "updatedAt": "2026-05-16T21:13:22.833Z"
}

Get Agent Workload

get

Retrieve information about workload of a specific agent.

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstring · uuidRequired

The unique identifier of the workspace.

agentIdstringRequired

Responses

200

OK

application/json

idstringOptional

ruleIdstringOptional

updatedAtstring · date-timeOptional

404

The requested resource was not found.

application/json

get

/workspaces/{workspaceId}/agents/{agentId}/workload

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/agents/{agentId}/workload HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "workload": {
    "messaging": 1,
    "email": 1
  },
  "rule": {
    "id": "text",
    "workspaceId": "text",
    "name": "text",
    "description": "text",
    "default": true,
    "capacity": {
      "messaging": 1,
      "email": 1
    },
    "assignedAgentIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "createdAt": "text",
    "updatedAt": "text"
  },
  "ruleId": "text",
  "updatedAt": "2026-05-16T21:13:22.833Z"
}