Skip to content

List products, plans and services

GET
/products/{productId}/catalog
curl --request GET \
--url 'https://api.motenya.app/v1/products/example/catalog?kind=product' \
--header 'Authorization: Bearer <token>'

What the product sells. Items with an interval bill on a schedule (plans and recurring products).

Requires crm:read.

productId
required
string
>= 1 characters <= 64 characters
first

Page size, 1–100 (default 25).

integer
>= 1 <= 100

Page size, 1–100 (default 25).

after

The nextCursor of the previous page.

string
<= 500 characters

The nextCursor of the previous page.

search

Name or SKU.

string
<= 200 characters

Name or SKU.

kind
string
Allowed values: product plan service
storeId
string
>= 1 characters <= 64 characters
includeArchived
Any of:
boolean

Success

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
>= 1 characters <= 64 characters
name
required
string
sku
required
string | null
kind
required
string
Allowed values: product plan service
price
required
string | null
currency
required
string | null
interval
required
string | null
Allowed values: day week month year
intervalCount
required
integer
storeId
required
string | null
>= 1 characters <= 64 characters
custom
required
object
key
additional properties
source
required
string
externalId
required
string | null
archived
required
boolean
createdAt
required
string
updatedAt
required
string
key
additional properties
nextCursor
required

Pass as after for the next page; null on the last.

string | null

Example

{
"items": [
{
"kind": "product",
"interval": "day"
}
]
}

Invalid request

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Missing, invalid, revoked or expired API key

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Missing scope, API turned off, published article without publish scope, or account suspended

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Not found, or outside the knowledge bases this key may use

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Slug or translation already exists

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Rejected by validation (e.g. unknown language or category)

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Rate limited; see Retry-After

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Internal error