Get Specific Sub Organization

Retrieves a specific sub-organization and its details, including name, address or other contact details, branding photo (used in emails and on the signing page), and sub-organization type. The unique sub-organization ID is required to perform this request.

HTTP Method and URL

GET {{host}}/api/v2/organizations/sub/:uuid?user_type=ENTERPRISE_API

• Method: GET
• Path Variable: :uuid (string, required) — The unique identifier of the sub-organization.
• Query Parameter: user_type=ENTERPRISE_API (required)

Authentication Requirements

• Requires a valid user-token provided as a variable or header.
• Ensure you are authorized to access sub-organization details in your enterprise account.

Path and Query Parameters

• uuid (path, string, required): Unique identifier for the sub-organization.
• user_type (query, string, required): Must be set to ENTERPRISE_API.

Request Body

• This request does not require a body.

Example Request

GET {{host}}/api/v2/organizations/sub/ba0d5d22-aa81-498c-a022-4bee8f48ee57?user_type=ENTERPRISE_API
Headers:
  user-token: <your_token>

Example Successful Response

{
  "uuid": "ba0d5d22-aa81-498c-a022-4bee8f48ee57",
  "name": "Acme Sub-Organization",
  "address": {
    "street": "123 Main St",
    "city": "Metropolis",
    "state": "CA",
    "zip": "12345",
    "country": "USA"
  },
  "contact": {
    "email": "[email protected]",
    "phone": "+1-555-123-4567"
  },
  "branding_photo_url": "https://example.com/images/branding.png",
  "type": "affiliate"
}

Error Responses

400 Bad Request

{
  "error": "Missing or invalid sub-organization ID."
}

**401 Unauthorized**
```json
{
  "error": "Authentication failed. Please provide a valid user-token."
}

**404 Not Found**
```json
{
  "error": "Sub-organization not found."
}

Usage Notes

• The uuid path variable must be a valid sub-organization ID within your enterprise.
• The user_type query parameter is required and must be set to ENTERPRISE_API.
• Ensure your user-token is current and has permission to access sub-organization details.
• No request body is needed for this endpoint.