LUlucid
Groups

Get All Groups or Teams

Gets all org groups or teams on an account. Supports pagination and filtering.

get/Groups

Request

  • Base URL
    https://users.lucid.app/scim/v2
  • URL
    https://users.lucid.app/scim/v2/Groups
  • Auth
    HTTP bearer

Query parameters

filterstring

Filter groups/teams using SCIM filter syntax. Only single filter queries are supported. Currently supports filtering by displayName (case-sensitive exact match).

countinteger

Maximum number of groups/teams to return per page for pagination. Negative values are interpreted as 0.

startIndexinteger

The 1-based index of the first result to return for pagination. Values less than 1 are interpreted as 1.

attributesstring[]

Comma-separated list of attribute names to return in the response. The attribute id is always returned. Available attributes are schemas, displayName, members, and meta. Cannot be used with excludedAttributes.

excludedAttributesstring[]

Comma-separated list of attribute names to exclude from the response. The attribute id is always returned and cannot be excluded. Can exclude schemas, displayName, members, or meta. Cannot be used with attributes.

Response

OK. Returns a list of org groups or teams.

schemasstring[]

SCIM schema URIs for the list response.

totalResultsinteger

The total number of org groups or teams matching the query (across all pages, not just the current page).

startIndexinteger

The 1-based index of the first result in the "Resources" list (for paginated results). Reflects the startIndex parameter sent in the request.

itemsPerPageinteger

The maximum number of results returned in the "Resources" list (for paginated results). Reflects the count parameter sent in the request.

Example response

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 42,
  "startIndex": 1,
  "itemsPerPage": 100,
  "Resources": [
    {
      "id": "lucid-group-1234",
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
      ],
      "displayName": "Group A",
      "members": [
        {
          "value": "lucid-1433",
          "display": "User 1"
        },
        {
          "value": "lucid-5678",
          "display": "User 2"
        },
        {
          "value": "lucid-group-9012",
          "display": "Subgroup A"
        }
      ]
    }
  ]
}

Changes

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