Openpath orgs/groups API

User Groups

Operations 20

GET /orgs/{orgId}/groups List all access groups #
POST /orgs/{orgId}/groups Create an access group #
GET /orgs/{orgId}/groups/{groupId} Describe an access group #
DELETE /orgs/{orgId}/groups/{groupId} Delete an access group #
PATCH /orgs/{orgId}/groups/{groupId} Update an access group #
GET /orgs/{orgId}/groups/{groupId}/zoneGroups List all zones (and their associated configurations) an access group has access to #
PATCH /orgs/{orgId}/groups/{groupId}/zoneGroups Bulk-update an access groups's zones (and their associated configurations) #
PUT /orgs/{orgId}/groups/{groupId}/zoneGroups Set an access groups's zones (and their associated configurations) by replacing the entire set with this one #
GET /orgs/{orgId}/groups/{groupId}/userIds List all user IDs of a group #
PATCH /orgs/{orgId}/groups/{groupId}/userIds Bulk-update an access group's users #
PUT /orgs/{orgId}/groups/{groupId}/userIds Set an access group's users by replacing the entire set with this one #
GET /orgs/{orgId}/groups/{groupId}/users List all users of an access group #
GET /orgs/{orgId}/groups/{groupId}/zones List all zones of an access group #
GET /orgs/{orgId}/groups/{groupId}/entries List all entries an access group has access to #
POST /orgs/{orgId}/groups/list List all access groups #
DELETE /orgs/{orgId}/groups/{groupId}/users/{userId} Remove a user from an access group #
PUT /orgs/{orgId}/groups/{groupId}/users/{userId} Add a user to an access group #
PATCH /orgs/{orgId}/groups/{groupId}/siteIds Bulk-update a group's sites #
PUT /orgs/{orgId}/groups/{groupId}/siteIds Set a group's sites by replacing the entire set with this one #
PUT /orgs/{orgId}/groups/{groupId}/zoneIds Set an access group's zones by replacing the entire set with this one #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/openpath-orgs-groups-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openpath-orgs-groups-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Openpath API Documentation auth Orgs/groups API
  version: 1.0.0
  description: Authentication and Login
servers:
- url: https://api.openpath.com
tags:
- name: orgs/groups
  description: User Groups
paths:
  /orgs/{orgId}/groups:
    get:
      summary: List all access groups
      operationId: listGroups
      description: 'listGroups takes the following options:<br/><br/>withSites - to include the group''s sites<br/><br/>ignoreSiteSpecificAccess - bypasses site specific access checks<br/><br/>__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-user:w,o{params.orgId}-user:r,o{params.orgId}-ldp:w,o{params.orgId}-ldp:r,o{params.orgId}-integrations:w,o{params.orgId}-integrations:r,o{params.orgId}-rpt:r,o{params.orgId}-rpt:w,o{params.orgId}-credential:w,o{params.orgId}-credential:r,o{params.orgId}-musterReport:r,o{params.orgId}-musterReport:w,o{params.orgId}-occupancyReport:r,o{params.orgId}-occupancyReport:w,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listGroups'
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: integer
      - name: limit
        in: query
        schema:
          type: integer
          maximum: 1000
          minimum: 1
      - name: offset
        in: query
        schema:
          type: integer
          default: 0
          minimum: 0
      - name: sort
        in: query
        schema:
          type: string
          default: name
          pattern: ^[a-zA-Z0-9.]+(,\s*[a-zA-Z0-9.]+)*$
      - name: order
        in: query
        schema:
          type: string
          default: asc
          pattern: ^(asc|desc)+(,\s*(asc|desc)+)*$
      - name: q
        in: query
        schema:
          type: string
      - name: filter
        in: query
        schema:
          type: string
      - name: preFilter
        in: query
        schema:
          type: string
      - name: options
        in: query
        schema:
          type: string
          default: ''
      tags:
      - orgs/groups
      security:
      - jwt: []
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  totalCount:
                    type: integer
                  filteredCount:
                    type: integer
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                        name:
                          type: string
                        description:
                          type:
                          - string
                          - 'null'
                        createdAt:
                          type: string
                          format: date
                        updatedAt:
                          type: string
                          format: date
                        userCount:
                          type: integer
                        badgeConfig:
                          type:
                          - object
                          - 'null'
                          properties:
                            id:
                              type: number
                            nameConfig:
                              type:
                              - object
                              - 'null'
                              properties:
                                isEnabled:
                                  type:
                                  - boolean
                                  - 'null'
                                color:
                                  type:
                                  - string
                                  - 'null'
                                fontFamily:
                                  type:
                                  - string
                                  - 'null'
                                fontSize:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                lineHeight:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                fontWeight:
                                  type:
                                  - number
                                  - 'null'
                                fontStyle:
                                  type:
                                  - string
                                  - 'null'
                                  enum:
                                  - italic
                                  - oblique
                                  - none
                                textAlign:
                                  type:
                                  - string
                                  - 'null'
                                  enum:
                                  - left
                                  - center
                                  - right
                                centerX:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                centerY:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                width:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                height:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                layout:
                                  type:
                                  - string
                                  - 'null'
                                  enum:
                                  - threeLines
                                  - twoLines
                                  - oneLine
                                textTransform:
                                  type:
                                  - string
                                  - 'null'
                                  enum:
                                  - none
                                  - uppercase
                                  - lowercase
                                  - capitalize
                            customField1Config:
                              type:
                              - object
                              - 'null'
                              properties:
                                isEnabled:
                                  type:
                                  - boolean
                                  - 'null'
                                color:
                                  type:
                                  - string
                                  - 'null'
                                fontFamily:
                                  type:
                                  - string
                                  - 'null'
                                fontSize:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                lineHeight:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                fontWeight:
                                  type:
                                  - number
                                  - 'null'
                                textAlign:
                                  type:
                                  - string
                                  - 'null'
                                  enum:
                                  - left
                                  - center
                                  - right
                                centerX:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                centerY:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                width:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                height:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                            customField2Config:
                              type:
                              - object
                              - 'null'
                              properties:
                                isEnabled:
                                  type:
                                  - boolean
                                  - 'null'
                                color:
                                  type:
                                  - string
                                  - 'null'
                                fontFamily:
                                  type:
                                  - string
                                  - 'null'
                                fontSize:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                lineHeight:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                fontWeight:
                                  type:
                                  - number
                                  - 'null'
                                textAlign:
                                  type:
                                  - string
                                  - 'null'
                                  enum:
                                  - left
                                  - center
                                  - right
                                centerX:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                centerY:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                width:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                height:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                            backgroundConfig:
                              type:
                              - object
                              - 'null'
                              properties:
                                isEnabled:
                                  type:
                                  - boolean
                                  - 'null'
                                backgroundColor:
                                  type:
                                  - string
                                  - 'null'
                                centerX:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                centerY:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                width:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                height:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                            photoConfig:
                              type:
                              - object
                              - 'null'
                              properties:
                                isEnabled:
                                  type:
                                  - boolean
                                  - 'null'
                                backgroundColor:
                                  type:
                                  - string
                                  - 'null'
                                centerX:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                centerY:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                width:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                height:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                borderRadius:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                borderColor:
                                  type:
                                  - string
                                  - 'null'
                            logoConfig:
                              type:
                              - object
                              - 'null'
                              properties:
                                isEnabled:
                                  type:
                                  - boolean
                                  - 'null'
                                backgroundColor:
                                  type:
                                  - string
                                  - 'null'
                                backgroundPosition:
                                  type:
                                  - string
                                  - 'null'
                                label:
                                  type:
                                  - string
                                  - 'null'
                                color:
                                  type:
                                  - string
                                  - 'null'
                                fontFamily:
                                  type:
                                  - string
                                  - 'null'
                                fontSize:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                lineHeight:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                fontWeight:
                                  type:
                                  - number
                                  - 'null'
                                textAlign:
                                  type:
                                  - string
                                  - 'null'
                                  enum:
                                  - left
                                  - center
                                  - right
                                centerX:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                centerY:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                width:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                height:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                            externalIdConfig:
                              type:
                              - object
                              - 'null'
                              properties:
                                isEnabled:
                                  type:
                                  - boolean
                                  - 'null'
                                color:
                                  type:
                                  - string
                                  - 'null'
                                fontFamily:
                                  type:
                                  - string
                                  - 'null'
                                fontSize:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                lineHeight:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                fontWeight:
                                  type:
                                  - number
                                  - 'null'
                                textAlign:
                                  type:
                                  - string
                                  - 'null'
                                  enum:
                                  - left
                                  - center
                                  - right
                                centerX:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                centerY:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                width:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                                height:
                                  type:
                                  - number
                                  - 'null'
                                  minimum: 0
                                  maximum: 1
                            customField1:
                              type:
                              - object
                              - 'null'
                              properties:
                                id:
                                  type: number
                                name:
                                  type: string
                              required:
                              - id
                            customField2:
                              type:
                              - object
                              - 'null'
                              properties:
                                id:
                                  type: number
                                name:
                                  type: string
                              required:
                              - id
                            badgeDefaultConfig:
                              type: object
                              properties:
                                id:
                                  type: integer
                                nameConfig:
                                  type: object
                                  properties:
                                    isEnabled:
                                      type:
                                      - boolean
                                      - 'null'
                                    color:
                                      type:
                                      - string
                                      - 'null'
                                    fontFamily:
                                      type:
                                      - string
                                      - 'null'
                                    fontSize:
                                      type:
                                      - number
                                      - 'null'
                                      minimum: 0
                                      maximum: 1
                                    lineHeight:
                                      type:
                                      - number
                                      - 'null'
                                      minimum: 0
                                      maximum: 1
                                    fontWeight:
                                      type:
                                      - number
                                      - 'null'
                                    fontStyle:
                                      type:
                                      - string
                                      - 'null'
                                      enum:
                                      - italic
                                      - oblique
                                      - none
                                    textAlign:
                                      type:
                                      - string
                                      - 'null'
                                      enum:
                                      - left
                                      - center
                                      - right
                                    centerX:
                                      type:
                                      - number
                                      - 'null'
                                      minimum: 0
                                      maximum: 1
                                    centerY:
                                      type:
                                      - number
                                      - 'null'
                                      minimum: 0
                                      maximum: 1
                                    width:
                                      type:
                                      - number
                                      - 'null'
                                      minimum: 0
                                      maximum: 1
                                    height:
                                      type:
                                      - number
                                      - 'null'
                                      minimum: 0
                                      maximum: 1
                                    layout:
                                      type:
                                      - string
                                      - 'null'
                                      enum:
                                      - threeLines
                                      - twoLines
                                      - oneLine
                                    textTransform:
                                      type:
                                      - string
                                      - 'null'
                                      enum:
                                      - none
                                      - uppercase
                                      - lowercase
                                      - capitalize
                                customField1Config:
                                  type: object
                                  properties:
                                    isEnabled:
                                      type:
                                      - boolean
                                      - 'null'
                                    color:
                                      type:
                                      - string
                                      - 'null'
                                    fontFamily:
                                      type:
                                      - string
                                      - 'null'
                                    fontSize:
                                      type:
                                      - number
                                      - 'null'
                                      minimum: 0
                                      maximum: 1
                                    lineHeight:
                                      type:
                                      - number
                                      - 'null'
                                      minimum: 0
                                      maximum: 1
                                    fontWeight:
                                      type:
                                      - number
                                      - 'null'
                                    textAlign:
                                      type:
                                      - string
                                      - 'null'
                                      enum:
                                      - left
                                      - center
                                      - right
                                    centerX:
                                      type:
                                      - number
                                      - 'null'
                                      minimum: 0
                                      maximum: 1
                                    centerY:
                                      type:
                                      - number
                                      - 'null'
                                      minimum: 0
                                      maximum: 1
                                    width:
                                      type:
                                      - number
                                      - 'null'
                                      minimum: 0
                                      maximum: 1
                                    height:
                                      type:
                                      - number
                                      - 'null'
                                      minimum: 0
                                      maximum: 1
                                customField2Config:
                                  type: object
                                  properties:
                                    isEnabled:
                                      type:
                                      - boolean
                                      - 'null'
                                    color:
                                      type:
                                      - string
                                      - 'null'
                                    fontFamily:
                                      type:
                                      - string
                                      - 'null'
                                    fontSize:
                                      type:
                                      - number
                                      - 'null'
                                      minimum: 0
                                      maximum: 1
                                    lineHeight:
                                      type:
                                      - number
                                      - 'null'
                                      minimum: 0
                                      maximum: 1
                                    fontWeight:
                                      type:
                                      - number
                                      - 'null'
                                    textAlign:
                                      type:
                                      - string
                                      - 'null'
                                      enum:
                                      - left
                                      - center
                                      - right
                                    centerX:
                                      type:
                                      - number
                                      - 'null'
                                      minimum: 0
                                      maximum: 1
                                    centerY:
                          

# --- truncated at 32 KB (227 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openpath/refs/heads/main/openapi/openpath-orgs-groups-api-openapi.yml