Skip to main content
GET
/
v1
/
groups
List Groups
curl --request GET \
  --url https://api.us.lexful.app/v1/groups \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-ID: <api-key>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "organization_scopes": [
        "<string>"
      ],
      "denied_organization_scopes": [
        "<string>"
      ],
      "denied_entity_types": [
        "<string>"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

Authorization
string
header
required

Bearer token

X-Account-ID
string
header
required

Account ID

Query Parameters

name
string

Filter by name (exact match)

limit
number
default:100

Number of items to return

Required range: 1 <= x <= 1000
offset
number
default:0

Number of items to skip

Required range: x >= 0

Response

Default Response

items
object[]
required
total
number
required

Total number of items available

limit
number
required

Number of items returned

offset
number
required

Number of items skipped