Openpath orgs/tasks API

The orgs/tasks API from Openpath — 5 operation(s) for orgs/tasks.

Operations 10

GET /orgs/{orgId}/tasks/reports List all report tasks #
POST /orgs/{orgId}/tasks/reports Create a new batch report task. #
GET /orgs/{orgId}/tasks/reports/schedules List all schedules for all the report tasks #
POST /orgs/{orgId}/tasks/reports/schedules Create a new scheduled report task. #
GET /orgs/{orgId}/tasks/reports/{id} Get a specific report task by id. #
DELETE /orgs/{orgId}/tasks/reports/{id} Delete a specific report task by id. #
GET /orgs/{orgId}/tasks/reports/schedules/{id} Get a specific task report schedule by id. #
DELETE /orgs/{orgId}/tasks/reports/schedules/{id} Delete a specific task report schedule by id. #
PATCH /orgs/{orgId}/tasks/reports/schedules/{id} Update a specific task report schedule #

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/openpath-orgs-tasks-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.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openpath-orgs-tasks-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Openpath API Documentation auth Orgs/tasks API
  version: 1.0.0
  description: Authentication and Login
servers:
- url: https://api.openpath.com
tags:
- name: orgs/tasks
paths:
  /orgs/{orgId}/tasks/reports:
    get:
      summary: List all report tasks
      operationId: listTasksReports
      description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-rptGeneral:w,o{params.orgId}-rptGeneral:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listTasksReports'
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: integer
      - name: limit
        in: query
        schema:
          type: integer
          maximum: 1000
          minimum: 1
      - name: offset
        in: query
        schema:
          type: integer
          default: 0
          minimum: 0
      - name: sort
        in: query
        schema:
          type: string
          pattern: ^[a-zA-Z0-9.]+(,\s*[a-zA-Z0-9.]+)*$
      - name: order
        in: query
        schema:
          type: string
          pattern: ^(asc|desc)+(,\s*(asc|desc)+)*$
      - name: q
        in: query
        schema:
          type: string
      - name: filter
        in: query
        schema:
          type: string
      - name: preFilter
        in: query
        schema:
          type: string
      tags:
      - orgs/tasks
      security:
      - jwt: []
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  totalCount:
                    type: integer
                  filteredCount:
                    type: integer
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        executionType:
                          type: string
                          default: immediate
                          enum:
                          - immediate
                          - scheduled
                        options:
                          type:
                          - string
                          - 'null'
                          x-alternatives:
                          - type:
                            - string
                            - 'null'
                          - type:
                            - string
                            - 'null'
                        expiresAfter:
                          type: string
                          format: date
                        type:
                          type: string
                          enum:
                          - activityLogsOrg
                          - alarmsOrg
                          - occupancyOrg
                          - auditLogsOrg
                        name:
                          type: string
                          minLength: 1
                          maxLength: 255
                        filter:
                          type:
                          - string
                          - 'null'
                        relativeTime:
                          type: string
                          enum:
                          - today
                          - thisWeek
                          - thisMonth
                          - thisQuarter
                          - thisYear
                          - yesterday
                          - lastFullWeek
                          - lastFullMonth
                          - lastFullQuarter
                          - last6FullMonths
                          - last12FullMonths
                          x-alternatives:
                          - type: string
                            enum:
                            - today
                            - thisWeek
                            - thisMonth
                            - thisQuarter
                            - thisYear
                            - yesterday
                            - lastFullWeek
                            - lastFullMonth
                            - lastFullQuarter
                            - last6FullMonths
                            - last12FullMonths
                          - type:
                            - string
                            - 'null'
                            enum:
                            - today
                            - thisWeek
                            - thisMonth
                            - thisQuarter
                            - thisYear
                            - lastHour
                            - last4Hours
                            - last12Hours
                            - last24Hours
                            - last7Days
                            - last30Days
                            - yesterday
                            - lastFullWeek
                            - lastFullMonth
                            - lastFullQuarter
                            - lastFullYear
                            - last6FullMonths
                            - last12FullMonths
                        customFieldIds:
                          type:
                          - array
                          - 'null'
                          x-constraint:
                            single: true
                          items:
                            type: integer
                        destinationEmails:
                          type:
                          - array
                          - 'null'
                          items:
                            type: string
                            x-format:
                              email: true
                        timeZone:
                          type:
                          - string
                          - 'null'
                          x-alternatives:
                          - type:
                            - string
                            - 'null'
                          - type: string
                            maxLength: 64
                        columns:
                          x-alternatives:
                          - type:
                            - array
                            - 'null'
                            minItems: 1
                            items:
                              type: string
                              enum:
                              - user
                              - userEmail
                              - userGroups
                              - customFieldIdx0
                              - customFieldIdx1
                              - customFieldIdx2
                              - customFieldIdx3
                              - customFieldIdx4
                              - customFieldIdx5
                              - customFieldIdx6
                              - customFieldIdx7
                              - customFieldIdx8
                              - customFieldIdx9
                              - customFieldIdx10
                              - customFieldIdx11
                              - customFieldIdx12
                              - customFieldIdx13
                              - customFieldIdx14
                              - customFieldIdx15
                              - customFieldIdx16
                              - customFieldIdx17
                              - customFieldIdx18
                              - customFieldIdx19
                          - x-alternatives:
                            - type:
                              - array
                              - 'null'
                              minItems: 1
                              items:
                                type: string
                                enum:
                                - time
                                - category
                                - subCategory
                                - result
                                - device
                                - deviceDetail
                                - deviceDetailName
                                - deviceTimezone
                                - deviceTime
                                - user
                                - userEmail
                                - userOrg
                                - userIdpName
                                - userExternalId
                                - initialCredentialTypeName
                                - initialCredentialDetail
                                - credentialTypeName
                                - credentialDetail
                                - target
                                - initialRequest
                                - request
                                - location
                                - entryName
                                - entryName2
                                - zoneName
                                - zoneName2
                                - siteName
                                - siteName2
                                - source
                                - deniedReason
                                - requestId
                                - customFieldIdx0
                                - customFieldIdx1
                                - customFieldIdx2
                                - customFieldIdx3
                                - customFieldIdx4
                                - customFieldIdx5
                                - customFieldIdx6
                                - customFieldIdx7
                                - customFieldIdx8
                                - customFieldIdx9
                                - customFieldIdx10
                                - customFieldIdx11
                                - customFieldIdx12
                                - customFieldIdx13
                                - customFieldIdx14
                                - customFieldIdx15
                                - customFieldIdx16
                                - customFieldIdx17
                                - customFieldIdx18
                                - customFieldIdx19
                            - x-alternatives:
                              - type:
                                - array
                                - 'null'
                                minItems: 1
                                items:
                                  type: string
                                  enum:
                                  - alarmId
                                  - alarmConfigName
                                  - time
                                  - eventName
                                  - siteName2
                                  - zoneName2
                                  - entryName2
                                  - alarmActionName
                                  - userName
                                  - assignee
                                  - alarmStatusName
                                  - acuName
                                  - readerName
                                  - note
                                  - customFieldIdx0
                                  - customFieldIdx1
                                  - customFieldIdx2
                                  - customFieldIdx3
                                  - customFieldIdx4
                                  - customFieldIdx5
                                  - customFieldIdx6
                                  - customFieldIdx7
                                  - customFieldIdx8
                                  - customFieldIdx9
                                  - customFieldIdx10
                                  - customFieldIdx11
                                  - customFieldIdx12
                                  - customFieldIdx13
                                  - customFieldIdx14
                                  - customFieldIdx15
                                  - customFieldIdx16
                                  - customFieldIdx17
                                  - customFieldIdx18
                                  - customFieldIdx19
                              - x-alternatives:
                                - type:
                                  - array
                                  - 'null'
                                  minItems: 1
                                  items:
                                    type: string
                                    enum:
                                    - details
                                    - time
                                    - ipAddress
                                    - url
                                    - status
                                    - userName
                                    - action
                                    - description
                                    - customFieldIdx0
                                    - customFieldIdx1
                                    - customFieldIdx2
                                    - customFieldIdx3
                                    - customFieldIdx4
                                    - customFieldIdx5
                                    - customFieldIdx6
                                    - customFieldIdx7
                                    - customFieldIdx8
                                    - customFieldIdx9
                                    - customFieldIdx10
                                    - customFieldIdx11
                                    - customFieldIdx12
                                    - customFieldIdx13
                                    - customFieldIdx14
                                    - customFieldIdx15
                                    - customFieldIdx16
                                    - customFieldIdx17
                                    - customFieldIdx18
                                    - customFieldIdx19
                                - type:
                                  - array
                                  - 'null'
                                  minItems: 1
                                  items:
                                    type: string
                                type:
                                - array
                                - 'null'
                                minItems: 1
                                items:
                                  type: string
                                  enum:
                                  - details
                                  - time
                                  - ipAddress
                                  - url
                                  - status
                                  - userName
                                  - action
                                  - description
                                  - customFieldIdx0
                                  - customFieldIdx1
                                  - customFieldIdx2
                                  - customFieldIdx3
                                  - customFieldIdx4
                                  - customFieldIdx5
                                  - customFieldIdx6
                                  - customFieldIdx7
                                  - customFieldIdx8
                                  - customFieldIdx9
                                  - customFieldIdx10
                                  - customFieldIdx11
                                  - customFieldIdx12
                                  - customFieldIdx13
                                  - customFieldIdx14
                                  - customFieldIdx15
                                  - customFieldIdx16
                                  - customFieldIdx17
                                  - customFieldIdx18
                                  - customFieldIdx19
                              type:
                              - array
                              - 'null'
                              minItems: 1
                              items:
                                type: string
                                enum:
                                - alarmId
                                - alarmConfigName
                                - time
                                - eventName
                                - siteName2
                                - zoneName2
                                - entryName2
                                - alarmActionName
                                - userName
                                - assignee
                                - alarmStatusName
                                - acuName
                                - readerName
                                - note
                                - customFieldIdx0
                                - customFieldIdx1
                                - customFieldIdx2
                                - customFieldIdx3
                                - customFieldIdx4
                                - customFieldIdx5
                                - customFieldIdx6
                                - customFieldIdx7
                                - customFieldIdx8
                                - customFieldIdx9
                                - customFieldIdx10
                                - customFieldIdx11
                                - customFieldIdx12
                                - customFieldIdx13
                                - customFieldIdx14
                                - customFieldIdx15
                                - customFieldIdx16
                                - customFieldIdx17
                                - customFieldIdx18
                                - customFieldIdx19
                            type:
                            - array
                            - 'null'
                            minItems: 1
                            items:
                              type: string
                              enum:
                              - time
                              - category
                              - subCategory
                              - result
                              - device
                              - deviceDetail
                              - deviceDetailName
                              - deviceTimezone
                              - deviceTime
                              - user
                              - userEmail
                              - userOrg
                              - userIdpName
                              - userExternalId
                              - initialCredentialTypeName
                              - initialCredentialDetail
                              - credentialTypeName
                              - credentialDetail
                              - target
                              - initialRequest
                              - request
                              - location
                              - entryName
                              - entryName2
                              - zoneName
                              - zoneName2
                              - siteName
                              - siteName2
                              - source
                              - deniedReason
                              - requestId
                              - customFieldIdx0
                              - customFieldIdx1
                              - customFieldIdx2
                              - customFieldIdx3
                              - customFieldIdx4
                              - customFieldIdx5
                              - customFieldIdx6
                              - customFieldIdx7
                              - customFieldIdx8
                              - customFieldIdx9
                              - customFieldIdx10
                              - customFieldIdx11
                              - customFieldIdx12
                              - customFieldIdx13
                              - customFieldIdx14
                              - customFieldIdx15
                              - customFieldIdx16
                              - customFieldIdx17
                              - customFieldIdx18
                              - customFieldIdx19
                          type:
                          - array
                          - 'null'
                          minItems: 1
                          items:
                            type: string
                            enum:
                            - user
                            - userEmail
                            - userGroups
                            - customFieldIdx0
                            - customFieldIdx1
                            - customFieldIdx2
                            - customFieldIdx3
                            - customFieldIdx4
                            - customFieldIdx5
                            - customFieldIdx6
                            - customFieldIdx7
                            - customFieldIdx8
                            - customFieldIdx9
                            - customFieldIdx10
                            - customFieldIdx11
                            - customFieldIdx12
                            - customFieldIdx13
                            - customFieldIdx14
                            - customFieldIdx15
                            - customFieldIdx16
                            - customFieldIdx17
                            - customFieldIdx18
                            - customFieldIdx19
                        id:
                          type: integer
                        org:
                          type: object
                          properties:
                            id:
                              type: integer
                            name:
                              type: string
                          required:
                          - id
                          - name
                        identity:
                          type: object
                          properties:
                            id:
                              type: number
                            opal:
                              type: string
                            roles:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: number
                                  name:
                                    type: string
                                  description:
                                    type: string
                                  isMfaRequired:
                                    type: boolean
                                required:
                                - id
                            mfaCredentials:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: number
                                  createdAt:
                                    type: string
                                    format: date
                                  updatedAt:
                                    type: string
                                    format: date
                                  name:
                                    type: string
                                  status:
                                    type: string
                                  mfaCredentialType:
                                    type: object
                                    properties:
                                      id:
                                        type: number
                                      name:
                                        type: string
                                      modelName:
                                        type: string
                                    required:
                                    - id
                                  totpSoftDevice:
                                    type: object
                                    properties:
                                      id:
                                        type: number
                                    required:
                                    - id
                                required:
                                - id
                            firstName:
                              type:
                              - string
                              - 'null'
                            middleName:
                              type:
                              - string
                              - 'null'
                            lastName:
                              type:
                              - string
                              - 'null'
                            fullName:
                              type:
                              - string
                              - 'null'
                            initials:
                              type:
                              - string
                              - 'null'
                            isEmailVerified:
                              type: boolean
                            namespace:
                              type: object
                              properties:
                                id:
                                  type: integer
                                nickname:
                                  type:
                                  - string
                                  - 'null'
                                namespaceType:
                                  type: object
                                  properties:
                                    id:
                                      type: number
                                    name:
                                      type: string
                                    modelName:
                                      type:
                                      - string
                                      - 'null'
                                  required:
                                  - id
                                org:
                                  type: object
                                  properties:
                                    id:
                                      type: number
                                    name:
                                      type: string
                                  required:
                                  - id
                                identityProvider:
                                  type: object
                                  properties:
                                    id:
                                      type: number
                                    isSsoEnabled:
                                      type: boolean
                                    isSyncMobilePhoneEnabled:
                                      type: boolean
                                    isRemoveGroupsEnabled:
                                      type: boolean
                                    identityProviderSyncTypeId:
                                      type:
                                      - integer
                                      - 'null'
                                    credentials:
                                      type:
                                      - string
                                      - 'null'
                                    identityProviderType:
                                      type: object
                                      properties:
                                        id:
                                          type: number
                                        name:
                                          type: string
                                      required:
                                      - id
                                    org:
                                      type: object
                                      properties:
                                        id:
                                          type: number
                                        name:
                                          type: string
                                      required:
                                      - id
                                  required:
                                  - id
                                propertyManagementSystem:
                                  type: object
                                  properties:
                                    id:
                                      type: number
                                    orgId:
                                      type: number
                                    propertyManagementSystemTypeId:
                                      type: number
                                    propertyManagementSystemType:
                                      type: object
                                      properties:
                                        id:
                                          type: number
                                        name:
                                          type: string
                                      required:
                                      - id
                                  required:
                                  - id
                                  - orgId
                                  - propertyManagementSystemTypeId
                              required:
                              - id
                            idpUniqueIdentifier:
                              type: string
                            pmsUniqueIdentifier:
                              type:
                              - string
                              - 'null'
                            needsPasswordChange:
                              type: boolean
                              default: false
                            nicknames:
                              type:
                              - array
                              - 'null'
                              items:
                                type: object
                                properties:
                                  nickname:
                                    type: string
                                    minLength: 1
                                    maxLength: 100
                            email:
                              type: string
                            mobilePhone:
                              type:
                              - string
                              - 'null'
                            language:
                              type:
                              - string
                              - 'null'
                            createdAt:
                              type: string
                              format: date
                            updatedAt:
                              type: string
                              format: date
                            users:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: number
                                  opal:
                                    type: string
                                  status:
                                    type: string
                                  startDate:
                                    type:
                                    - string
                                    - 'null'
                                    format: date
                                  endDate:
                                    type:
                                    - string
                                    - 'null'
                                    forma

# --- truncated at 32 KB (304 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openpath/refs/heads/main/openapi/openpath-orgs-tasks-api-openapi.yml