Get your preferences for this team

GET/v1/api/store/{team_slug}/current_user_preference

v1Operation ID v1_public_current_user_preference_show

Returns the preferences the YoPrint web app saved for you on this team, as one free-form object. YoPrint itself reads none of these keys; they hold web app settings such as grid column layouts (column_order) and how sales orders open (sales_order_open_behavior).

With no preferences saved yet, data is an empty array [], not an object.

Permission

Your own preferences only.

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.

• dataobject | arrayrequired

  The keys the web app uses today. Other keys you saved come back too.

  Child fields (3)

  • column_orderobject | array

    Grid column layouts, keyed by the web app's grid name. Each value is that grid's list of column states. An empty one reads back as [].

  • sales_order_open_behaviorobject | array

    How the web app opens a sales order from each place. An empty one reads back as [].

    Child fields (3)

    • global_searchstring
      • One of: "preview_window", "full_page", "new_tab"
    • related_linkstring
      • One of: "preview_window", "full_page", "new_tab"
    • sales_order_liststring
      • One of: "preview_window", "full_page", "new_tab"
  • versionnumber

    The web app's version of these settings.

• 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 your preferences for this team/v1/api/store/{team_slug}/current_user_preference

Example request

curl

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

Example response 200

Response

{
  "data": {
    "sales_order_open_behavior": {
      "global_search": "preview_window",
      "sales_order_list": "full_page"
    },
    "version": 1
  },
  "status": 200,
  "success": true
}