Skip to main content
GET
/
groups
Get Groups
curl --request GET \
  --url https://api.village.do/v1/groups \
  --header 'user-identifier: <user-identifier>' \
  --header 'x-access-token: <api-key>'
{
  "items": [
    {
      "id": "app-123-tech-entrepreneurs",
      "name": "Tech Entrepreneurs",
      "logo": "https://example.com/tech-logo.png",
      "invite_link": "https://village.do/invite/abc123",
      "is_admin": true
    },
    {
      "id": "user-456-startup-founders",
      "name": "Startup Founders",
      "logo": null,
      "invite_link": "https://village.do/invite/def456",
      "is_admin": false
    }
  ]
}

Authorizations

x-access-token
string
header
required

JWT token obtained from /users/authorization endpoint

Headers

user-identifier
string
required

Specify the user making the request. This identifier should match the one you used when integrating the user with Village. Not needed when using user token authentication.

Response

Successfully retrieved groups

items
object[]
required