GroupsGET

List group join requests

Lists pending join requests for a group with join approval enabled. Pass group_id as a query parameter. Upstream push events are not guaranteed, so poll this endpoint as the reliable source.

https://api.unifyport.ai/v1/accounts/{account_id}/groups/join-requests

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.

Response body

id

string

Join request identifier; pass it as member_ids when approving or rejecting.

phone

string

Phone number of the requester, when the provider exposes it.

lid

string

Provider LID for the requester, when available.

requested_at

string

RFC3339 timestamp of when the join was requested.

format: date-time

group_id

string

Group the join requests belong to.

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.

Request

curl -X GET https://api.unifyport.ai/v1/accounts/{account_id}/groups/join-requests?group_id=group_example \
  -H "X-Api-Key: <YOUR_API_KEY>"

Response

{
  "data": {
    "group_id": "group_example",
    "items": [
      {
        "id": "member_example",
        "phone": "8613912345678",
        "requested_at": "2026-06-08T12:34:56Z"
      }
    ]
  }
}