Get all the companies of the authenticated user

GET /company/companies

Request

Authentication

This endpoint requires authentication.

Header Value
Authorization Set the value to Bearer + + access_token

Include extra data

Include extra data in the result by sending the "include" GET parameter

Key Value
shops

[company.Shop.simple]

Example request 1

GET /company/companies HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.10.0
Accept-Language: en-US,en;q=0.5

Response

Array of Company: [Company]

Company

Field Type Description
id Int Id of the company
name [Language: String] Name of the company
active Bool Whether this company is activated
order_statuses [String] Optional. Array of String
order_preparation_statuses [String] Optional. Array of String
shops_have_internal_names Bool Optional. A boolean value
translations Dictionary Optional. A dictionary with fields
emails Dictionary Optional. Email settings
shops [company.Shop.simple] Optional. Array of company.Shop.simple

Example response 1

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 25254

[
    {
        "id": 16,
        "name": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "order_statuses": [
            "PENDING",
            "HAS_READ",
            "APPROVED",
            "DECLINED",
            "REMOVED",
            "DELETED_BY_SHOP",
            "COLLECTED"
        ],
        "order_preparation_statuses": [
            "PREPARING",
            "READY"
        ],
        "shops_have_internal_names": false,
        "translations": {
            "enable": true,
            "languages": [
                "en",
                "nl",
                "fr",
                "de",
                "es",
                "ca",
                "it",
                "pt",
                "pl",
                "ro",
                "el",
                "sv",
                "hu",
                "ms",
                "tr"
            ],
            "main_language": "en"
        },
        "emails": {
            "note_for_customer": "..."
        },
        "shops": [
            {
                "name": "Milo Schmitt",
                "active": false,
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Gent",
                    "country": "BE",
                    "position": {
                        "latitude": 1.54361,
                        "longitude": 0.45645
                    }
                },
                "allow_comments": true,
                "allow_orders": false,
                "delivery_use_intervals": true,
                "allow_invoices": false,
                "allow_order_comments": false,
                "allow_product_comments": true,
                "takeout_use_intervals": true,
                "allow_order_messages": true,
                "id": 10,
                "avatar": {
                    "resolutions": [
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        }
                    ],
                    "file_id": 12,
                    "white_background": true
                },
                "banner": {
                    "resolutions": [
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        }
                    ],
                    "file_id": 13,
                    "white_background": true
                },
                "url": "..."
            },
            {
                "name": "Rebekah Skiles",
                "active": true,
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Gent",
                    "country": "BE",
                    "position": {
                        "latitude": 1.54361,
                        "longitude": 0.45645
                    }
                },
                "allow_comments": true,
                "allow_orders": true,
                "delivery_use_intervals": true,
                "allow_invoices": false,
                "allow_order_comments": true,
                "allow_product_comments": true,
                "takeout_use_intervals": false,
                "allow_order_messages": true,
                "id": 14,
                "avatar": {
                    "resolutions": [
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        }
                    ],
                    "file_id": 17,
                    "white_background": true
                },
                "banner": {
                    "resolutions": [
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        }
                    ],
                    "file_id": 17,
                    "white_background": false
                },
                "url": "..."
            },
            {
                "name": "Abigayle Stracke",
                "active": false,
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Gent",
                    "country": "BE",
                    "position": {
                        "latitude": 1.54361,
                        "longitude": 0.45645
                    }
                },
                "allow_comments": false,
                "allow_orders": false,
                "delivery_use_intervals": true,
                "allow_invoices": false,
                "allow_order_comments": false,
                "allow_product_comments": true,
                "takeout_use_intervals": true,
                "allow_order_messages": false,
                "id": 19,
                "avatar": {
                    "resolutions": [
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        }
                    ],
                    "file_id": 11,
                    "white_background": false
                },
                "banner": {
                    "resolutions": [
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        }
                    ],
                    "file_id": 18,
                    "white_background": false
                },
                "url": "..."
            }
        ]
    },
    {
        "id": 17,
        "name": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "order_statuses": [
            "PENDING",
            "HAS_READ",
            "APPROVED",
            "DECLINED",
            "REMOVED",
            "DELETED_BY_SHOP",
            "COLLECTED"
        ],
        "order_preparation_statuses": [
            "PREPARING",
            "READY"
        ],
        "shops_have_internal_names": true,
        "translations": {
            "enable": false,
            "languages": [
                "en",
                "nl",
                "fr",
                "de",
                "es",
                "ca",
                "it",
                "pt",
                "pl",
                "ro",
                "el",
                "sv",
                "hu",
                "ms",
                "tr"
            ],
            "main_language": "en"
        },
        "emails": {
            "note_for_customer": "..."
        },
        "shops": [
            {
                "name": "Alivia Senger",
                "active": false,
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Gent",
                    "country": "BE",
                    "position": {
                        "latitude": 1.54361,
                        "longitude": 0.45645
                    }
                },
                "allow_comments": false,
                "allow_orders": true,
                "delivery_use_intervals": false,
                "allow_invoices": true,
                "allow_order_comments": true,
                "allow_product_comments": false,
                "takeout_use_intervals": true,
                "allow_order_messages": false,
                "id": 12,
                "avatar": {
                    "resolutions": [
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        }
                    ],
                    "file_id": 19,
                    "white_background": true
                },
                "banner": {
                    "resolutions": [
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        }
                    ],
                    "file_id": 19,
                    "white_background": true
                },
                "url": "..."
            },
            {
                "name": "Ruby Jacobson IV",
                "active": false,
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Gent",
                    "country": "BE",
                    "position": {
                        "latitude": 1.54361,
                        "longitude": 0.45645
                    }
                },
                "allow_comments": false,
                "allow_orders": false,
                "delivery_use_intervals": false,
                "allow_invoices": false,
                "allow_order_comments": true,
                "allow_product_comments": false,
                "takeout_use_intervals": true,
                "allow_order_messages": true,
                "id": 18,
                "avatar": {
                    "resolutions": [
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        }
                    ],
                    "file_id": 18,
                    "white_background": false
                },
                "banner": {
                    "resolutions": [
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        }
                    ],
                    "file_id": 11,
                    "white_background": true
                },
                "url": "..."
            },
            {
                "name": "Nelson Turcotte",
                "active": false,
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Gent",
                    "country": "BE",
                    "position": {
                        "latitude": 1.54361,
                        "longitude": 0.45645
                    }
                },
                "allow_comments": false,
                "allow_orders": false,
                "delivery_use_intervals": true,
                "allow_invoices": false,
                "allow_order_comments": false,
                "allow_product_comments": true,
                "takeout_use_intervals": true,
                "allow_order_messages": false,
                "id": 10,
                "avatar": {
                    "resolutions": [
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        }
                    ],
                    "file_id": 11,
                    "white_background": false
                },
                "banner": {
                    "resolutions": [
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        }
                    ],
                    "file_id": 18,
                    "white_background": false
                },
                "url": "..."
            }
        ]
    },
    {
        "id": 18,
        "name": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "active": false,
        "order_statuses": [
            "PENDING",
            "HAS_READ",
            "APPROVED",
            "DECLINED",
            "REMOVED",
            "DELETED_BY_SHOP",
            "COLLECTED"
        ],
        "order_preparation_statuses": [
            "PREPARING",
            "READY"
        ],
        "shops_have_internal_names": true,
        "translations": {
            "enable": true,
            "languages": [
                "en",
                "nl",
                "fr",
                "de",
                "es",
                "ca",
                "it",
                "pt",
                "pl",
                "ro",
                "el",
                "sv",
                "hu",
                "ms",
                "tr"
            ],
            "main_language": "en"
        },
        "emails": {
            "note_for_customer": "..."
        },
        "shops": [
            {
                "name": "Catherine Zboncak",
                "active": true,
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Gent",
                    "country": "BE",
                    "position": {
                        "latitude": 1.54361,
                        "longitude": 0.45645
                    }
                },
                "allow_comments": false,
                "allow_orders": false,
                "delivery_use_intervals": false,
                "allow_invoices": false,
                "allow_order_comments": true,
                "allow_product_comments": false,
                "takeout_use_intervals": true,
                "allow_order_messages": false,
                "id": 17,
                "avatar": {
                    "resolutions": [
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        }
                    ],
                    "file_id": 15,
                    "white_background": false
                },
                "banner": {
                    "resolutions": [
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        }
                    ],
                    "file_id": 17,
                    "white_background": true
                },
                "url": "..."
            },
            {
                "name": "Kavon Muller",
                "active": true,
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Gent",
                    "country": "BE",
                    "position": {
                        "latitude": 1.54361,
                        "longitude": 0.45645
                    }
                },
                "allow_comments": false,
                "allow_orders": false,
                "delivery_use_intervals": false,
                "allow_invoices": true,
                "allow_order_comments": false,
                "allow_product_comments": true,
                "takeout_use_intervals": true,
                "allow_order_messages": false,
                "id": 17,
                "avatar": {
                    "resolutions": [
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        }
                    ],
                    "file_id": 10,
                    "white_background": false
                },
                "banner": {
                    "resolutions": [
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        }
                    ],
                    "file_id": 14,
                    "white_background": true
                },
                "url": "..."
            },
            {
                "name": "Sheridan Hessel",
                "active": false,
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Gent",
                    "country": "BE",
                    "position": {
                        "latitude": 1.54361,
                        "longitude": 0.45645
                    }
                },
                "allow_comments": true,
                "allow_orders": true,
                "delivery_use_intervals": false,
                "allow_invoices": true,
                "allow_order_comments": false,
                "allow_product_comments": true,
                "takeout_use_intervals": true,
                "allow_order_messages": false,
                "id": 11,
                "avatar": {
                    "resolutions": [
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        }
                    ],
                    "file_id": 17,
                    "white_background": true
                },
                "banner": {
                    "resolutions": [
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        },
                        {
                            "src": "https://example.com",
                            "width": 600,
                            "height": 350
                        }
                    ],
                    "file_id": 11,
                    "white_background": true
                },
                "url": "..."
            }
        ]
    }
]
This is a development version Do not use this version in production
1.10.0 development