Berty Protocol

GroupInfo retrieves information about a group

POST /protocol/v1/GroupInfo

Body Required

  • group_pk string(byte)
  • contact_pk string(byte)

Responses

  • 200

    A successful response.

    Hide response attributes Show response attributes object
    • group object
      Hide group attributes Show group attributes object
      • public_key string(byte)
      • secret string(byte)
      • secret_sig string(byte)
      • group_type string
        • GroupTypeUndefined: GroupTypeUndefined indicates that the value has not been set. Should not happen.
        • GroupTypeAccount: GroupTypeAccount is the group managing an account, available to all its devices.
        • GroupTypeContact: GroupTypeContact is the group created between two accounts, available to all their devices.
        • GroupTypeMultiMember: GroupTypeMultiMember is a group containing an undefined number of members.

        Values are GroupTypeUndefined, GroupTypeAccount, GroupTypeContact, or GroupTypeMultiMember. Default value is GroupTypeUndefined.

    • member_pk string(byte)
    • device_pk string(byte)
  • default

    An unexpected error response

    Hide response attributes Show response attributes object
    • error string
    • code integer(int32)
    • message string
    • details array[object]
      Hide details attributes Show details attributes array[object]
      • type_url string
      • value string(byte)
POST /protocol/v1/GroupInfo 
curl \
 -X POST http://api.example.com/protocol/v1/GroupInfo \
 -d '{"group_pk":"string","contact_pk":"string"}'
Request example 
{
  "group_pk": "string",
  "contact_pk": "string"
}
Request examples 
{
  "group_pk": "string",
  "contact_pk": "string"
}
Response examples (200) 
{
  "group": {
    "public_key": "string",
    "secret": "string",
    "secret_sig": "string",
    "group_type": "GroupTypeUndefined"
  },
  "member_pk": "string",
  "device_pk": "string"
}
Response examples (200) 
{
  "group": {
    "public_key": "string",
    "secret": "string",
    "secret_sig": "string",
    "group_type": "GroupTypeUndefined"
  },
  "member_pk": "string",
  "device_pk": "string"
}
Response examples (default) 
{
  "error": "string",
  "code": 42,
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string"
    }
  ]
}
Response examples (default) 
{
  "error": "string",
  "code": 42,
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string"
    }
  ]
}