PropelAuth

PropelAuth Invites API

Inspect and revoke pending organization invites

GitHub OpenAPI

Operations 4

POST /api/backend/v1/invite_user Invite User To Org #
POST /api/backend/v1/invite_user_by_id Invite User To Org By User ID #
GET /api/backend/v1/pending_org_invites Fetch Pending Invites #
DELETE /api/backend/v1/pending_org_invites Revoke Pending Org Invite #

Documentation

📖
Documentation
https://docs.propelauth.com/reference/api/user
📖
GettingStarted
https://docs.propelauth.com/reference/api/getting-started
📖
Documentation
https://docs.propelauth.com/reference/api/org
📖
Documentation
https://docs.propelauth.com/mcp-authentication/overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/propelauth/refs/heads/main/openapi/propelauth-invites-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/propelauth/refs/heads/main/json-schema/propelauth-user-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/propelauth/refs/heads/main/json-schema/propelauth-org-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/propelauth/refs/heads/main/json-ld/propelauth-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/propelauth/refs/heads/main/examples/propelauth-create-user-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/propelauth/refs/heads/main/examples/propelauth-create-magic-link-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/propelauth/refs/heads/main/examples/propelauth-create-org-example.json

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/propelauth-invites-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

propelauth-invites-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: PropelAuth Organization Invites API
  description: 'Backend REST API for managing tenants (organizations) in PropelAuth. Create and update

    organizations, add and remove members, invite users, change roles, manage role mappings,

    and revoke pending invites. All endpoints require a PropelAuth Backend Integration API key

    presented as a Bearer token.'
  version: 1.0.0
  contact:
    name: PropelAuth Support
    url: https://www.propelauth.com
    email: support@propelauth.com
  license:
    name: PropelAuth Terms
    url: https://www.propelauth.com/legal/terms-of-service
servers:
- url: https://{authId}.propelauthtest.com
  description: Test environment
  variables:
    authId:
      default: '0000000000'
- url: https://auth.example.com
  description: Production / Staging custom domain
security:
- BackendApiKey: []
tags:
- name: Invites
  description: Inspect and revoke pending organization invites
paths:
  /api/backend/v1/invite_user:
    post:
      summary: Invite User To Org
      description: Send an invite email for a user to join an organization.
      operationId: inviteUserToOrg
      tags:
      - Invites
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - email
              - org_id
              - role
              properties:
                email:
                  type: string
                  format: email
                org_id:
                  type: string
                  format: uuid
                role:
                  type: string
                additional_roles:
                  type: array
                  items:
                    type: string
      responses:
        '200':
          description: Invite sent
  /api/backend/v1/invite_user_by_id:
    post:
      summary: Invite User To Org By User ID
      description: Invite an existing user (by ID) into an organization.
      operationId: inviteUserToOrgById
      tags:
      - Invites
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - user_id
              - org_id
              - role
              properties:
                user_id:
                  type: string
                  format: uuid
                org_id:
                  type: string
                  format: uuid
                role:
                  type: string
      responses:
        '200':
          description: Invite created
  /api/backend/v1/pending_org_invites:
    get:
      summary: Fetch Pending Invites
      description: Page through pending invites for an organization or across the whole project.
      operationId: fetchPendingInvites
      tags:
      - Invites
      parameters:
      - name: org_id
        in: query
        schema:
          type: string
          format: uuid
      - name: page_size
        in: query
        schema:
          type: integer
          default: 10
      - name: page_number
        in: query
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: Pending invites
          content:
            application/json:
              schema:
                type: object
                properties:
                  invites:
                    type: array
                    items:
                      $ref: '#/components/schemas/PendingInvite'
                  total_invites:
                    type: integer
                  has_more_results:
                    type: boolean
    delete:
      summary: Revoke Pending Org Invite
      description: Revoke a pending invite.
      operationId: revokePendingOrgInvite
      tags:
      - Invites
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - org_id
              - invitee_email
              properties:
                org_id:
                  type: string
                  format: uuid
                invitee_email:
                  type: string
                  format: email
      responses:
        '200':
          description: Invite revoked
components:
  schemas:
    PendingInvite:
      type: object
      properties:
        invitee_email:
          type: string
          format: email
        org_id:
          type: string
          format: uuid
        org_name:
          type: string
        role_in_org:
          type: string
        additional_roles_in_org:
          type: array
          items:
            type: string
        created_at:
          type: integer
        expires_at:
          type: integer
        inviter_email:
          type: string
          format: email
        inviter_user_id:
          type: string
          format: uuid
  securitySchemes:
    BackendApiKey:
      type: http
      scheme: bearer