List export column presets

GET/v1/api/store/{team_slug}/data_export/presets

v1Operation ID v1_public_data_export_presets

Lists the saved column choices (presets) you can use: the team's shared presets, and your own personal ones. Other members' personal presets are not shown. Sorted by type, then name; not paged.

A preset only stores columns. To use one, send its config.columns as columns when you create an export.

Permission

Any member of the team.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team

Request body

This operation takes no request body.

Response

200Successful response.

• dataarray of objectsrequired
  Fields of each item (6)

  • configobjectrequired
    Child fields (2)

    • columnsarray of strings

      Column ids, in file order. Send them as columns when you create an export.

    • schema_versioninteger

      Version of the column list (1).

  • idstringrequired

    The preset id. Use it to delete the preset.

  • is_team_defaultbooleanrequired

    The team's default preset for this type. At most one per type.

  • namestringrequired
  • typestringrequired
    • One of: "customer_list", "sales_order_list", "invoice_list", "invoice_item_list", "payment_list", "purchase_order_list", "tax_list", "simple_product_list", "variant_product_list"
  • user_idstring | nullrequired

    Your user id (a hash id) for a personal preset; null for a shared team preset.

• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

Related

• POSTSave an export column preset/v1/api/store/{team_slug}/data_export/presets
• DELETEDelete an export column preset/v1/api/store/{team_slug}/data_export/presets/{presetId}

Example request

curl

curl 'https://secure.yoprint.com/v1/api/store/your-team/data_export/presets' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": [
    {
      "config": {
        "columns": [
          "invoice_id",
          "customer_name",
          "total",
          "tax"
        ],
        "schema_version": 1
      },
      "id": "ZUFZpcm8jcw4J0",
      "is_team_default": false,
      "name": "Accounting",
      "type": "invoice_list",
      "user_id": "VG7s3tFzyQbO2N"
    },
    {
      "config": {
        "columns": [
          "invoice_id",
          "order_id",
          "total",
          "paid_amount",
          "balance_due"
        ],
        "schema_version": 1
      },
      "id": "cDHnZCTddDiS2c",
      "is_team_default": true,
      "name": "Month end",
      "type": "invoice_list",
      "user_id": null
    }
  ],
  "status": 200,
  "success": true
}