Agents

methods allow you to get a list of portal agents or information on a specific agent get get /agents return a list of agents { "tab" "request", "url" "https //instance name/api/data/v1 0/agents/", "name" "request example", "method" "get", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "description" "string in \\"token xxxxxx \\" format " } ], "bodydataparameters" \[ { "kind" "optional", "name" "limit", "type" "integer", "description" "the number of results to return per page " }, { "kind" "optional", "name" "offset", "type" "integer", "description" "the initial index from which to return the results " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "fj3zsbaijz6tuvfi40xny", "code" "{\n \\"count\\" 3,\n \\"next\\"\ null,\n \\"previous\\"\ null,\n \\"results\\" \[\n {\n \\"id\\" 23679,\n \\"name\\" \\"alex\\",\n \\"route\\" \\"163968\\",\n \\"agent role\\"\ null\n },\n {\n \\"id\\" 36777,\n \\"name\\" \\"gina\\",\n \\"route\\" \\"283140\\",\n \\"agent role\\"\ null\n },\n {\n \\"id\\" 32410,\n \\"name\\" \\"john\\",\n \\"route\\" \\"154039\\",\n \\"agent role\\"\ null\n }\n ]\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "fj3zsbaijz6tuvfi40xny" }, "examples" { "languages" \[ { "id" "dpmodah zaotktusexn5x", "code" "curl –i –x get\n https //test eyrene com/api/data/v1 0/agents/ \n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’\n –f \\"limit=3\\" \\\\\n –f \\"offset=0\\" ", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "dpmodah zaotktusexn5x" }, "description" "get /agents", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } response parameters ​ https //help inspector cloud com/en/docs/api/backend/methods/v1/agents/agents list#response definitions count integer the number of agents next string (uri) nullable nullable next page previous string (uri) nullable nullable previous page results array of objects an array of objects with information about agents id integer agent id name string \[ 1 255 ] characters \[ 1 255 ] characters agent name route string <= 255 characters nullable <= 255 characters nullable agent route agent role string <= 255 characters <= 255 characters agent role get get /agents/{id} return information about the agent by id { "tab" "request", "url" "https //instance name/api/data/v1 0/agents/{id}", "name" "request example", "method" "get", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "agent id " } ], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "description" "string in \\"token xxxxxx \\" format " } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "fj3zsbaijz6tuvfi40xny", "code" "{\n \\"id\\" 19765,\n \\"name\\" \\"alex\\",\n \\"route\\" \\"163968\\",\n \\"agent role\\"\ null\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "fj3zsbaijz6tuvfi40xny" }, "examples" { "languages" \[ { "id" "dpmodah zaotktusexn5x", "code" "curl –i –x get\n https //test eyrene com/api/data/v1 0/agents/19765/ \n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’ \n –f \\"limit=3\\" \\\\\n –f \\"offset=0\\" ", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "dpmodah zaotktusexn5x" }, "description" "get /agents/{id}", "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } response parameters ​ https //help inspector cloud com/en/docs/api/backend/methods/v1/agents/agents read#response definitions id integer agent id name string \[ 1 255 ] characters \[ 1 255 ] characters agent name route string <= 255 characters nullable <= 255 characters nullable agent route agent role string <= 255 characters <= 255 characters agent role