Groups

Get group

Returns one group in real time. Pass group_id as a query parameter (it can contain @ / : so it is not placed in the path). Returns 404 when the group cannot be found.

GEThttps://api.unifyport.ai/v1/accounts/{account_id}/groups/info

Before you call

Use a server-side X-Api-Key for the workspace that owns the resource. Replace every placeholder before running a sample.

Prepare your parameters

account_id: Use data.id from account creation or an account query. Account identifiers belong to the workspace selected by X-Api-Key. Get account
group_id: Group to act on — the id returned by List groups. Kept in the query string because provider ids may contain @ or :.

Request parameters

Headers

X-Api-Key

stringrequired

Workspace API key. The workspace is resolved from this header.

Path parameters

account_id

stringrequired

Identifier used in the groups route.

Query parameters

group_id

stringrequired

Group to act on — the id returned by List groups. Kept in the query string because provider ids may contain @ or :.

Request body

This endpoint does not require a JSON request body.

Understand the result

Use the documented response fields and HTTP status. Successful 204 responses have no body; use X-Request-Id for diagnosis. Follow the related operations for the next step.

Response 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "id": "group_example",
    "conversation_id": "group_example",
    "name": "Project team",
    "avatar_url": "",
    "member_count": 5,
    "description": "..."
  }
}

Response body

id

string

Group identifier. For a group the conversation_id equals this id.

conversation_id

string

Conversation identifier for the group; equal to id.

name

string

Group name.

avatar_url

string

Group avatar URL, or an empty string when none is set.

member_count

integer

Number of members in the group.

format: int64

joined_at

string

Time when the connected account joined the group, when available.

format: date-time

created_at

string

Provider-reported group creation time, when available.

format: date-time

description

string

Group description, when available.

permissions

object

Group-wide speaking permissions, returned only when explicitly supplied by the source. Missing means unknown; admins_only=false permits ordinary members to speak, but does not guarantee this account can send.

admins_only

boolean

true means only administrators may speak; false is an explicit state, not an omitted or default value.

extra

object

Provider-specific group fields. WhatsApp group data may include announcement-group classification, depending on the data available for the current query.

is_announcement_group

boolean

Only for WhatsApp groups. true confirms a community announcement group; false means the current data confirms the announcement-group criteria are not met. Missing means unknown; null is never returned. This classification does not indicate that the current account can send messages. Independent of permissions.admins_only.

Responses

200

200 OK

Request succeeded. See the example response body.

400

Bad Request

The request body, path, or parameters are invalid.

401

Unauthorized

The X-Api-Key header is missing or invalid.

404

Not Found

The requested provider resource could not be found.

409

Conflict

The requested operation conflicts with an existing provider account or resource.

500

Internal Server Error

The service encountered an unexpected error.

501

Not Implemented

The selected provider does not implement this operation.

502

Bad Gateway

The provider adapter or upstream provider could not complete the operation.

If the request fails

Inspect HTTP status and error.code/numeric_code, and keep request_id for diagnosis. Correct invalid parameters, complete required authorization or check runtime state as appropriate. Confirm the outcome before retrying a send or another write. Error reference

invalid_request · 10000 · 400: Check required fields, formats and channel conditions, then correct the request.
invalid_api_key · 11001 · 401: Check X-Api-Key and whether the workspace is active.