Read a business
One business of the organization (owned or granted). An unknown, foreign or archived id is 404 BUSINESS_NOT_FOUND.
Org-level: send no Shyni-Business header. Requires the businesses:read scope.
ApiKeyAuth businesses:readAuthorizationBearer <shyni_sk_live_*>An API key, issued once and never retrievable again: an organization key in the developer
portal, or a studio key in the studio's admin (Moje studio → API). Send as Authorization: Bearer shyni_sk_live_....
Scope: businesses:read
id*stringThe business.
application/json- response
id*stringSend it as Shyni-Business to act on this business.
name*stringslug*stringindustry*string"AUTO""GENERIC"timezone*stringIANA time zone.
mode*string"live""test"sandbox*booleanA sandbox business (sample data, simulated payments, test mails); its mode is always test.
archived*booleancreatedAt*stringdate-timeallowedDomains*array<string>Websites a publishable key of this business may be used from.
customerEmails*|Whether Shyni e-mails the business's customers. off (default for a new business): nothing is sent, your
platform sends its own e-mails from the webhooks. branded: Shyni sends the customer e-mails under your
organization's brand, as " přes Shyni". null for a studio the organization only has access to (a
studio always mails its own customers).
"off""branded"nullcurl -X GET 'https://api.shyni.io/api/v1/businesses/string' \ -H 'Authorization: Bearer shyni_sk_test_YOUR_KEY'Response 200
The business.
{ "id": "string", "name": "string", "slug": "string", "industry": "AUTO", "timezone": "string", "mode": "live", "sandbox": true, "archived": true, "createdAt": "2019-08-24T14:15:22Z", "allowedDomains": [ "string" ], "customerEmails": "off"}Response 401
Missing, malformed, unknown, or revoked API key (INVALID_API_KEY).
{ "code": "INVALID_API_KEY", "message": "Missing or invalid API key."}Response 403
The key is valid but the request is refused. Branch on code: INSUFFICIENT_SCOPE (the key lacks the
permission this endpoint requires), PLAN_REQUIRED (the studio is not on a plan that includes API keys,
Pro and above), ORIGIN_NOT_ALLOWED, SECRET_KEY_IN_BROWSER, or DEMO_STUDIO on a write to the demo studio.
See Authentication and Scopes above.
{ "code": "INSUFFICIENT_SCOPE", "message": "This API key does not have the permission this endpoint requires."}Response 404
The business does not exist, belongs to another organization, was archived or has another mode than the key (BUSINESS_NOT_FOUND) - one answer for all of them.
{ "code": "BUSINESS_NOT_FOUND", "message": "Business not found."}Response 429
Burst rate limit exceeded.
{ "code": "RATE_LIMITED", "message": "Too many requests. Retry after the time given in the Retry-After header."}