MemberClicks Groups API

openapi: 3.2.0
info:
  title: MemberClicks MC Professional Groups API
  description: The MemberClicks MC Professional API (formerly branded "Oasis") is a JSON REST API for interacting with an organization's association / membership management data - profiles, attributes, member types and statuses, groups, events, and continuing education credits.
  version: '1.0'
  contact:
    name: MemberClicks by Personify
    url: https://memberclicks.com
servers:
- url: https://{orgId}.memberclicks.net
  description: Per-organization MC Professional host
  variables:
    orgId:
      default: your-org
      description: The organization's MC Professional ID.
security:
- oauth2: []
tags:
- name: Groups
  description: Group membership (modeled paths).
paths:
  /api/v1/group:
    get:
      operationId: listGroups
      tags:
      - Groups
      summary: List groups
      description: Returns the organization's groups. MODELED - the Groups resource is documented (group membership is reached via a groupsUrl reference on a profile's group built-in attribute), but the exact path is behind gated documentation.
      x-endpoint-status: modeled
      responses:
        '200':
          description: A list of groups.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NamedRef'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/group/{groupId}:
    parameters:
    - name: groupId
      in: path
      required: true
      schema:
        type: string
      description: The ID of the group.
    get:
      operationId: getGroup
      tags:
      - Groups
      summary: Retrieve a group
      description: Returns a single group by ID. MODELED path.
      x-endpoint-status: modeled
      responses:
        '200':
          description: The requested group.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NamedRef'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid access token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    NamedRef:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0. Obtain a bearer token from /oauth/v1/token using HTTP Basic client credentials (Base64 clientId:clientSecret) with scope read, write, or read write.
      flows:
        clientCredentials:
          tokenUrl: https://{orgId}.memberclicks.net/oauth/v1/token
          scopes:
            read: Read access to resources.
            write: Write access to resources.