Get Group Details

GET

https://platform-api.convirza.com/v3/groups/{id}

Groups

Last modified:2026-04-03 14:27:57

Fetches details for a single organizational unit.

Response Structure
Returns fields for PUT/PATCH endpoints:

Editable fields:

org_unit_name

org_unit_ext_id

org_unit_parent_id

address

city

state

zip

phone_number

industry_id

Read-only fields (included for reference, ignored in PUT/PATCH):

group_created

group_modified

Authorization
The group must be within the authenticated user's accessible hierarchy.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200

application/json

Successfully retrieved group details

Body

🟠400

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://platform-api.convirza.com/v3/groups/' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "Success",
    "data": {
        "org_unit_name": "Sales Division",
        "org_unit_ext_id": "ORG-1002",
        "org_unit_parent_id": 1001,
        "address": "123 Main St",
        "city": "New York",
        "state": "NY",
        "zip": "10001",
        "phone_number": "+1-212-555-0100",
        "industry_id": 10,
        "group_created": "2025-01-15T10:30:00.000Z",
        "group_modified": "2026-02-20T14:20:00.000Z"
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}

Modified at 2026-04-03 14:27:57

Get Group Tree

List Groups