Search categories

Searches categories across service/ticket types. Permission resource is chosen dynamically from category_type (defaults to ticket_settings when omitted).

Query parameters

search_termstringRequired

category_typestringOptional

board_idstring <uuid>Optional

include_inactivestringOptional

limitstringOptional

offsetstringOptional

Response body

Success response 200

dataarray of objectRequired

itemsobject

paginationobjectRequired

metaobject

Response codes

200

Category search results returned.

400

Invalid query parameters.

401

Authentication failed.

403

Authenticated user lacks the derived settings read permission.

GET /api/v1/categories/search

cURL

curl -X GET "https://algapsa.com/api/v1/categories/search?search_term=x&category_type=service&board_id=01HN2K7VRB9PQ3Y0000000000&include_inactive=true&limit=string&offset=string" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/categories/search?search_term=x&category_type=service&board_id=01HN2K7VRB9PQ3Y0000000000&include_inactive=true&limit=string&offset=string", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/v1/categories/search?search_term=x&category_type=service&board_id=01HN2K7VRB9PQ3Y0000000000&include_inactive=true&limit=string&offset=string");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": [
    {}
  ],
  "pagination": {},
  "meta": {}
}