evictionsapi-com Integrations API

openapi: 3.2.0
info:
  title: Evictionsapi Com Integrations API
  version: 0.0.0
  contact:
    email: hello@evictionsapi.com
  description: 'Operations tagged Integrations across 3 of this provider''s published API definitions: api.evictionsapi.com.json, evictionsapi-com-api-evictions-openapi.json, evictionsapi-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.evictionsapi.com
tags:
- name: Integrations
paths:
  /v1/integrations:
    get:
      summary: List the organization's stored property-management connections (Buildium…
      security:
      - SessionToken: []
      responses:
        '200':
          description: The connections.
          content:
            application/json:
              schema:
                type: object
                required:
                - items
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PmsConnection'
        '400':
          description: The request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The credential is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: '`forbidden`: an API key (these routes take a signed-in session only), or, to connect or disconnect, a member who is not an owner.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: 'The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: '`live_only`: a session in test mode.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Integrations
      operationId: getV1Integrations
      x-operation-id-source: derived
    servers:
    - url: https://api.evictionsapi.com
  /v1/integrations/{system}/connect:
    post:
      summary: 'Connect Buildium (`credentials: { clientId, clientSecret }`) or DoorLoop…'
      security:
      - SessionToken: []
      parameters:
      - name: system
        in: path
        required: true
        schema:
          type: string
          enum:
          - buildium
          - doorloop
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                label:
                  type: string
                  minLength: 1
                  maxLength: 100
                  pattern: ^[^\u0000-\u001f\u007f]*$
                credentials:
                  anyOf:
                  - type: object
                    properties:
                      clientId:
                        type: string
                        minLength: 1
                        maxLength: 200
                        pattern: ^[\x21-\x7e]+$
                      clientSecret:
                        type: string
                        minLength: 1
                        maxLength: 500
                        pattern: ^[\x21-\x7e]+$
                    required:
                    - clientId
                    - clientSecret
                    additionalProperties: false
                  - type: object
                    properties:
                      token:
                        type: string
                        minLength: 1
                        maxLength: 4000
                        pattern: ^[\x21-\x7e]+$
                    required:
                    - token
                    additionalProperties: false
              required:
              - credentials
              additionalProperties: false
      responses:
        '201':
          description: The stored connection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PmsConnection'
        '400':
          description: The request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The credential is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: '`forbidden`: an API key (these routes take a signed-in session only), or, to connect or disconnect, a member who is not an owner.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: 'The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: '`invalid_credentials`: the system refused the key; nothing is stored. `live_only`: a session in test mode.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: '`rate_limited`: at most 60 connects and searches an hour per organization, counted together. `Retry-After` gives the seconds to wait.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: '`pms_unavailable`: the system did not answer as expected; nothing is stored.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: '`pms_busy`: the system asked us to wait; nothing is stored.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Integrations
      operationId: postV1IntegrationsBySystemConnect
      x-operation-id-source: derived
    servers:
    - url: https://api.evictionsapi.com
  /v1/integrations/{system}:
    delete:
      summary: 'Disconnect a property-management system: its stored key is deleted.'
      security:
      - SessionToken: []
      parameters:
      - name: system
        in: path
        required: true
        schema:
          type: string
          enum:
          - buildium
          - doorloop
      responses:
        '204':
          description: The connection is deleted.
        '400':
          description: The request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The credential is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: '`forbidden`: an API key (these routes take a signed-in session only), or, to connect or disconnect, a member who is not an owner.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: '`not_connected`: there is no connection to delete.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: 'The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: '`live_only`: a session in test mode.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Integrations
      operationId: deleteV1IntegrationsBySystem
      x-operation-id-source: derived
    servers:
    - url: https://api.evictionsapi.com
  /v1/integrations/{system}/leases:
    post:
      summary: 'Search the connected system''s leases: by tenant name in Buildium, by lease name…'
      security:
      - SessionToken: []
      parameters:
      - name: system
        in: path
        required: true
        schema:
          type: string
          enum:
          - buildium
          - doorloop
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                search:
                  type: string
                  minLength: 2
                  maxLength: 100
              required:
              - search
              additionalProperties: false
      responses:
        '200':
          description: The leases found.
          content:
            application/json:
              schema:
                type: object
                required:
                - items
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/LeaseMatch'
        '400':
          description: The request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The credential is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: '`forbidden`: an API key (these routes take a signed-in session only), or, to connect or disconnect, a member who is not an owner.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: '`not_connected`: the organization has not connected this system. `lease_not_found` (pull): the system has no such lease for the stored key.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: 'The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: '`live_only`: a session in test mode.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: '`rate_limited`: at most 60 connects and searches an hour per organization, counted together. `Retry-After` gives the seconds to wait.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: '`pms_refused`: the system refused the stored key (connect it again); `pms_unavailable`: the system did not answer as expected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: '`pms_busy`: the system asked us to wait.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Integrations
      operationId: postV1IntegrationsBySystemLeases
      x-operation-id-source: derived
    servers:
    - url: https://api.evictionsapi.com
  /v1/integrations/{system}/pull:
    post:
      summary: Read one lease from the connected system as suggested answers for a new case…
      security:
      - SessionToken: []
      parameters:
      - name: system
        in: path
        required: true
        schema:
          type: string
          enum:
          - buildium
          - doorloop
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                leaseId:
                  type: string
                  pattern: ^[A-Za-z0-9]{1,40}$
              required:
              - leaseId
              additionalProperties: false
      responses:
        '200':
          description: The lease's suggested answers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PmsPull'
        '400':
          description: The request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The credential is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: '`forbidden`: an API key (these routes take a signed-in session only), or, to connect or disconnect, a member who is not an owner.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: '`not_connected`: the organization has not connected this system. `lease_not_found` (pull): the system has no such lease for the stored key.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: 'The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: '`live_only`: a session in test mode.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: '`rate_limited`: at most 10 pulls an hour per organization. `Retry-After` gives the seconds to wait.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: '`pms_refused`: the system refused the stored key (connect it again); `pms_unavailable`: the system did not answer as expected.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: '`pms_busy`: the system asked us to wait.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '504':
          description: '`pms_timeout`: the system took more than 40 seconds over the whole pull. It does not count against the hourly limit.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Integrations
      operationId: postV1IntegrationsBySystemPull
      x-operation-id-source: derived
    servers:
    - url: https://api.evictionsapi.com
components:
  schemas:
    PmsPull:
      type: object
      description: 'One lease read from the property-management system as suggested answers for a new case (each `{ value, source }`, the source being the system), the lease PDF when the system holds one, and the system''s balance to check the ledger rows against. Nothing of it is stored: the person checks every answer.'
      required:
      - suggestions
      properties:
        suggestions:
          type: object
          additionalProperties:
            type: object
            required:
            - value
            - source
            properties:
              value: {}
              source:
                enum:
                - buildium
                - doorloop
        leaseFile:
          type: object
          required:
          - filename
          - contentBase64
          - contentType
          properties:
            filename:
              type: string
            contentBase64:
              type: string
              contentEncoding: base64
            contentType:
              const: application/pdf
        balanceCents:
          type: integer
        skippedRows:
          type: integer
          description: How many ledger rows were left out because their transaction type is not one we map. Absent when none.
    LeaseMatch:
      type: object
      description: A lease a search found, as the property-management system holds it. Empty strings where it has nothing to show.
      required:
      - id
      - tenants
      - unit
      - address
      properties:
        id:
          type: string
          description: The system's lease id, for `pull`.
        name:
          type: string
          description: The system's own name for the lease (DoorLoop).
        tenants:
          type: array
          items:
            type: string
        unit:
          type: string
        address:
          type: string
        start:
          type: string
          format: date
        end:
          type: string
          format: date
        balanceCents:
          type: integer
          description: What the system says the tenant owes.
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          - details
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
    PmsConnection:
      type: object
      description: The organization's stored connection to a property-management system. Its credentials are kept encrypted and never returned.
      required:
      - system
      - label
      - createdAt
      - lastUsedAt
      - lastError
      properties:
        system:
          enum:
          - buildium
          - doorloop
        label:
          type: string
          description: The name the organization gave it; the system's name by default.
        createdAt:
          type: string
          format: date-time
        lastUsedAt:
          type:
          - string
          - 'null'
          format: date-time
        lastError:
          type:
          - string
          - 'null'
          description: How the last search or pull failed (`unauthorized`, `rate_limited`, `unavailable`); null when it worked.
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      description: An organization API key (`eak_test_...` or `eak_live_...`).
    SessionToken:
      type: http
      scheme: bearer
      description: 'A session token (`ess_...`) from `POST /v1/auth/signup` or `/v1/auth/login`, valid for 30 days. On the case, webhook, API key and organization routes it acts for the organization the session is in (`POST /v1/me/organization` switches it) in the mode named by the `X-Evictions-Mode` header: `test` (the default) or `live`.'
    AttorneyToken:
      type: http
      scheme: bearer
      description: A user token (`eut_...`) of a verified attorney.
externalDocs:
  url: https://evictionsapi.com/docs
x-refined-from:
- api.evictionsapi.com.json
- evictionsapi-com-api-evictions-openapi.json
- evictionsapi-com-openapi.json