Get A Client Sub Organization Type

This endpoint retrieves the details of a specific sub-organization type from the list of all sub-organization types available for the Enterprise API user. It is used to fetch information about a particular sub-organization type by its unique identifier.

HTTP Method and URL

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

Authentication Requirements

This endpoint requires authentication. Ensure that a valid user token is provided, typically via an environment or global variable (e.g., user-token).

Path and Query Parameters

Path Parameter:

• subOrgTypeId (required): The unique identifier of the sub-organization type to retrieve. Example: 1

Query Parameter:

• user_type (required): Must be set to ENTERPRISE_API.

Request Body

This request does not require a body.

Example Request

GET {{host}}/api/v2/sub-organization/types/1?user_type=ENTERPRISE_API
Authorization: Bearer {USER-TOKEN}

Example Successful Response

{
  "id": 1,
  "name": "Client Sub Organization",
  "description": "Represents a client sub-organization type.",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-02T12:00:00Z"
}

Error Responses

• 400 Bad Request: Invalid or missing parameters.

• 401 Unauthorized: Authentication failed or missing token.

• 404 Not Found: Sub-organization type with the specified ID does not exist.

• 500 Internal Server Error: Unexpected server error.

Usage Notes

• Ensure the user_type query parameter is always set to ENTERPRISE_API.

• The subOrgTypeId must correspond to a valid sub-organization type.