> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.bienport.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get all subscription by status and organization id



## OpenAPI

````yaml /open-api/api-docs.yml post /subscription/list
openapi: 3.0.1
info:
  title: Bimetri Api Service API Reference
  description: Bimetri Api Service
  version: v1.4.0-SNAPSHOT
servers:
  - url: https://apigw.bienport.com/api
  - url: https://apigw.sebeketakip.com/api
security: []
tags:
  - name: CRM Ticket Api
    description: Crm Controller
  - name: Camera Api
    description: Camera Controller
  - name: Central Alarm Monitoring Api
    description: Central Alarm Monitoring Controller
  - name: Content Api
    description: Contents Controller
  - name: Controller Api
    description: Controllers Controller
  - name: Controller Log Api
    description: Digital Controller Data Log Controller
  - name: Customer Api
    description: Customer Controller
  - name: Enterprise Bulk Operations Api
    description: Enterprise Bulk Operations Controller
  - name: External Power And Battery Status Api
    description: External Power And Battery Status Controller
  - name: Lead Api
    description: Lead Controller
  - name: Login Api
    description: Auth Controller
  - name: Panel Controllers Api
    description: Resource Controllers Controller
  - name: Panel Sensors Api
    description: Resource Sensor Controller
  - name: Partition Api
    description: Partition Controller
  - name: Payment Api
    description: Payment Controller
  - name: Push Notification Api
    description: Push Notification Controller
  - name: Push Notification History Api
    description: Push Notification History Controller
  - name: Resource Activities Api
    description: Activity Service Controller
  - name: Resource Api
    description: Resource Management Controller
  - name: Resource User Authorization Api
    description: Resource User Authorization Controller
  - name: Role Api
    description: Organization Role Controller
  - name: Sms Verification Code Send Api
    description: Send Verification Code Controller
  - name: Subscription Api
    description: Subscription Controller
  - name: User Api
    description: User Controller
  - name: Validate Verification Code Api
    description: Sms Code Validation Controller
paths:
  /subscription/list:
    post:
      tags:
        - Subscription Api
      summary: Get all subscription by status and organization id
      operationId: listSubscriptionUsingPOST
      parameters:
        - name: Authorization
          in: header
          description: Access Token
          required: true
          schema:
            type: string
          example: Bearer access_token
        - name: OrganizationId
          in: header
          description: Organization ID
          required: true
          schema:
            type: string
          example: '148001'
      requestBody:
        description: subscriptionRequest
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionRequest'
        required: true
      responses:
        '200':
          description: List of Agreement returns.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Agreement'
        '201':
          description: Created
          content: {}
        '400':
          description: ApiErrorResponse model bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
        '401':
          description: ApiErrorResponse model unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
        '403':
          description: This response is not used.
          content: {}
        '404':
          description: ApiErrorResponse not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
        '500':
          description: ApiErrorResponse internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
      deprecated: false
components:
  schemas:
    SubscriptionRequest:
      title: SubscriptionRequest
      required:
        - organizationId
        - subscriptionStatus
      type: object
      properties:
        organizationId:
          type: integer
          description: Organization Id
          format: int64
          example: 12312
        subscriptionStatus:
          type: integer
          description: 'Subscription Status( 1 : active,0 : passive, 2 : all)'
          format: int32
          example: 1
          enum:
            - 0
            - 1
            - 2
      description: 'Request Model for Get all Subscription by status and organization id '
    Agreement:
      title: Agreement
      type: object
      properties:
        id:
          type: string
          example: '123532'
        type:
          type: string
        documentNumber:
          type: string
          example: ABN-30514
        name:
          type: string
          example: F.KA***
        status:
          type: string
          example: Active
          enum:
            - Passive
            - Active
        characteristic:
          type: array
          example:
            - name: CAMPAIGN
              valueType: String
              value: İLK 9 AY %50
            - name: MONTAGEADRESS
              valueType: String
              value: '***'
            - name: MONTAGECOUNTY
              valueType: String
              value: KONAK
            - name: MONTAGECITY
              valueType: String
              value: İZMİR
            - name: MONTAGE_DATE
              valueType: Date
              value: null
            - name: TOTAL_PAST_DUE_INSTALMENT
              valueType: Float
              value: '0.0'
            - name: PANELBRAND
              valueType: String
              value: null
            - name: PANELMODEL
              valueType: String
              value: null
            - name: PANELNO
              valueType: String
              value: null
            - name: RESOURCE_ID
              valueType: Long
              value: 23145
            - name: SALESEMP
              valueType: String
              value: '***'
            - name: STAGE
              valueType: String
              value: 1 - Kayıt
          items:
            $ref: '#/components/schemas/Characteristic'
        completionDate:
          $ref: '#/components/schemas/TimePeriod'
        engagedParty:
          type: array
          items:
            $ref: '#/components/schemas/RelatedParty'
      description: >-
        An agreement represents a contract or arrangement, either written or
        verbal and sometimes enforceable by law, such as a service level
        agreement or a customer price agreement. An agreement involves a number
        of other business entities, such as products, services, and resources
        and/or their specifications.
    ErrorResponseModel:
      title: ErrorResponseModel
      type: object
      properties:
        statusCode:
          type: integer
          description: Error Code
          format: int32
        error:
          type: string
          description: 'Unique name of the error '
          example: '***Exception'
        message:
          type: string
          description: 'Error message information '
          example: Message about the error
        path:
          type: string
          description: 'Path information where the error occurred '
          example: /api/example/path
      description: Error Response Model
    Characteristic:
      title: Characteristic
      type: object
      properties:
        name:
          type: string
          example: CAMPAIGN
        valueType:
          type: string
          description: Type of value
          example: String
        value:
          type: string
          example: 24 AY TAAHHÜTLÜ
    TimePeriod:
      title: TimePeriod
      type: object
      properties:
        endDateTime:
          type: string
          example: '2022-08-16T00:00:00.000Z'
        startDateTime:
          type: string
          example: '2021-08-16T00:00:00.000Z'
      description: >-
        A period of time, either as a deadline (endDateTime only) a
        startDateTime only, or both
    RelatedParty:
      title: RelatedParty
      required:
        - name
      type: object
      properties:
        id:
          type: string
          example: '456789'
        name:
          type: string
          description: Name of the related entity.
      description: >-
        Related Entity reference. A related party defines party or party role
        linked to a specific entity.

````