Match It Up

Match It Up Admin API

The admin API from Match It Up — 11 operation(s) for admin.

GitHub OpenAPI

Operations 11

GET /api/admin/community-admin/invite-analytics/{community_id} Get Community Invite Analytics #
GET /api/admin/community-admin/dashboard Get Community Admin Dashboard #
GET /api/admin/community-admin/members Get Community Admin Members #
DELETE /api/admin/community-admin/members/{member_id} Remove Member From Community #
POST /api/admin/community-admin/codes Create Community Code Endpoint #
PUT /api/admin/community-admin/codes/{code_id} Update Community Code Endpoint #
GET /api/admin/community-admin/code-qr/{code} Get Code Qr #
PUT /api/admin/community-admin/circles/{circle_id}/visibility Update Circle Visibility Community Admin #
GET /api/admin/community-admin/circle-requests Get Community Admin Circle Requests #
POST /api/admin/community-admin/circle-requests/{request_id}/approve Community Admin Approve Request #
POST /api/admin/community-admin/circle-requests/{request_id}/reject Community Admin Reject Request #

Documentation

📖
Documentation
https://matchitup.in/developer-docs
📖
APIReference
https://matchitup.in/developers.html
📖
GettingStarted
https://matchitup.in/api/docs/agent-instructions.md

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/matchitup-in/refs/heads/main/openapi/matchitup-in-admin-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/matchitup-in/refs/heads/main/errors/matchitup-in-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/matchitup-in/refs/heads/main/data-model/matchitup-in-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/matchitup-in/refs/heads/main/asyncapi/matchitup-in-webhooks.yml

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/matchitup-in-admin-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.

GitHub Google LinkedIn

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

OpenAPI Specification

matchitup-in-admin-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Fast Admin API
  version: 0.1.0
  x-spec-profile: public-filtered
  x-spec-note: This is the PUBLIC spec for external agents + ChatGPT Actions. Super-admin and internal debug routes are excluded. Regenerated via backend/scripts/filter_public_openapi.py.
  description: Public API for external agents and ChatGPT Custom GPT Actions.
servers:
- url: https://matchitup.in
  description: Production
tags:
- name: Admin
paths:
  /api/admin/community-admin/invite-analytics/{community_id}:
    get:
      tags:
      - Admin
      summary: Get Community Invite Analytics
      description: 'Get aggregated invite code analytics for a community.

        Available to community admins of that community.'
      operationId: get_community_invite_analytics_api_admin_community_admin_invite_analytics__community_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: community_id
        in: path
        required: true
        schema:
          type: string
          title: Community Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/admin/community-admin/dashboard:
    get:
      tags:
      - Admin
      summary: Get Community Admin Dashboard
      description: Get community admin dashboard data. Optionally specify community_id for multi-community admins.
      operationId: get_community_admin_dashboard_api_admin_community_admin_dashboard_get
      security:
      - HTTPBearer: []
      parameters:
      - name: community_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Community Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/admin/community-admin/members:
    get:
      tags:
      - Admin
      summary: Get Community Admin Members
      description: Get members list for community admin. Optionally specify community_id for multi-community admins.
      operationId: get_community_admin_members_api_admin_community_admin_members_get
      security:
      - HTTPBearer: []
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Page
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 20
          title: Limit
      - name: search
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Search
      - name: community_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Community Id
      - name: circle_filter
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Circle Filter
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/admin/community-admin/members/{member_id}:
    delete:
      tags:
      - Admin
      summary: Remove Member From Community
      description: 'Remove a member from community.

        Works for both Community Admins (their own community) and Super Admins (any community).'
      operationId: remove_member_from_community_api_admin_community_admin_members__member_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: member_id
        in: path
        required: true
        schema:
          type: string
          title: Member Id
      - name: community_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Community Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/admin/community-admin/codes:
    post:
      tags:
      - Admin
      summary: Create Community Code Endpoint
      description: Create a new community code
      operationId: create_community_code_endpoint_api_admin_community_admin_codes_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCodeRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/admin/community-admin/codes/{code_id}:
    put:
      tags:
      - Admin
      summary: Update Community Code Endpoint
      description: Update a community code status
      operationId: update_community_code_endpoint_api_admin_community_admin_codes__code_id__put
      security:
      - HTTPBearer: []
      parameters:
      - name: code_id
        in: path
        required: true
        schema:
          type: string
          title: Code Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCodeStatusRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/admin/community-admin/code-qr/{code}:
    get:
      tags:
      - Admin
      summary: Get Code Qr
      description: Get QR code for a specific community code
      operationId: get_code_qr_api_admin_community_admin_code_qr__code__get
      security:
      - HTTPBearer: []
      parameters:
      - name: code
        in: path
        required: true
        schema:
          type: string
          title: Code
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/admin/community-admin/circles/{circle_id}/visibility:
    put:
      tags:
      - Admin
      summary: Update Circle Visibility Community Admin
      description: 'Update brew circle visibility - Community Admin endpoint.

        Community admins can only change visibility for circles in their own communities.


        - public: Visible on homepage (if community is open), anyone can request to join

        - community: Only visible to community members

        - private: Invite-only, hidden from non-members'
      operationId: update_circle_visibility_community_admin_api_admin_community_admin_circles__circle_id__visibility_put
      security:
      - HTTPBearer: []
      parameters:
      - name: circle_id
        in: path
        required: true
        schema:
          type: string
          title: Circle Id
      - name: visibility
        in: query
        required: true
        schema:
          type: string
          title: Visibility
      - name: community_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Community Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/admin/community-admin/circle-requests:
    get:
      tags:
      - Admin
      summary: Get Community Admin Circle Requests
      description: 'Get circle join requests for communities this admin manages.

        Community admins can view and manage requests for their communities.'
      operationId: get_community_admin_circle_requests_api_admin_community_admin_circle_requests_get
      security:
      - HTTPBearer: []
      parameters:
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Status
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/admin/community-admin/circle-requests/{request_id}/approve:
    post:
      tags:
      - Admin
      summary: Community Admin Approve Request
      description: 'Approve a circle join request - Community Admin endpoint.

        Community admins can only approve requests for their own communities.'
      operationId: community_admin_approve_request_api_admin_community_admin_circle_requests__request_id__approve_post
      security:
      - HTTPBearer: []
      parameters:
      - name: request_id
        in: path
        required: true
        schema:
          type: string
          title: Request Id
      - name: admin_note
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: ''
          title: Admin Note
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/admin/community-admin/circle-requests/{request_id}/reject:
    post:
      tags:
      - Admin
      summary: Community Admin Reject Request
      description: 'Reject a circle join request - Community Admin endpoint.

        Community admins can only reject requests for their own communities.'
      operationId: community_admin_reject_request_api_admin_community_admin_circle_requests__request_id__reject_post
      security:
      - HTTPBearer: []
      parameters:
      - name: request_id
        in: path
        required: true
        schema:
          type: string
          title: Request Id
      - name: admin_note
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: ''
          title: Admin Note
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    UpdateCodeStatusRequest:
      properties:
        status:
          type: string
          title: Status
        community_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Community Id
      type: object
      required:
      - status
      title: UpdateCodeStatusRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CreateCodeRequest:
      properties:
        max_uses:
          anyOf:
          - type: integer
          - type: 'null'
          title: Max Uses
        expires_days:
          anyOf:
          - type: integer
          - type: 'null'
          title: Expires Days
        discount_percent:
          anyOf:
          - type: integer
          - type: 'null'
          title: Discount Percent
          default: 0
        discount_valid_months:
          anyOf:
          - type: integer
          - type: 'null'
          title: Discount Valid Months
          default: 0
        community_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Community Id
        grant_tier:
          anyOf:
          - type: string
          - type: 'null'
          title: Grant Tier
        grant_duration_months:
          anyOf:
          - type: integer
          - type: 'null'
          title: Grant Duration Months
          default: 0
        brew_circle_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Brew Circle Id
        brew_circle_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Brew Circle Name
      type: object
      title: CreateCodeRequest
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer