SalesOS

Marketplace

Approved marketplace apps: search, categories, listing detail with requested scopes, reviews (no auth)

Search approved marketplace listings

GET
/v1/marketplace/listings

Query Parameters

qstring

Search name, tagline, publisher and description

Maximum length: 100
categorystring

A category key from GET /marketplace/categories

Maximum length: 40
sortstring
Value in: "popular" | "rating" | "newest" | "name"
pagenumber
Default: 1Minimum: 1Maximum: 1000
limitnumber
Default: 24Minimum: 1Maximum: 50
curl -X GET "https://api.salesos.org/v1/marketplace/listings?q=%3Cstring%3E&category=%3Cstring%3E&sort=popular&page=1&limit=24"

MarketplaceListingPage

{
  "data": [
    {
      "id": "string",
      "slug": "string",
      "appId": "string",
      "name": "string",
      "tagline": "string",
      "categories": [
        "string"
      ],
      "icon": "string",
      "pricing": "FREE",
      "publisher": {
        "name": "string",
        "verified": true,
        "verifiedDomains": [
          "string"
        ]
      },
      "version": "string",
      "versionId": "string",
      "installCount": 0,
      "rating": {
        "average": 0,
        "count": 0
      },
      "approvedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "page": 0,
  "limit": 0,
  "total": 0,
  "totalPages": 0,
  "hasMore": true
}

Marketplace categories with listing counts

GET
/v1/marketplace/categories
curl -X GET "https://api.salesos.org/v1/marketplace/categories"

MarketplaceCategoryArray

[
  {
    "key": "string",
    "label": "string",
    "count": 0
  }
]

One approved listing: description, screenshots, requested scopes in plain language, components

GET
/v1/marketplace/listings/{slug}

Path Parameters

slugRequiredstring
curl -X GET "https://api.salesos.org/v1/marketplace/listings/<string>"

MarketplaceListingDetail

{
  "id": "string",
  "slug": "string",
  "appId": "string",
  "name": "string",
  "tagline": "string",
  "categories": [
    "string"
  ],
  "icon": "string",
  "pricing": "FREE",
  "publisher": {
    "name": "string",
    "verified": true,
    "verifiedDomains": [
      "string"
    ],
    "website": "string"
  },
  "version": "string",
  "versionId": "string",
  "installCount": 0,
  "rating": {
    "average": 0,
    "count": 0
  },
  "approvedAt": "2019-08-24T14:15:22Z",
  "description": "string",
  "screenshots": [
    "string"
  ],
  "pricingNote": "string",
  "urls": {
    "homepage": "string",
    "support": "string",
    "supportEmail": "string",
    "privacyPolicy": "string",
    "termsOfService": "string"
  },
  "scopes": [
    {
      "scope": "string",
      "description": "string",
      "justification": "string"
    }
  ],
  "components": {
    "customObjects": [
      {
        "key": "string",
        "label": "string",
        "fields": 0
      }
    ],
    "customFields": [
      {
        "key": "string",
        "object": "string",
        "label": "string",
        "type": "string"
      }
    ],
    "customActions": [
      {
        "key": "string",
        "label": "string",
        "kind": "READ",
        "url": "string"
      }
    ],
    "beforeSaveHooks": [
      {
        "key": "string",
        "name": "string",
        "objectType": "string",
        "operations": [
          "string"
        ],
        "failureMode": "FAIL_OPEN",
        "url": "string"
      }
    ],
    "webhooks": [
      {
        "key": "string",
        "url": "string",
        "events": [
          "string"
        ]
      }
    ],
    "uiExtensions": [
      {
        "key": "string",
        "slot": "string",
        "label": "string"
      }
    ]
  }
}

A listing's ratings and reviews, newest first

GET
/v1/marketplace/listings/{slug}/reviews

Path Parameters

slugRequiredstring

Query Parameters

pagenumber
Default: 1Minimum: 1Maximum: 1000
limitnumber
Default: 20Minimum: 1Maximum: 50
curl -X GET "https://api.salesos.org/v1/marketplace/listings/<string>/reviews?page=1&limit=20"

MarketplaceReviewPage

{
  "data": [
    {
      "id": "string",
      "rating": 1,
      "title": "string",
      "body": "string",
      "author": "string",
      "publisherReply": "string",
      "publisherRepliedAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "page": 0,
  "limit": 0,
  "total": 0,
  "totalPages": 0,
  "hasMore": true,
  "summary": {
    "average": 0,
    "count": 0
  }
}

Functions

Your TypeScript/JavaScript run in the SalesOS sandbox: versions, deploys, secrets, triggers, HTTP invoke

Metadata

Metadata as code: retrieve source files, deploy (or check-only) as an async job, deploy history