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/adro1b33:adro1b33-notifications-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: aox-django-backend Notifications API
  version: 1.0.0
tags:
- name: Notifications
paths:
  /notifications/:
    get:
      operationId: notifications_retrieve
      parameters:
      - in: query
        name: category
        schema:
          type: string
      - in: query
        name: cursor
        schema:
          type: string
      - in: query
        name: page_size
        schema:
          type: integer
      - in: query
        name: type
        schema:
          type: string
      - in: query
        name: unread
        schema:
          type: boolean
      tags:
      - Notifications
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationPage'
          description: ''
      summary: Notifications retrieve
      x-summary-source: derived
  /notifications/read/:
    post:
      operationId: notifications_read_create
      tags:
      - Notifications
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationRead'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/NotificationRead'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/NotificationRead'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationSummary'
          description: ''
      summary: Notifications read create
      x-summary-source: derived
  /notifications/read-all/:
    post:
      operationId: notifications_read_all_create
      tags:
      - Notifications
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationReadAll'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/NotificationReadAll'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/NotificationReadAll'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationSummary'
          description: ''
      summary: Notifications read all create
      x-summary-source: derived
  /notifications/summary/:
    get:
      operationId: notifications_summary_retrieve
      tags:
      - Notifications
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationSummary'
          description: ''
      summary: Notifications summary retrieve
      x-summary-source: derived
components:
  schemas:
    NotificationSummary:
      type: object
      properties:
        unreadCount:
          type: integer
          minimum: 0
        unreadByCategory:
          type: object
          additionalProperties:
            type: integer
            minimum: 0
        serverTime:
          type: string
          format: date-time
      required:
      - serverTime
      - unreadByCategory
      - unreadCount
    NotificationRead:
      type: object
      properties:
        notificationIds:
          type: array
          items:
            type: string
            format: uuid
          maxItems: 100
      required:
      - notificationIds
    NotificationReadAll:
      type: object
      properties:
        readBefore:
          type: string
          format: date-time
        category:
          enum:
          - job
          - collaboration
          - team
          - billing
          - asset
          - system
          - null
          type:
          - string
          - 'null'
          description: '* `job` - Job

            * `collaboration` - Collaboration

            * `team` - Team

            * `billing` - Billing

            * `asset` - Asset

            * `system` - System'
          x-spec-enum-id: 875314d5dd0b91d7
      required:
      - readBefore
    NotificationActor:
      type: object
      properties:
        userId:
          type:
          - integer
          - 'null'
        displayName:
          type:
          - string
          - 'null'
        state:
          enum:
          - active_team_member
          - former_team_member
          - account_user
          - deleted
          type: string
          description: '* `active_team_member` - active_team_member

            * `former_team_member` - former_team_member

            * `account_user` - account_user

            * `deleted` - deleted'
          x-spec-enum-id: af07836788a62409
      required:
      - displayName
      - state
      - userId
    NotificationPage:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/Notification'
        nextCursor:
          type:
          - string
          - 'null'
        serverTime:
          type: string
          format: date-time
      required:
      - nextCursor
      - results
      - serverTime
    Notification:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        type:
          type: string
          maxLength: 64
        category:
          enum:
          - job
          - collaboration
          - team
          - billing
          - asset
          - system
          type: string
          description: '* `job` - Job

            * `collaboration` - Collaboration

            * `team` - Team

            * `billing` - Billing

            * `asset` - Asset

            * `system` - System'
          x-spec-enum-id: 875314d5dd0b91d7
        schemaVersion:
          type: integer
          maximum: 32767
          minimum: 0
        scope:
          enum:
          - account
          - team
          type: string
          description: '* `account` - Account

            * `team` - Team'
          x-spec-enum-id: 12d453b2fe67e4e8
        teamId:
          type:
          - integer
          - 'null'
          readOnly: true
        actorUserId:
          type:
          - integer
          - 'null'
          readOnly: true
        actor:
          allOf:
          - $ref: '#/components/schemas/NotificationActor'
          readOnly: true
        payload: {}
        target: {}
        occurredAt:
          type: string
          format: date-time
        lastTriggeredAt:
          type: string
          format: date-time
        readAt:
          type:
          - string
          - 'null'
          format: date-time
      required:
      - actor
      - actorUserId
      - category
      - id
      - scope
      - teamId
      - type
  securitySchemes:
    agentBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-provenance:
  method: harvested
  publisher: ADRO
  source: https://api.aoxlabs.com/schema/
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)