Alleva

Alleva Organizations API

The Organizations API from Alleva — 6 operation(s) for organizations.

GitHub OpenAPI

Documentation

📖
Documentation
https://api.helloalleva.com/swagger/index.html
📖
APIReference
https://api.helloalleva.com/swagger/index.html

Specifications

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

Other Resources

🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/alleva/refs/heads/main/mcp/alleva-tool-crosswalk.yml

OpenAPI Specification

alleva-organizations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Alleva Rest Organizations API
  version: '1.0'
security:
- Bearer: []
tags:
- name: Organizations
paths:
  /organizations/guid/{guid}:
    get:
      tags:
      - Organizations
      parameters:
      - name: guid
        in: path
        required: true
        schema:
          type: string
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain; ver=1.0:
              schema:
                $ref: '#/components/schemas/Organization'
            application/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/Organization'
            text/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/Organization'
  /v{version}/organizations/guid/{guid}:
    get:
      tags:
      - Organizations
      parameters:
      - name: guid
        in: path
        required: true
        schema:
          type: string
      - name: version
        in: path
        required: true
        schema:
          type: string
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain; ver=1.0:
              schema:
                $ref: '#/components/schemas/Organization'
            application/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/Organization'
            text/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/Organization'
  /organizations:
    get:
      tags:
      - Organizations
      parameters:
      - name: Limit
        in: query
        schema:
          type: integer
          format: int64
      - name: Cursor
        in: query
        schema:
          type: integer
          format: int32
      - name: StartDate
        in: query
        schema:
          type: string
          format: date-time
      - name: EndDate
        in: query
        schema:
          type: string
          format: date-time
      - name: fields
        in: query
        schema:
          type: array
          items:
            type: string
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain; ver=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Organization'
            application/json; ver=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Organization'
            text/json; ver=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Organization'
  /v{version}/organizations:
    get:
      tags:
      - Organizations
      parameters:
      - name: Limit
        in: query
        schema:
          type: integer
          format: int64
      - name: Cursor
        in: query
        schema:
          type: integer
          format: int32
      - name: StartDate
        in: query
        schema:
          type: string
          format: date-time
      - name: EndDate
        in: query
        schema:
          type: string
          format: date-time
      - name: fields
        in: query
        schema:
          type: array
          items:
            type: string
      - name: version
        in: path
        required: true
        schema:
          type: string
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain; ver=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Organization'
            application/json; ver=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Organization'
            text/json; ver=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Organization'
  /organizations/{id}:
    get:
      tags:
      - Organizations
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain; ver=1.0:
              schema:
                $ref: '#/components/schemas/Organization'
            application/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/Organization'
            text/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/Organization'
  /v{version}/organizations/{id}:
    get:
      tags:
      - Organizations
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: version
        in: path
        required: true
        schema:
          type: string
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain; ver=1.0:
              schema:
                $ref: '#/components/schemas/Organization'
            application/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/Organization'
            text/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/Organization'
components:
  schemas:
    Organization:
      type: object
      properties:
        id:
          type: integer
          format: int32
        href:
          type:
          - string
          - 'null'
          readOnly: true
        billingDomain:
          type:
          - string
          - 'null'
        organizationUuid:
          type: string
          format: uuid
        organizationName:
          type:
          - string
          - 'null'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: "JWT Authorization header using the Bearer scheme. \n\n Enter Bearer [space] and then\
        \ your token in the text input below.\n\nExample: Bearer 12345abcdef"
      name: Authorization
      in: header
servers:
- url: https://api.helloalleva.com
  description: Base URL reconciled from apis.yml