Skip to content
Systey

Your products

Request, parameters and responses for this API endpoint.

GET/api/v1/customer/products

Overview

This endpoint requires an active API key with read access.

Headers & parameters

AuthorizationBearer $SYSTEY_API_KEY · required

limitquery · optional

{"type":"integer","minimum":1,"maximum":100,"default":25}

cursorquery · optional

{"type":"string","format":"uuid"}

categoryquery · optional

{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"string","enum":["VPS","DOMAIN","WEBSPACE","DEVELOPMENT","MANAGED_SERVICE"]}

statusquery · optional

{"enum":["ACTIVE","PAUSED","CANCELLED"]}

Example request

Replace placeholders with your own values. Persist $REQUEST_UUID before a mutation if this endpoint requires an Idempotency-Key.

cURL
curl -i -X GET "https://systey.com/api/v1/customer/products" \
  -H "Authorization: Bearer $SYSTEY_API_KEY"

Response

HTTP 200
Schema fields and requirements
FieldTypeRequired
dataarrayYes
data[]object—
data[].id

uuid

stringYes
data[].namestringYes
data[].descriptionstring | nullYes
data[].specificationItemsarrayYes
data[].specificationItems[]object—
data[].specificationItems[].labelstringYes
data[].specificationItems[].valuestringYes
data[].status

"ACTIVE" | "PAUSED" | "CANCELLED"

stringYes
data[].sandboxbooleanYes
data[].category

string | null

string | nullYes
data[].priceCentsintegerYes
data[].billingCycle

"ONCE" | "MONTHLY" | "YEARLY"

stringYes
data[].commercialModel

"CONTRACT" | "PREPAID"

stringYes
data[].renewalMode

"NONE" | "AUTOMATIC" | "CUSTOMER"

stringYes
data[].contractTermMonthsnumber | nullYes
data[].minimumTermMonthsnumber | nullYes
data[].renewalMonthsnumber | nullYes
data[].noticeDaysnumber | nullYes
data[].serviceStartedAt

date-time | null

string | nullYes
data[].serviceEndsAt

date-time | null

string | nullYes
data[].cancelRequestedAt

date-time | null

string | nullYes
data[].cancelEffectiveAt

date-time | null

string | nullYes
data[].hostnamestring | nullYes
data[].ipAddressstring | nullYes
data[].createdAt

date-time

stringYes
data[].updatedAt

date-time

stringYes
data[].domain

object | null

object | nullYes
data[].domain.namestringYes
data[].domain.statusstringYes
data[].domain.expiresAt

date-time | null

string | nullYes
data[].domain.sandboxbooleanYes
nextCursorstring | nullYes

Errors

Error responses contain error and optionally message and details. Rate limit: 120 requests per minute per key. On HTTP 429 respect Retry-After.