Skip to main content
GET
Community metadata

Overview

This method returns the community metadata, such as name, description and linked groups.

Attributes

string
required
Your instance ID. Available in the Z-API panel under Instances.
string
required
Your Z-API instance token.

Path

string
required
Community ID

Response

200

string
Community name
string
Community ID
string
Community description
array
Groups linked to the community

405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.