Config workspace
const url = 'https://api.shypr.app/rest/workspaces/config';const options = {method: 'GET', headers: {'X-API-KEY': '<X-API-KEY>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.shypr.app/rest/workspaces/config \ --header 'X-API-KEY: <X-API-KEY>'Retrieves a Workspace resource.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”Workspace resource
object
Set by a Dev. Nobody works in a deactivated workspace: no login, no session, no API key and no MCP connection, see UserAccount::canUseWorkspace(). A Dev keeps access, so a Dev can reactivate it. The data and the members stay, so a reactivation gives all access back.
Set by a Dev: the AI cost that the workspace may use in one period, in cents (one credit each). Null takes the allowance of the plan, see PaymentPlanType::aiAllowance().
Set by the AI after a sign-up, when the sign-up looks like abuse (spam, a fake name, a throwaway address), see ScreenSignUpHandler. It marks the workspace and a Dev decides, but the workspace cannot send mail through the Shypr domain (MailTransportFactory::shypr()) until a Dev clears the mark (clearSuspicion).
Why the AI marked the workspace, with $suspiciousAt.
The currency of a new record when the customer or the supplier has no currency of the workspace. It is always one of the currencies.
object
The currency code. For ISO currencies this will be the 3-letter uppercase ISO 4217 currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes.
The numeric currency code. For ISO currencies this will be the ISO 4217 numeric currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes. Set to null if the currency does not have a numeric code.
The currency name. For ISO currencies this will be the official English name of the currency. For non-ISO currencies no constraints are defined.
The default number of fraction digits (typical scale) used with this currency. For example, the default number of fraction digits for the Euro is 2, while for the Japanese Yen it is 0. This cannot be a negative number.
The type of the currency. For ISO currencies, this indicates whether the currency is currently in use (IsoCurrent) or has been withdrawn (IsoHistorical). For non-ISO currencies defined by the application, the type is Custom.
object
The ISO 4217 codes that a quote, a purchase order and a bank account of the workspace can take, the default first. A record keeps its currency when the workspace removes it.
True when the workspace is registered for the One Stop Shop: a sale to a consumer in another EU country then has the VAT rate of that country, else the rate of the workspace. See docs/vat.md.
object
Example
{ "ossRegistered": false, "location": "https://example.com/", "avatar": "https://example.com/", "bankAccounts": [ "https://example.com/" ], "config": [ { "dataType": "S", "key": "email.from.name", "typeModel": "email.from.name" } ], "paymentPlan": "DEMO"}object
Set by a Dev. Nobody works in a deactivated workspace: no login, no session, no API key and no MCP connection, see UserAccount::canUseWorkspace(). A Dev keeps access, so a Dev can reactivate it. The data and the members stay, so a reactivation gives all access back.
Set by a Dev: the AI cost that the workspace may use in one period, in cents (one credit each). Null takes the allowance of the plan, see PaymentPlanType::aiAllowance().
Set by the AI after a sign-up, when the sign-up looks like abuse (spam, a fake name, a throwaway address), see ScreenSignUpHandler. It marks the workspace and a Dev decides, but the workspace cannot send mail through the Shypr domain (MailTransportFactory::shypr()) until a Dev clears the mark (clearSuspicion).
Why the AI marked the workspace, with $suspiciousAt.
The currency of a new record when the customer or the supplier has no currency of the workspace. It is always one of the currencies.
object
The currency code. For ISO currencies this will be the 3-letter uppercase ISO 4217 currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes.
The numeric currency code. For ISO currencies this will be the ISO 4217 numeric currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes. Set to null if the currency does not have a numeric code.
The currency name. For ISO currencies this will be the official English name of the currency. For non-ISO currencies no constraints are defined.
The default number of fraction digits (typical scale) used with this currency. For example, the default number of fraction digits for the Euro is 2, while for the Japanese Yen it is 0. This cannot be a negative number.
The type of the currency. For ISO currencies, this indicates whether the currency is currently in use (IsoCurrent) or has been withdrawn (IsoHistorical). For non-ISO currencies defined by the application, the type is Custom.
object
The ISO 4217 codes that a quote, a purchase order and a bank account of the workspace can take, the default first. A record keeps its currency when the workspace removes it.
True when the workspace is registered for the One Stop Shop: a sale to a consumer in another EU country then has the VAT rate of that country, else the rate of the workspace. See docs/vat.md.
Example
https://example.com/Example
https://example.com/object
Forbidden
A representation of common errors.
object
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Example
{ "status": 400}A representation of common errors.
object
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Example
{ "status": 400}Not found
A representation of common errors.
object
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Example
{ "status": 400}A representation of common errors.
object
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Example
{ "status": 400}