Get All Client Sub Organization Type

This endpoint retrieves the list of all existing sub-organization types available for the Enterprise API user. It is typically used to discover which sub-organization types can be managed or referenced within the platform.

HTTP Method and URL

• Method: GET

• URL: {{host}}/api/v2/sub-organization/types?user_type=ENTERPRISE_API

Headers

Authentication Requirements

This endpoint requires authentication via a bearer token. The user-token variable should be set to a valid token for an Enterprise API user.

Path and Query Parameters

• Query Parameter:
  • user_type (required): Must be set to ENTERPRISE_API to retrieve sub-organization types for enterprise users.

Request Body

This request does not require a body.

Example Request

GET {{host}}/api/v2/sub-organization/types?user_type=ENTERPRISE_API
user-token: {USER-TOKEN}

Example Successful Response

[
  {
    "id": "string",
    "name": "string",
    "description": "string"
  }
]

Error Responses

• 401 Unauthorized: Missing or invalid authentication token.

• 403 Forbidden: Authenticated user does not have permission to access this resource.

• 400 Bad Request: Missing or invalid query parameter(s).

Usage Notes

• Ensure the user-token variable is set in your environment before sending the request.

• The user_type query parameter is required and must be set to ENTERPRISE_API.

• The endpoint returns an array of sub-organization type objects, each with id, name, and description fields.

References:

• GET ALL CLIENT SUB_ORGANIZATION TYPES

• Get All Client Sub Organization Type