Runn

Runn Invitations API

The Invitations API from Runn — 2 operation(s) for invitations.

GitHub OpenAPI

Operations 3

GET /invitations/ List invitations #
POST /invitations/ Create an invitation for a user #
DELETE /invitations/{invitationId} Delete an invitation #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/runn/openapi/runn-invitations-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/runn/json-schema/runn-person-schema.json
📊
JSONSchema
https://artifacts.apis.io/runn/json-schema/runn-project-schema.json
📊
JSONSchema
https://artifacts.apis.io/runn/json-schema/runn-invitation-schema.json
📊
JSONSchema
https://artifacts.apis.io/runn/json-schema/runn-reports-hours-people-schema.json
📊
JSONSchema
https://artifacts.apis.io/runn/json-schema/runn-reports-hours-projects-schema.json
📊
JSONSchema
https://artifacts.apis.io/runn/json-schema/runn-actual-time-entry-schema.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/runn:runn-invitations-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

runn-invitations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Runn Invitations API
  version: 1.0.0
  description: 'See the full documentation and guide to using the Runn API.


    The domain for your API endpoint can be found in Accounts > Settings > API in your Runn application'
servers:
- url: https://api.runn.io
  description: EU Server
- url: https://api.us.runn.io
  description: US Server
security:
- bearerAuth: []
tags:
- name: Invitations
paths:
  /invitations/:
    get:
      operationId: listInvitations
      summary: List invitations
      description: Get a list of invitations. Does not contain the invitation token for security reasons
      parameters:
      - schema:
          type: string
        in: query
        name: cursor
        required: false
        description: Cursor for paginated requests
      - schema:
          default: 50
          minimum: 1
          maximum: 200
          type: integer
        in: query
        name: limit
        required: false
        description: The number of results per page
      - schema:
          type: string
          enum:
          - createdAt
          - sentAt
          - id
          default: id
        in: query
        name: sortBy
        required: false
        description: 'Field to sort by: createdAt or sentAt or id'
      - schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
        in: query
        name: order
        required: false
        description: 'Sort order: asc or desc'
      - schema:
          default: 1.0.0
          enum:
          - 1.0.0
        in: header
        name: accept-version
        required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  values:
                    type: array
                    items:
                      $ref: '#/components/schemas/Invitation'
                  nextCursor:
                    type: string
                    nullable: true
                required:
                - values
                - nextCursor
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
      tags:
      - Invitations
    post:
      operationId: createInvitation
      summary: Create an invitation for a user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
              - type: object
                properties:
                  email:
                    description: Email for the invitation.
                    type: string
                  userType:
                    type: string
                    enum:
                    - admin
                    - editor
                    - viewer_all
                    - viewer_basic
                    - timesheet_only
                    - manager
                    - contributor
                    description: Permission level
                  financialPermission:
                    type: string
                    enum:
                    - all
                    - no_salaries
                    - restricted
                    - none
                    description: Financial permission level
                  fromUser:
                    description: Email address of user the invite should be sent from (must be a Runn user with admin permissions).
                    type: string
                  managePeoplePermission:
                    type: string
                    enum:
                    - all
                    - restricted
                    - none
                    description: Manage people permission level. 'restricted' grants access to nobody until teams or people are assigned (see peopleTeams, or managers on the people endpoints). When omitted, defaults to whichever of manageOthersPermission or editOthersPermission was sent.
                  peopleTeams:
                    maxItems: 1000
                    uniqueItems: true
                    description: Teams whose members this restricted people manager can manage. An empty array is treated the same as omitting the field.
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          minimum: 1
                          maximum: 2147483647
                          type: integer
                      required:
                      - id
                required:
                - email
                - userType
                - financialPermission
                - fromUser
              - anyOf:
                - type: object
                  properties:
                    editProjectsPermission:
                      type: string
                      enum:
                      - all
                      - specific
                      - restricted
                      - none
                      deprecated: true
                      description: 'Permissions for editing projects. (deprecated: use manageProjectsPermission)'
                    editOthersPermission:
                      type: string
                      enum:
                      - all
                      - none
                      deprecated: true
                      description: 'Permissions for editing other parts of the account (people, clients, teams etc.). (deprecated: use managePeoplePermission)'
                  required:
                  - editProjectsPermission
                  - editOthersPermission
                - type: object
                  properties:
                    manageProjectsPermission:
                      type: string
                      enum:
                      - all
                      - specific
                      - restricted
                      - none
                      description: Permissions for managing projects.
                    manageOthersPermission:
                      type: string
                      enum:
                      - all
                      - none
                      deprecated: true
                      description: 'Permissions for managing other parts of the account (people, clients, teams etc.). (deprecated: use managePeoplePermission)'
                  required:
                  - manageProjectsPermission
                  - manageOthersPermission
      parameters:
      - schema:
          default: 1.0.0
          enum:
          - 1.0.0
        in: header
        name: accept-version
        required: true
      responses:
        '201':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Invitation'
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
      tags:
      - Invitations
  /invitations/{invitationId}:
    delete:
      operationId: deleteInvitation
      summary: Delete an invitation
      parameters:
      - schema:
          type: integer
        in: path
        name: invitationId
        required: true
      - schema:
          default: 1.0.0
          enum:
          - 1.0.0
        in: header
        name: accept-version
        required: true
      responses:
        '204':
          description: Default Response
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
      tags:
      - Invitations
components:
  schemas:
    Unauthorized:
      type: object
      properties:
        error:
          type: string
          enum:
          - Unauthorized
        message:
          type: string
          enum:
          - Unauthorized
        statusCode:
          type: number
          enum:
          - 401
      required:
      - error
      - message
      - statusCode
    Invitation:
      type: object
      properties:
        id:
          description: Unique identifier for the invitation.
          type: integer
        email:
          description: Email for the invitation.
          type: string
        userType:
          type: string
          enum:
          - admin
          - editor
          - viewer_all
          - viewer_basic
          - timesheet_only
          - manager
          - contributor
          description: Permission level
        financialPermission:
          type: string
          enum:
          - all
          - no_salaries
          - restricted
          - none
          description: Financial permission level
        editProjectsPermission:
          type: string
          enum:
          - all
          - specific
          - restricted
          - none
          deprecated: true
          description: 'Edit projects permission level (deprecated: use manageProjectsPermission)'
        editOthersPermission:
          type: string
          enum:
          - all
          - none
          deprecated: true
          description: 'Edit others permission level (deprecated: use managePeoplePermission)'
        manageProjectsPermission:
          type: string
          enum:
          - all
          - specific
          - restricted
          - none
          description: Manage projects permission level
        managePeoplePermission:
          type: string
          enum:
          - all
          - restricted
          - none
          description: Manage people permission level
        manageAccountPermission:
          description: Manage account permission level
          type: boolean
        addAllPeopleToProjectsPermission:
          description: Add all people to projects permission level
          type: boolean
        viewPlannerPermission:
          description: View planner permission level
          type: boolean
        peopleTeams:
          description: Teams staged for this invitation; they become people-management grants when the invitation is accepted. Always returned; empty when none were requested.
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
            required:
            - id
        createdAt:
          type: string
          format: date-time
          description: Timestamp of when the object was created.
        sentAt:
          type: string
          format: date-time
          description: Date and time when the invitation was last sent
        expiresAt:
          type: string
          format: date-time
          description: Date and time when the invitation expires
      required:
      - id
      - email
      - userType
      - financialPermission
      - editProjectsPermission
      - editOthersPermission
      - manageProjectsPermission
      - managePeoplePermission
      - manageAccountPermission
      - addAllPeopleToProjectsPermission
      - viewPlannerPermission
      - peopleTeams
      - createdAt
      - sentAt
      - expiresAt
    BadRequest:
      type: object
      properties:
        error:
          type: string
          enum:
          - Bad Request
        message:
          type: string
        statusCode:
          type: number
          enum:
          - 400
      required:
      - error
      - message
      - statusCode
    NotFound:
      type: object
      properties:
        error:
          type: string
          enum:
          - Not Found
        message:
          type: string
        statusCode:
          type: number
          enum:
          - 404
      required:
      - error
      - message
      - statusCode
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
x-readme:
  proxy-enabled: false