Skip to content
Crossmart Docs

Suggestions, newest first

GET
/api/v1/workspaces/{workspaceId}/suggestions
curl --request GET \
  --url 'https://api.crossmart.io/api/v1/workspaces/example/suggestions?status=PENDING&kind=listing_title&limit=25'

Filter by PENDING for the inbox.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspaceId
required
string

Query Parameters

Section titled “Query Parameters”
status
string
Allowed values: PENDING APPLIED REJECTED STALE

PENDING is the inbox

productId
string format: uuid

Suggestions for one product

connectionId
string format: uuid

Suggestions for one store

kind
string
Allowed values: listing_title listing_description
cursor
string format: uuid

nextCursor from the previous page

page
number
>= 1

1-based page number, for tables with page numbers. It wins over cursor.

limit
number
default: 25 >= 1 <= 100

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
items
required
Array<object>
object
id
required
string format: uuid
productId
required
string format: uuid
productTitle
required
string
imageUrl
required
string
nullable
connection
required

The store the change is for; null for the product’s own content

object
id
required
string format: uuid
channel
required
string
Allowed values: shopify ebay google_merchant etsy amazon walmart
displayName
required
string
kind
required
string
Allowed values: listing_title listing_description
status
required
string
Allowed values: PENDING APPLIED REJECTED STALE
currentValue
required

The value it replaces, as it was when it was made

string
proposedValue
required
string
rationale
required

Why the agent proposes it

string
createdBy
required
object
type
required
string
Allowed values: AGENT USER API_KEY
agent
required

The agent that made it, for AGENT suggestions

string
Allowed values: content_generator
userId
required

Who asked for it

string format: uuid
nullable
apiKeyId
required
string format: uuid
nullable
name
required

The user’s or API key’s name

string
nullable
review
required
object
userId
required
string format: uuid
nullable
apiKeyId
required
string format: uuid
nullable
name
required
string
nullable
reviewedAt
required
string format: date-time
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
nextCursor
required

Null on the last page

string
nullable
total
required

How many match in all, for page numbers

number

Example 

{
  "items": [
    {
      "productTitle": "Stoneware Mug",
      "connection": {
        "channel": "shopify",
        "displayName": "Demo Store"
      },
      "kind": "listing_title",
      "status": "PENDING",
      "createdBy": {
        "type": "AGENT",
        "agent": "content_generator"
      }
    }
  ]
}