Clerk Frontend Api — Invitations

naftiko: 1.0.0-alpha2
info:
  label: Clerk Frontend Api — Invitations
  description: 'Clerk Invitations capability. 5 operations. Lead operation: Create Organization Invitation.'
  tags:
  - Clerk
  - Invitations
  created: '2026-05-22'
  modified: '2026-05-22'
binds:
- namespace: env
  keys:
    CLERK_PUBLISHABLE_KEY: CLERK_PUBLISHABLE_KEY
capability:
  consumes:
  - type: http
    namespace: clerk-frontend-api-invitations
    baseUri: ''
    description: Clerk clerk-frontend-api Invitations business capability.
    resources:
    - name: v1-organizations-organization-id-invitations
      path: /v1/organizations/{organization_id}/invitations
      operations:
      - name: createOrganizationInvitations
        method: POST
        description: Create Organization Invitation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organization_id
          in: path
          type: string
          description: The ID of the organization for which the invitation will be created.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: getOrganizationInvitations
        method: GET
        description: Get All Organization Invitations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organization_id
          in: path
          type: string
          description: The ID of the organization for which the invitation will be retrieved.
          required: true
        - name: status
          in: query
          type: string
          description: ''
          required: false
    - name: v1-organizations-organization-id-invitations-bulk
      path: /v1/organizations/{organization_id}/invitations/bulk
      operations:
      - name: bulkCreateOrganizationInvitations
        method: POST
        description: Bulk Create Organization Invitations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organization_id
          in: path
          type: string
          description: The ID of the organization for which the invitations will be created.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-organizations-organization-id-invitations-pending
      path: /v1/organizations/{organization_id}/invitations/pending
      operations:
      - name: getAllPendingOrganizationInvitations
        method: GET
        description: Get All Pending Organization Invitations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organization_id
          in: path
          type: string
          description: The ID of the organization for which the invitations will be retrieved.
          required: true
    - name: v1-organizations-organization-id-invitations-invitation-id-revoke
      path: /v1/organizations/{organization_id}/invitations/{invitation_id}/revoke
      operations:
      - name: revokePendingOrganizationInvitation
        method: POST
        description: Revoke Pending Organization Invitation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organization_id
          in: path
          type: string
          description: The ID of the organization for which the invitations will be retrieved.
          required: true
        - name: invitation_id
          in: path
          type: string
          description: The ID of the invitation to revoke.
          required: true