Retrieve All Corporate Categories

get

https://sandbox-api.softpoint.io/interface/v1/corporate_categories

Lists corporate categories, the groupings used to organize multiple locations under a corporate parent, palong with the member locations of each category.

Header	Required	Description
Authorization	Yes	Bearer YOUR_ACCESS_TOKEN

Request Parameters

Query Parameters:

Parameter	Type	Required	Description
user_id	integer	Yes	The acting user.
global_on_id	integer	No	Originating channel identifier.
corporate_id	integer	No	Restrict results to a single corporate parent.

cURL Example

curl --request GET \
  --url "https://sandbox-api.softpoint.io/interface/v1/corporate_categories?user_id=2&global_on_id=1&corporate_id=15" \
  --header "Authorization: Bearer YOUR_ACCESS_TOKEN"

Success Response

{
  "_links": { "self": { "href": ".../corporate_categories?page=1" } },
  "_embedded": {
    "corporate_categories": [
      {
        "id": 8,
        "status": 1,
        "name": "test_category_001",
        "corporate_id": 15,
        "global_country_id": 3,
        "created_datetime": "2023-07-04T11:38:38.000000Z",
        "_embedded": {
          "category_locations": [
            { "id": 27, "status": 1, "location_id": 4000057 },
            { "id": 30, "status": 1, "location_id": 4000056 }
          ]
        }
      }
    ]
  }
}

Response Fields

Field	Type	Description
_links	object	HAL pagination links (`self`, `first`, `last`).
_embedded.corporate_categories	array	The categories.
corporate_categories[].id	integer	Category ID (use as `corporate_category_id` in Update A Location).
corporate_categories[].name	string	Category name.
corporate_categories[].status	integer	Category status.
corporate_categories[].corporate_id	integer	Parent corporate ID.
corporate_categories[]._embedded.category_locations	array	Member locations of the category.
category_locations[].location_id	integer	A member location's ID.

Error Responses

User Not Found

{
  "error": {
    "code": 10201,
    "message": "The selected user doesn't exist.",
    "details": null
  }
}

Status Codes

Code	Description
200	Categories returned
404	The supplied `user_id` does not exist

Workflow Placement

A read used in multi-location (corporate) setups to discover category IDs, which can then be assigned to a location via Update A Location.

Notes

This is a HAL-style response; traverse _embedded, not data.
Omitting corporate_id returns categories across the caller's accessible corporates.

Common Mistakes

Passing an empty or invalid user_id (returns 10201).
Looking for results under data instead of _embedded.corporate_categories.

Responses

200OK

404Not Found