Get Group By ID

GET 
/groups/482

Get Group By ID

Request

Responses

200

OK

Response Headers

• X-Powered-By any
• Content-Length any
• ETag any
• Date any
• Connection any
• Keep-Alive any

application/json; charset=utf-8

Schema

Schema

status int32required
data objectrequired
invitation_code stringnullablerequired
participants object[]required
Array [
id stringrequired
admin stringnullablerequired
]
device_id stringrequired
jid stringrequired
title stringrequired
description stringnullablerequired
image_url stringnullablerequired
created_at stringrequired
updated_at stringrequired

Example (from schema)

{
  "status": 200,
  "data": {
    "invitation_code": null,
    "participants": [
      {
        "id": "6285156055377",
        "admin": null
      },
      {
        "id": "6285603051722",
        "admin": null
      },
      {
        "id": "62859106527882",
        "admin": "superadmin"
      }
    ],
    "device_id": "5",
    "jid": "120363041530231017@g.us",
    "title": "B Group TEST",
    "description": null,
    "image_url": null,
    "created_at": "2022-05-23T20:17:58.000Z",
    "updated_at": "2022-05-23T20:17:58.000Z"
  }
}

Example

{
  "status": 200,
  "data": {
    "invitation_code": null,
    "participants": [
      {
        "id": "6285156055377",
        "admin": null
      },
      {
        "id": "6285603051722",
        "admin": null
      },
      {
        "id": "62859106527882",
        "admin": "superadmin"
      }
    ],
    "device_id": "5",
    "jid": "120363041530231017@g.us",
    "title": "B Group TEST",
    "description": null,
    "image_url": null,
    "created_at": "2022-05-23T20:17:58.000Z",
    "updated_at": "2022-05-23T20:17:58.000Z"
  }
}

403

General Forbidden Error Response

application/json

Schema

Schema

status integer

Forbidden

message string

HTTP Status Message

Example (from schema)

{
  "status": 403,
  "message": "Forbidden"
}

404

General Not Found Error Response

application/json

Schema

Schema

status integer

Not Found

message string

HTTP Status Message

Example (from schema)

{
  "status": 404,
  "message": "Not Found"
}

422

General Validation Error Response

application/json

Schema

Schema

status integer

HTTP Status Code

message string

HTTP Status Message

errors string[]

Example (from schema)

{
  "status": 422,
  "message": "Validation Error ",
  "errors": [
    "string"
  ]
}

500

Internal Server Error

Response Headers

• Date any
• Content-Length any

application/json; charset=utf-8

Schema

Schema

code int32required
message stringrequired
error stringnullablerequired

Example

{
  "code": 500,
  "message": "FORBIDDEN",
  "error": null
}

Loading...