List Groups

get/groups

Query parameters

limitinteger

Limit Groups returned

page_cursorstring

Next/Prev page cursor

namestring

Filter to Groups with this exact name

directory_idstring

Filter to Groups synced from this Directory. Pass an empty string to filter to unsynced (native) Groups only.

entity_typestring

Filter to Groups of this entity type

Response

Group Response

Example response

{
  "data": [
    {
      "directory_id": null,
      "email": null,
      "entity_type": "group",
      "id": "42a7f82f-831a-4a9d-8f17-c66c2bb6e205",
      "idp_id": null,
      "inserted_at": "2024-01-15T10:30:00Z",
      "name": "Engineering",
      "synced_at": null,
      "updated_at": "2024-01-15T10:30:00Z"
    },
    {
      "directory_id": "6b4e3a2c-1234-5678-9abc-def012345678",
      "email": "firezone-sync-admins@example.com",
      "entity_type": "group",
      "id": "4ae929a7-1973-43f2-a1a8-9221b91a4c0e",
      "idp_id": "google-workspace-group-123",
      "inserted_at": "2024-01-10T08:15:00Z",
      "name": "firezone-sync-admins",
      "synced_at": "2024-01-14T16:00:00Z",
      "updated_at": "2024-01-14T16:45:00Z"
    }
  ],
  "metadata": {
    "limit": 10,
    "next_page": "98776234123",
    "prev_page": "123123425",
    "total": 100
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.