Inbound

Get Inbounds

Retrieves all inbounds

get/v1/Inbound

Request

Base URL
https://api.nlpearl.ai
Auth
HTTP bearer
TypeScript
https://skmtc.dev/nlpearl/apis/nlpearl-client-api/docs/v1/Inbound/get.ts
A function with typed inputs. Its response is checked against the schema.

List of all inbound for the client.

idstring nullable

The unique identifier of the inboundy.

namestring nullable

The name of the inbound.

totalAgentsinteger

The total number of agents allocated to this inbound.

statusinteger

Here is the activity status

1 - Running

2 - Paused

3 - Suspended

10 - TemporaryMaintenance

createdstring date-time

The date and time when the inbound was created.

No recorded changes to this operation across all 1 revision of this API.