Search Groups

GraphQL endpoint: /user

Search for groups. This returns only the groups the user can see, public groups or the groups the user is a member of.

Query

query (
  $name: String
  $limit: Int
  $metadata: JSON
) {
  groups (
    name: $name
    limit: $limit
    metadata: $metadata
  ) {
    id
    name
    metadata
    logo_url
    visibility
  }
}

Variables

{}

Response

{
  "data": {
    "groups": [
      {
        "id": "00000000-0000-4000-8000-000000000001",
        "logo_url": "logo_url",
        "metadata": {
          "test": "value"
        },
        "name": "test group",
        "visibility": [
          "PUBLIC"
        ]
      },
      {
        "id": "00000000-0000-4000-8000-000000000002",
        "logo_url": "logo_url",
        "metadata": {
          "test": "value"
        },
        "name": "test group",
        "visibility": [
          "PUBLIC"
        ]
      },
      {
        "id": "00000000-0000-4000-8000-000000000003",
        "logo_url": "logo_url",
        "metadata": {
          "test": "value"
        },
        "name": "test group",
        "visibility": [
          "PUBLIC"
        ]
      },
      {
        "id": "00000000-0000-4000-8000-000000000004",
        "logo_url": "logo_url",
        "metadata": {
          "test": "value"
        },
        "name": "test group",
        "visibility": [
          "PUBLIC"
        ]
      },
      {
        "id": "00000000-0000-4000-8000-000000000005",
        "logo_url": "logo_url",
        "metadata": {
          "test": "value"
        },
        "name": "test group",
        "visibility": [
          "PUBLIC"
        ]
      }
    ]
  }
}