Overview
The Organizations API is Caspeco’s API for accessing organizational data. It gives you programmatic access to the organizational structure associated with your integration.
Organizational Structure
Section titled “Organizational Structure”A Caspeco organization is structured in the following hierarchy: Organization → Company → Location
Organization
Section titled “Organization”The Organization is the top-level entity. It represents the overall business group and owns all Brands associated with it.
A Brand is a commercial identity that belongs to an Organization. One Organization can have multiple Brands, and Brands are used by Locations to define how they present themselves.
Company
Section titled “Company”A Company is the legal entity operating under an Organization, identified by its registration number. One Organization can have multiple Companies, each representing a distinct legal unit.
Location
Section titled “Location”A Location is a physical site that belongs to a Company and operates under a Brand. A Company can have multiple Locations.
Example
Section titled “Example”Consider a restaurant group that operates two separate restaurant chains across multiple cities:
Acme Group (Organization)├── Brands: Acme Bistro, Acme Grill│├── Acme Stockholm AB (Company, org. 556000-0001)│ ├── Acme Bistro Södermalm (Location, Brand: Acme Bistro)│ └── Acme Grill Östermalm (Location, Brand: Acme Grill)│└── Acme Gothenburg AB (Company, org. 556000-0002) └── Acme Bistro Haga (Location, Brand: Acme Bistro)Here, the Organization owns both brands and has two legally separate companies. Each company operates one or more physical locations, each presenting itself under one of the organization’s brands.
Available Resources
Section titled “Available Resources”The Organizations API currently exposes the following resources:
| Resource | Description |
|---|---|
| Company | List and retrieve companies associated with your integration |
| Location | List locations belonging to a company |
More resources such as Brands will be added over time.
API Reference
Section titled “API Reference”Detailed endpoint documentation is available in the Organizations API reference.