Get your company details

GET/v1/api/store/{team_slug}/setting/detail

v1Operation ID v1_public_setting_detail_show

Returns your team's profile: name, slug, contact details, timezone, units, logo, customer portal background and favicon, custom domain and plan.

It also lists the payment gateways customers can pay through, with only their public identifiers. Secret keys are never in this response.

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.

• dataobjectrequired
  Child fields (25)

  • custom_domainstring | nullrequired

    The host your customer portal is served on, or null.

  • idstringrequired
  • namestringrequired
  • payment_gatewayarray of objectsrequired

    The payment gateways your customers can pay through, with only their public identifiers (for example a Stripe publishable key). Empty when the plan has no payment integration.

  • planobjectrequired

    The team's YoPrint plan.

    Child fields (4)

    • activebooleanrequired

      Whether the plan is active now.

    • detailobjectrequired

      With a subscription: name, status, active and need_to_select_plan. On a trial or free plan: id, name, archive, need_to_select_plan, and on a trial expire_at and status (active or expired).

      Child fields (7)

      • activeboolean
      • archiveboolean
      • expire_atstring (date-time) | null
      • idstring
      • namestring | null

        With a subscription, always default; otherwise the trial or free plan's name.

      • need_to_select_planboolean

        True when the team must choose a plan before it can go on.

      • statusstring | null
    • featuresobjectrequired

      What the plan allows: features, limits and integrations, keyed by name.

    • typestringrequired

      paid with a subscription; otherwise trial or free.

      • One of: "paid", "trial", "free"
  • slugstringrequired

    The {team_slug} in every path.

  • timezonestringrequired
  • channel_idinteger

    The team's number, used by YoPrint's live-update channel.

  • customer_portal_bgstring | null

    The customer portal background image, or null.

  • dimensionstring | null

    Length unit: m, cm, mm or in.

  • emailstring | null
  • favicon_urlstring | null

    The customer portal favicon (the icon in the browser tab), or null when none is uploaded.

  • ga_idstring

    An analytics id: YxPx and the team's number (channel_id).

  • logo_urlstring | null
  • onboard_statusstring | null
  • phonestring | null
  • phone_countrystring | null
  • plan_regionstring | null
  • printavo_importer_availableboolean
  • printavo_importer_enabledboolean
  • seededboolean
  • tax_numberstring | null
  • trial_expires_atstring (date-time)
  • websitestring | null
  • weightstring | null

    Weight unit: kg, g, lbs or oz.

• 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

• PUTUpdate general settings/v1/api/store/{team_slug}/setting/general
• POSTUpload the team logo/v1/api/store/{team_slug}/setting/photo
• POSTUpload the customer portal favicon/v1/api/store/{team_slug}/setting/customer_portal_favicon
• PUTSet the custom domain/v1/api/store/{team_slug}/setting/custom_domain/update

Example request

curl

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

Example response 200

Response

{
  "data": {
    "channel_id": 1001,
    "custom_domain": "shop.example.com",
    "customer_portal_bg": null,
    "dimension": "in",
    "email": "alex@example.com",
    "favicon_url": null,
    "ga_id": "YxPx1001",
    "id": "OutVLW14xRJYLp",
    "logo_url": "https://example.com/logo.png",
    "name": "Northwind Apparel",
    "onboard_status": null,
    "payment_gateway": [],
    "phone": "+1 201 555 0123",
    "phone_country": "US",
    "plan": {
      "active": true,
      "detail": {
        "active": true,
        "name": "default",
        "need_to_select_plan": false,
        "status": "active"
      },
      "features": {
        "customer_portal": true,
        "user_limit": 5
      },
      "type": "paid"
    },
    "plan_region": "US",
    "printavo_importer_available": false,
    "printavo_importer_enabled": false,
    "seeded": true,
    "slug": "your-team",
    "tax_number": null,
    "timezone": "America/New_York",
    "trial_expires_at": "2026-01-15T00:00:00+00:00",
    "website": "https://example.com",
    "weight": "lbs"
  },
  "status": 200,
  "success": true
}