GET/api/v1/products/{id}

Get product

Returns a single product catalog entry by UUID.

RBAC · service

Path parameters

idstring <uuid>Required

Product UUID.

Response body

Success response 200 · schema ProductEnvelope

dataobjectRequired

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

metaobject

Response codes

200

Product returned successfully.

401

Authentication failed.

403

Authenticated user lacks the required permission.

404

Product not found.

GET /api/v1/products/{id}

cURL

curl -X GET "https://algapsa.com/api/v1/products/{id}" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/products/{id}", {
  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/{id}");
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
      }
    ]
  },
  "meta": {}
}