Pirsch

Pirsch Members API

Manage domain members, roles, and invitations

GitHub OpenAPI

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /member List members of a domain or organization · List domain members #
Ask an LLM
“Who has access to my site's analytics?”
“Can I see all members of an organization and their roles?”
Tell an agent
List the members of domain {id}.
Show everyone in organization {organization_id}.
POST /member Invite people by email to a domain · Invite members #
Ask an LLM
“How do I invite my colleagues to view my site's statistics?”
“Can I send invitations to several email addresses at once?”
Tell an agent
Invite {emails} to domain {id}.
Send organization {organization_id} invitations to {emails}.
PUT /member Change a member's role · Update member role #
Ask an LLM
“How do I make a teammate an admin on my site?”
“Can I downgrade an existing member to view-only?”
Tell an agent
Change member {id} to role {role}.
Give member {id} the {role} role.
DELETE /member Remove a member's access · Remove member #
Ask an LLM
“How do I take away a former employee's access to my dashboard?”
“Can I remove a single member from a site?”
Tell an agent destructive · confirm first
Remove member {id}.
Revoke dashboard access for member {id}.
GET /invitation List pending invitations · List invitations #
Ask an LLM
“Which invitations are still pending for my site?”
“Can I see outstanding invites for an organization?”
Tell an agent
List pending invitations for domain {domain_id}.
Show open invites to organization {organization_id}.
POST /invitation Accept an invitation · Accept invitation #
Ask an LLM
“How do I accept an invitation someone sent me to their site?”
“What's needed to join a domain I've been invited to?”
Tell an agent
Accept invitation {id}.
Join the site by accepting invite {id}.
DELETE /invitation Withdraw a pending invitation · Delete invitation #
Ask an LLM
“How do I cancel an invitation I sent to the wrong email?”
“Can I withdraw a pending invite before it's accepted?”
Tell an agent destructive · confirm first
Delete invitation {id}.
Withdraw pending invite {id} for domain {domain_id}.

Documentation

📖
Documentation
https://docs.pirsch.io/api-sdks/api-v1

Specifications

⚙
OpenAPI
https://artifacts.apis.io/pirsch/openapi/pirsch-members-api-openapi.yml

Other Resources

🔗
APIGuide
https://docs.pirsch.io/api-sdks/api-guide-v1
🔗
SDKs
https://docs.pirsch.io/api-sdks/sdks

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/pirsch:pirsch-members-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

pirsch-members-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Pirsch Members API
  description: RESTful API for sending page views, events, and session data to Pirsch, and for querying statistics including visitors, pages, referrers, UTM parameters, geo-location, device, browser, conversion goals, funnels, and real-time active visitors. Also exposes management endpoints for domains, members, clients, webhooks, email reports, traffic filters, short links, and views.
  version: '1'
  contact:
    name: Pirsch Support
    url: https://pirsch.io
  license:
    name: Proprietary
    url: https://pirsch.io/privacy
servers:
- url: https://api.pirsch.io/api/v1
  description: Pirsch production API
security:
- BearerAuth: []
tags:
- name: Members
  description: Manage domain members, roles, and invitations
paths:
  /member:
    get:
      operationId: listMembers
      summary: List domain members
      tags:
      - Members
      parameters:
      - name: id
        in: query
        schema:
          type: string
        description: Domain ID
      - name: organization_id
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Members
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Member'
    post:
      operationId: inviteMembers
      summary: Invite members
      description: Send invitations to one or more email addresses
      tags:
      - Members
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InviteMembersRequest'
      responses:
        '200':
          description: Invitations sent
    put:
      operationId: updateMember
      summary: Update member role
      tags:
      - Members
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMemberRequest'
      responses:
        '200':
          description: Member role updated
    delete:
      operationId: removeMember
      summary: Remove member
      tags:
      - Members
      parameters:
      - name: id
        in: query
        required: true
        schema:
          type: string
        description: Member ID
      responses:
        '200':
          description: Member removed
  /invitation:
    get:
      operationId: listInvitations
      summary: List invitations
      tags:
      - Members
      parameters:
      - name: domain_id
        in: query
        schema:
          type: string
      - name: organization_id
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Invitations
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Invitation'
    post:
      operationId: acceptInvitation
      summary: Accept invitation
      tags:
      - Members
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - id
              properties:
                id:
                  type: string
      responses:
        '200':
          description: Invitation accepted
    delete:
      operationId: deleteInvitation
      summary: Delete invitation
      tags:
      - Members
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - id
              properties:
                id:
                  type: string
                domain_id:
                  type: string
                organization_id:
                  type: string
      responses:
        '200':
          description: Invitation deleted
components:
  schemas:
    UpdateMemberRequest:
      type: object
      required:
      - id
      - role
      properties:
        id:
          type: string
          description: Member ID
        role:
          type: string
          enum:
          - Viewer
          - Admin
    Member:
      type: object
      properties:
        id:
          type: string
        role:
          type: string
          enum:
          - Owner
          - Admin
          - Viewer
        user_id:
          type: string
        user:
          type: object
    Invitation:
      type: object
      properties:
        id:
          type: string
        email:
          type: string
          format: email
        domain:
          type: object
        organization:
          type: object
    InviteMembersRequest:
      type: object
      properties:
        id:
          type: string
          description: Domain ID
        organization_id:
          type: string
        emails:
          type: array
          items:
            type: string
            format: email
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Pass an OAuth2 access token obtained from POST /token, or a static access key, as a Bearer token in the Authorization header.