Retrieve the organization
How to fetch the organization via API
To fetch the organization, send a GET
request to the /api/organization
endpoint.
Request
GET https://yourdomain.commercelayer.io/api/organization
Example
The following request fetches the organization in scope:
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/organization/' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token'
On success, the API responds with a 200 OK
status code, returning a single resource object:
{
"data": {
"id": "xYZkjABcde",
"type": "organizations",
"attributes": {
"addresses_phone_required": true,
"bundles_max_items_count": 10,
"cleanups_max_concurrent_count": 10,
"config": {
"mfe": {
"default": {
"checkout": {
"billing_countries": [
{
"label": "Espana",
"value": "ES"
},
{
"label": "Italia",
"value": "IT"
},
{
"label": "Unites States of America",
"value": "US"
}
],
"billing_states": {
"FR": [
{
"label": "Paris",
"value": "PA"
},
{
"label": "Lyon",
"value": "LY"
},
{
"label": "Nice",
"value": "NI"
},
{
"label": "Marseille",
"value": "MA"
},
{
"label": "Bordeaux",
"value": "BO"
}
]
},
"default_country": "US",
"shipping_countries": [
{
"label": "Espana",
"value": "ES"
},
{
"label": "Italia",
"value": "IT"
},
{
"label": "Unites States of America",
"value": "US"
}
],
"shipping_states": {
"FR": [
{
"label": "Paris",
"value": "PA"
},
{
"label": "Lyon",
"value": "LY"
},
{
"label": "Nice",
"value": "NI"
},
{
"label": "Marseille",
"value": "MA"
},
{
"label": "Bordeaux",
"value": "BO"
}
]
},
"thankyou_page": "https://example.com/thanks/:lang/:orderId"
},
"links": {
"cart": "https://cart.example.com/:order_id?accessToken=:access_token",
"checkout": "https://checkout.example.com/:order_id?accessToken=:accessToken",
"identity": "https://example.com/login",
"microstore": "https://example.com/microstore/?accessToken=:access_token",
"my_account": "https://example.com/my-custom-account?accessToken=:access_token"
},
"urls": {
"privacy": "https://example.com/privacy/:lang",
"terms": "https://example.com/terms/:lang"
}
},
"market:id:ZKcv13rT": {
"checkout": {
"thankyou_page": "https://example.com/thanks/:order_id"
},
"links": {
"cart": "https://example.com/custom-cart/:order_id?accessToken=:access_token"
}
}
}
},
"coupons_max_code_length": 40,
"coupons_min_code_length": 8,
"created_at": "2018-01-01T12:00:00.000Z",
"domain": "the-blue-brand.commercelayer.io",
"exports_max_concurrent_count": 10,
"external_promotions_errors": true,
"favicon_url": "https://bluebrand.com/img/favicon.ico",
"gtm_id": "GTM-5FJXX6",
"gtm_id_test": "GTM-5FJXX7",
"imports_max_concurrent_count": 10,
"logo_url": "https://bluebrand.com/img/logo.svg",
"metadata": {
"foo": "bar"
},
"name": "The Blue Brand",
"orders_number_editable_live": false,
"orders_number_editable_test": false,
"primary_color": "#C8984E",
"promotions_max_concurrent_count": 10,
"reference": "ANY-EXTERNAL-REFEFERNCE",
"reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
"slug": "the-blue-brand",
"support_email": "support@bluebrand.com",
"support_phone": "+01 30800857",
"tax_calculators_errors": true,
"updated_at": "2018-01-01T12:00:00.000Z"
},
"relationships": {
},
"meta": {
"mode": "test"
}
}
}
Last updated