Rulebase Invitations API
The Invitations API from Rulebase — 3 operation(s) for invitations.
The Invitations API from Rulebase — 3 operation(s) for invitations.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/rulebase:rulebase-invitations-api"
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.
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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Rulebase API2 Invitations API
version: 0.0.1
tags:
- name: Invitations
paths:
/invitations:
get:
parameters:
- schema:
type: integer
minimum: 0
exclusiveMinimum: true
required: false
name: page[page]
in: query
- schema:
type: integer
description: Values above 100 are clamped to 100
minimum: 1
required: false
name: page[limit]
in: query
- schema:
type: string
required: false
name: filter
in: query
responses:
'200':
description: Invitations for the current organization
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
email:
type: string
status:
type: string
scope_type:
type: string
created_at:
type: string
updated_at:
type: string
role:
type: object
nullable: true
properties:
id:
type: string
name:
type: string
description:
type: string
nullable: true
created_at:
type: string
updated_at:
type: string
memberships_count:
type: number
global:
type: boolean
permissions:
type: array
items:
type: object
properties:
id:
type: string
description:
type: string
nullable: true
required:
- id
- description
required:
- id
- name
- description
- created_at
- updated_at
- memberships_count
- global
- permissions
scopes:
type: array
items:
type: object
properties:
id:
type: string
scope:
anyOf:
- type: object
properties:
id:
type: string
name:
type: string
full_name:
type: string
created_at:
type: string
updated_at:
type: string
group_memberships_count:
type: integer
employees_count:
type: integer
parent_group_id:
type: string
nullable: true
parent_group_name:
type: string
nullable: true
connection_name:
type: string
nullable: true
required:
- id
- name
- full_name
- created_at
- updated_at
- group_memberships_count
- employees_count
- parent_group_id
- parent_group_name
- connection_name
- type: object
properties:
id:
type: string
name:
type: string
partner_type:
type: string
nullable: true
domains:
type: array
items:
type: string
employees_count:
type: integer
created_at:
type: string
updated_at:
type: string
required:
- id
- name
- partner_type
- domains
- employees_count
- created_at
- updated_at
- type: object
properties:
id:
type: string
name:
type: string
employees_count:
type: integer
created_at:
type: string
updated_at:
type: string
zendesk_brand_id:
type: string
nullable: true
partner_id:
type: string
nullable: true
team_lead_membership_id:
type: string
nullable: true
team_lead_membership_ids:
type: array
items:
type: string
required:
- id
- name
- employees_count
- created_at
- updated_at
- zendesk_brand_id
- partner_id
- team_lead_membership_id
- team_lead_membership_ids
- nullable: true
required:
- id
- scope
required:
- id
- email
- status
- scope_type
- created_at
- updated_at
- role
- scopes
meta:
type: object
properties:
page:
type: object
properties:
next:
type: string
nullable: true
limit:
type: integer
total:
type: integer
required:
- next
- limit
- total
required:
- page
required:
- data
- meta
'400':
description: Malformed filter
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
'503':
description: Rails organization unavailable
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
tags:
- Invitations
summary: Get invitations
x-summary-source: derived
operationId: getInvitations
x-operation-id-source: derived
/invitations/{id}/revoke:
post:
parameters:
- schema:
type: string
required: true
name: id
in: path
responses:
'200':
description: Revoked invitation
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: string
email:
type: string
status:
type: string
scope_type:
type: string
created_at:
type: string
updated_at:
type: string
role:
type: object
nullable: true
properties:
id:
type: string
name:
type: string
description:
type: string
nullable: true
created_at:
type: string
updated_at:
type: string
memberships_count:
type: number
global:
type: boolean
permissions:
type: array
items:
type: object
properties:
id:
type: string
description:
type: string
nullable: true
required:
- id
- description
required:
- id
- name
- description
- created_at
- updated_at
- memberships_count
- global
- permissions
scopes:
type: array
items:
type: object
properties:
id:
type: string
scope:
anyOf:
- type: object
properties:
id:
type: string
name:
type: string
full_name:
type: string
created_at:
type: string
updated_at:
type: string
group_memberships_count:
type: integer
employees_count:
type: integer
parent_group_id:
type: string
nullable: true
parent_group_name:
type: string
nullable: true
connection_name:
type: string
nullable: true
required:
- id
- name
- full_name
- created_at
- updated_at
- group_memberships_count
- employees_count
- parent_group_id
- parent_group_name
- connection_name
- type: object
properties:
id:
type: string
name:
type: string
partner_type:
type: string
nullable: true
domains:
type: array
items:
type: string
employees_count:
type: integer
created_at:
type: string
updated_at:
type: string
required:
- id
- name
- partner_type
- domains
- employees_count
- created_at
- updated_at
- type: object
properties:
id:
type: string
name:
type: string
employees_count:
type: integer
created_at:
type: string
updated_at:
type: string
zendesk_brand_id:
type: string
nullable: true
partner_id:
type: string
nullable: true
team_lead_membership_id:
type: string
nullable: true
team_lead_membership_ids:
type: array
items:
type: string
required:
- id
- name
- employees_count
- created_at
- updated_at
- zendesk_brand_id
- partner_id
- team_lead_membership_id
- team_lead_membership_ids
- nullable: true
required:
- id
- scope
required:
- id
- email
- status
- scope_type
- created_at
- updated_at
- role
- scopes
required:
- data
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
'404':
description: Not found
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
'422':
description: Unprocessable
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
'503':
description: Rails organization unavailable
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
tags:
- Invitations
summary: Create invitations by id revoke
x-summary-source: derived
operationId: postInvitationsByIdRevoke
x-operation-id-source: derived
/invitations/import:
post:
requestBody:
content:
application/json:
schema:
type: object
properties:
invitations:
type: object
properties:
role_id:
type: string
scope_type:
type: string
nullable: true
emails:
type: array
items:
type: string
scopes:
type: array
items:
type: object
properties:
scope_type:
type: string
scope_id:
type: string
required:
- scope_type
- scope_id
required:
- role_id
- emails
additionalProperties: false
required:
- invitations
responses:
'201':
description: Created invitations
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
email:
type: string
status:
type: string
scope_type:
type: string
created_at:
type: string
updated_at:
type: string
role:
type: object
nullable: true
properties:
id:
type: string
name:
type: string
description:
type: string
nullable: true
created_at:
type: string
updated_at:
type: string
memberships_count:
type: number
global:
type: boolean
permissions:
type: array
items:
type: object
properties:
id:
type: string
description:
type: string
nullable: true
required:
- id
- description
required:
- id
- name
- description
- created_at
- updated_at
- memberships_count
- global
- permissions
scopes:
type: array
items:
type: object
properties:
id:
type: string
scope:
anyOf:
- type: object
properties:
id:
type: string
name:
type: string
full_name:
type: string
created_at:
type: string
updated_at:
type: string
group_memberships_count:
type: integer
employees_count:
type: integer
parent_group_id:
type: string
nullable: true
parent_group_name:
type: string
nullable: true
connection_name:
type: string
nullable: true
required:
- id
- name
- full_name
- created_at
- updated_at
- group_memberships_count
- employees_count
- parent_group_id
- parent_group_name
- connection_name
- type: object
properties:
id:
type: string
name:
type: string
partner_type:
type: string
nullable: true
domains:
type: array
items:
type: string
employees_count:
type: integer
created_at:
type: string
updated_at:
type: string
required:
- id
- name
- partner_type
- domains
- employees_count
- created_at
- updated_at
- type: object
properties:
id:
type: string
name:
type: string
employees_count:
type: integer
created_at:
type: string
updated_at:
type: string
zendesk_brand_id:
type: string
nullable: true
partner_id:
type: string
nullable: true
team_lead_membership_id:
type: string
nullable: true
team_lead_membership_ids:
type: array
items:
type: string
required:
- id
- name
- employees_count
- created_at
- updated_at
- zendesk_brand_id
- partner_id
- team_lead_membership_id
- team_lead_membership_ids
- nullable: true
required:
- id
- scope
required:
- id
- email
- status
- scope_type
- created_at
- updated_at
- role
- scopes
required:
- data
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
'404':
description: Not found
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
'422':
description: Unprocessable
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
'503':
description: Rails organization unavailable
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
tags:
- Invitations
summary: Create invitations import
x-summary-source: derived
operationId: postInvitationsImport
x-operation-id-source: derived
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: Rulebase organization API key