GET/api/v1/products

List products

Returns product catalog entries where item_kind is product. Use this endpoint to inspect existing product catalog records and to gather prerequisite IDs such as custom_service_type_id and category_id before creating a new product.

RBAC · service

Query parameters

pageintegerOptional

limitintegerOptional

sortstringOptional

orderstringOptional

searchstringOptional

is_activeanyOfOptional

category_idanyOfOptional

is_licenseanyOfOptional

Response body

Success response 200 · schema PaginatedProductEnvelope

dataarray of ProductCatalogEntryRequired

itemsobject

Product catalog entry.

service_idstring <uuid>Required

tenantstring <uuid>Required

service_namestringRequired

custom_service_type_idstring <uuid>Required

billing_methodstringRequired

Enum: usage

default_ratenumberRequired

unit_of_measurestringRequired

category_idstring <uuid>Nullable

tax_rate_idstring <uuid>Nullable

descriptionstringNullable

item_kindstringRequired

Enum: product

is_activeboolean

skustringNullable

costnumberNullable

cost_currencystringNullable

min length 3 · max length 3

vendorstringNullable

manufacturerstringNullable

product_categorystringNullable

is_licenseboolean

license_termstringNullable

license_billing_cadencestringNullable

service_type_namestring

pricesarray of ProductPrice

itemsobject

currency_codestringRequired

min length 3 · max length 3

ratenumberRequired

paginationobjectRequired

pageintegerRequired

limitintegerRequired

totalintegerRequired

totalPagesintegerRequired

hasNextbooleanRequired

hasPrevbooleanRequired

metaobject

Response codes

200

Products returned successfully.

401

Authentication failed.

403

Authenticated user lacks the required permission.

GET /api/v1/products

cURL

curl -X GET "https://algapsa.com/api/v1/products?page=1&limit=25&sort=service_name&order=asc&search=string&is_active=true" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/products?page=1&limit=25&sort=service_name&order=asc&search=string&is_active=true", {
  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/products?page=1&limit=25&sort=service_name&order=asc&search=string&is_active=true");
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": [
    {
      "service_id": "01HN2K7VRB9PQ3Y0000000000",
      "tenant": "01HN2K7VRB9PQ3Y0000000000",
      "service_name": "string",
      "custom_service_type_id": "01HN2K7VRB9PQ3Y0000000000",
      "billing_method": "usage",
      "default_rate": 0,
      "unit_of_measure": "string",
      "category_id": "01HN2K7VRB9PQ3Y0000000000",
      "tax_rate_id": "01HN2K7VRB9PQ3Y0000000000",
      "description": "string",
      "item_kind": "product",
      "is_active": false,
      "sku": "string",
      "cost": 0,
      "cost_currency": "xxx",
      "vendor": "string",
      "manufacturer": "string",
      "product_category": "string",
      "is_license": false,
      "license_term": "string",
      "license_billing_cadence": "string",
      "service_type_name": "string",
      "prices": [
        {
          "currency_code": "xxx",
          "rate": 0
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 1,
    "total": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrev": false
  },
  "meta": {}
}