Skip to content

List or search clients

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

Customers that are companies or individuals (accounts, for SaaS), each with its contacts.

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.

customKey

A filterable custom field key; use with customValue.

string
<= 64 characters

A filterable custom field key; use with customValue.

customValue
string
<= 200 characters
search

Name, VAT or registration number.

string
<= 200 characters

Name, VAT or registration number.

tag
string
<= 50 characters
kind
string
Allowed values: company individual

Success

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
>= 1 characters <= 64 characters
name
required
string
kind
required
string
Allowed values: company individual
vatNumber
required
string | null
registrationNumber
required
string | null
addresses
required
Array<object>
object
label
required
string | null
line1
required
string
line2
required
string | null
city
required
string
region
required
string | null
postalCode
required
string | null
country
required
string
tags
required
Array<string>
custom
required
object
key
additional properties
source
required
string
externalId
required
string | null
contacts
required
Array<object>
object
contactId
required
string
>= 1 characters <= 64 characters
name
required
string | null
email
required
string | null
role
required
string | null
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": "company"
}
]
}

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