Categories

methods allow you to get a list of portal brands or information on a specific brand \get\ /categories return a list of categories { "tab" "request", "url" "https //instance name/api/data/v1 0/categories/", "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\\" 45,\n \\"next\\" \\"https //test eyrene com/api/data/v1 0/categories/?limit=30\&offset=30\\",\n \\"previous\\"\ null,\n \\"results\\" \[\n {\n \\"id\\" 236,\n \\"name\\" \\"candies\\"\n },\n {\n \\"id\\" 240,\n \\"name\\" \\"chocolate sticks\\"\n },\n {\n \\"id\\" 255,\n \\"name\\" \\"coffee\\"\n },\n {\n \\"id\\" 257,\n \\"name\\" \\"coffee capsules\\"\n },\n {\n \\"id\\" 258,\n \\"name\\" \\"cat food\\"\n },\n {\n \\"id\\" 260,\n \\"name\\" \\"dog food\\"\n },\n {\n \\"id\\" 261,\n \\"name\\" \\"fruit puree\\"\n },\n {\n \\"id\\" 263,\n \\"name\\" \\"juice drink\\"\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/categories/\n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’\n –f \\"offset=30\\"", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "dpmodah zaotktusexn5x" }, "description" "get /categories", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "autogeneratedanchorslug" "request example", "legacyhash" "dzcdkam2qb8jsy16vzyqh" } response parameters https //help inspector cloud com/en/docs/api/backend/methods/v1/agents/agents list#response definitions count integer the number of categories next string (uri) \nullable\ next page previous string (uri) \nullable\ previous page results array of objects an array of objects with information about categories id integer category id name string \\[ 1 255 ] characters\ category name \get\ /categories/{id} returns information about the category by id { "tab" "request", "url" "https //instance name/api/data/v1 0/categories/{id}", "name" "request example", "method" "get", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "category 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\\" \\"cat food\\"\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/categories/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 /categories/{id}", "currentnewparameter" { "label" "path parameter", "value" "pathparameters" }, "autogeneratedanchorslug" "request example 1", "legacyhash" "wu7gpqkdpiekw0pseegw3" } response parameters https //help inspector cloud com/en/docs/api/backend/methods/v1/agents/agents read#response definitions id integer category id name string \\[ 1 255 ] characters\ category name