Services API
GET/api/v1/services
Product availabilityAlgaPSA

List services

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

RBAC · service

Query parameters

pageintegerOptional
limitintegerOptional
sortstringOptional
orderstringOptional
searchstringOptional
item_kindstringOptional
is_activeanyOfOptional
billing_methodstringOptional
category_idanyOfOptional
custom_service_type_idstring <uuid>Optional

Response body

Success response 200 · schema PaginatedServiceEnvelope

dataarray of ServiceCatalogEntryRequired
itemsobject
Service catalog entry.
service_idstring <uuid>Required
tenantstring <uuid>Required
service_namestringRequired
custom_service_type_idstring <uuid>Required
billing_methodstringRequired
Enum: fixedhourlyusage
default_ratenumberRequired
unit_of_measurestringRequired
unit_codestringNullable
category_idstring <uuid>Nullable
tax_rate_idstring <uuid>Nullable
descriptionstringNullable
item_kindstring
Enum: serviceproduct
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 ServicePrice
Current price per currency (latest effective on or before today).
itemsobject
currency_codestringRequired
min length 3 · max length 3
ratenumberRequired
Rate in integer minor units (e.g. cents).
display_orderinteger
Position within its window; 0 is the primary price. Responses are sorted by display_order, then currency_code.
effective_datestringNullable
Calendar date the price takes effect; the epoch when untagged.
scheduled_pricesarray of ServicePrice
Future-dated prices that are not yet billed.
itemsobject
currency_codestringRequired
min length 3 · max length 3
ratenumberRequired
Rate in integer minor units (e.g. cents).
display_orderinteger
Position within its window; 0 is the primary price. Responses are sorted by display_order, then currency_code.
effective_datestringNullable
Calendar date the price takes effect; the epoch when untagged.
paginationobjectRequired
pageintegerRequired
limitintegerRequired
totalintegerRequired
totalPagesintegerRequired
hasNextbooleanRequired
hasPrevbooleanRequired
metaobject

Response codes

200
Services returned successfully.
401
Authentication failed.
403
Authenticated user lacks the required permission.