Productsup

List export templates

Lists the published export templates the caller may use, for example to choose a template when adding an export. Each template returns its published values: never-published and deleted templates are left out, and unpublished changes don't show. **Who sees what.** - Admin, internal users and internal viewers see every published template: `global`, `custom` and `internal`. - External users see the `global` templates and the `custom` templates of their accounts (every account they belong to; for a machine token, the token's account). They never see `internal` templates. **Visibility.** `global` = available to every account. `custom` = assigned to an account, project or site (`assignedTo`). `internal` = not global and assigned to nothing; for Productsup only. **usedIn.** Lists the templates used on one site (`usedIn[siteId]`), on the sites of one project (`usedIn[projectId]`) or on the sites of one account (`usedIn[accountId]`), whatever their visibility, because they are already there. External users may only ask for their own accounts and the sites and projects of their accounts; any other id returns 403. Send exactly one of the three. **Popularity** is the number of different accounts that use the template on a site. The list is sorted by popularity (most used first) unless `sort=name`. The fields `confidence`, `channelOwner`, `lastReviewedOn` and `internalDocLink` are returned to admin, internal users and internal viewers only.

GET
/V2/export-templates

Authorization

AuthorizationBearer <token>

Productsup Keycloak JWT bearer token.

In: header

Query Parameters

name?string

Part of the template name, case-insensitive.

Lengthlength <= 255
category[]?array<>

Category slugs, for example search-engines. A template matches when it is in any of them. Templates without a category are in other.

visibility[]?array<>

Admin, internal users and internal viewers only; external users get 403.

usedIn[siteId]?integer

Only the templates used on this site. Send only one of the usedIn ids.

Range1 <= value
usedIn[accountId]?integer

Only the templates used on the sites of this account. Send only one of the usedIn ids.

Range1 <= value
usedIn[projectId]?integer

Only the templates used on the sites of this project. Send only one of the usedIn ids. Covers the sites whose project ETM knows: from the platform's project-id in its channel events, and from the assignment backfill.

Range1 <= value
sort?string

popularity (most used first, then name) or name.

Default"popularity"
Value in"popularity" | "name"
firstResult?integer

Zero-based index of the first item to return.

Default0
Range0 <= value
maxResults?integer

Maximum number of items to return per page. Values above 1000 are silently clamped to 1000.

Default50
Range1 <= value <= 1000

Response Body

application/json

application/json

application/json

curl -X GET "https://export-template-api.productsup.com/V2/export-templates"
{
  "data": [
    {
      "id": 5220,
      "name": "Google Shopping",
      "logoUrl": "string",
      "description": "string",
      "categories": [
        {
          "id": 0,
          "name": "string",
          "slug": "string",
          "description": "string"
        }
      ],
      "countries": [
        {
          "code": "de",
          "name": "string",
          "region": "string"
        }
      ],
      "visibility": "global",
      "assignedTo": {
        "accountId": 0,
        "projectId": 0,
        "siteId": 0
      },
      "type": "api",
      "popularity": 0,
      "exportType": "standard",
      "attributesCount": 0,
      "supportsDelta": true,
      "lastPublishedAt": "2019-08-24T14:15:22Z",
      "featured": true,
      "priority": 0,
      "brand": {
        "id": 0,
        "name": "string"
      },
      "marketingTitle": "string",
      "websiteLink": "string",
      "landingPageLink": "string",
      "helpCenterLink": "string",
      "specificationsLink": "string",
      "confidence": "string",
      "channelOwner": "string",
      "lastReviewedOn": "string",
      "internalDocLink": "string"
    }
  ],
  "pagination": {
    "firstResult": 0,
    "maxResults": 50,
    "count": 5,
    "total": 5
  }
}
{
  "errors": {
    "message": "Resource access denied."
  }
}
{
  "errors": {
    "message": "Resource access denied."
  }
}