AccuLynx Reports API

openapi: 3.2.0
info:
  version: 2.2614.0
  title: AccuLynx API V2 Reports API
  description: 'If you are experiencing issues integrating with this API, please work with your web developer to review your programming before reaching out to us with an issue as we do not provide web development consulting services.


    API keys are for our customers only. If you are a business that is looking to integrate with AccuLynx, either on behalf of our customers or on your own, please click here to request access. Failure to do so can result in suspension of the AccuLynx account.


    The AccuLynx API provides customers programmatic access to their data within AccuLynx.


    The base url for these endpoints: is https://api.acculynx.com/api/v2


    Using SwaggerHub, you have the ability to test against a virtual server or you can test against the API itself. The virtual server is a mock server that allows you to test your calls without affecting your production data. Testing against the virtual server will always respond with a fixed response regardless of your inputs. It is provided to give you a production model of the information returned.


    Testing against the API requires an API Key and will affect your real production data. Get your API key from your AccuLynx API page. From the Servers list box below, select the api.acculynx.com site. When you click on green Authorize button next to the Servers list box, you will be prompted for a Bearer token. Enter your API Key and click Authorize again.


    To make it easier to connect AccuLynx to other applications you use, we have made our Zapier integration publicly available. Instead of contacting us to help you enable the use of Zapier to integrate additional applications with AccuLynx, you can now get started by going to the Zapier website (https://zapier.com) and searching for the AccuLynx application. Zaps are automated tasks that you run over and over again between AccuLynx and other online applications. We have an action that allows you to pair with a trigger to create leads in AccuLynx and a trigger as well as other actions and triggers coming in the near future! To get started search for AccuLynx on the Zapier website!


    If you don’t already have a Zapier account, create one or log into your https://zapier.com/account.


    AccuLynx Action ZAP basic documentation: https://support.acculynx.com/hc/en-us/articles/360034839751-Creating-a-Zap-with-Zapier'
  termsOfService: https://my.acculynx.com/signin/TermsView
  contact:
    email: api@acculynx.com
    url: https://api.acculynx.com/
  license:
    name: Proprietary
    url: https://my.acculynx.com/signin/TermsView
servers:
- description: AccuLynx Production Base Url
  url: https://api.acculynx.com/api/v2
security:
- bearerAuth: []
tags:
- name: Reports
  description: Manage scheduled report instances and their recipients.
paths:
  /reports/scheduled-reports/{scheduledReportId}/runs:
    get:
      summary: Get Report Schedule Runs
      description: Use this endpoint to get a list of instances for a scheduled report by it's unique identifier. If the scheduled report requested is not available the response will be a Not Found error. If the scheduled report requested hasn'run yet the response will be an Empty response.
      operationId: getReportsByInstanceInstanceRunsByScheduleId
      parameters:
      - $ref: '#/components/parameters/scheduledReportIdPath'
      - $ref: '#/components/parameters/pageSizeQuery'
      - $ref: '#/components/parameters/pageNumberQuery'
      responses:
        '200':
          description: 'OK

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/reportInstanceCollection'
        '204':
          description: 'No Content

            '
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '404':
          $ref: '#/components/responses/404NotFound'
        '416':
          $ref: '#/components/responses/416RangeNotSatisfiable'
      tags:
      - Reports
  /reports/scheduled-reports/{scheduledReportId}/runs/latest:
    get:
      summary: Get Latest Report Instance
      description: Use this endpoint to get a scheduled report latest instance. If the scheduled report requested is not available the response will be a Not Found error. If the scheduled report requested hasn't run yet, the response will be an Empty response.
      operationId: getReportLatestInstance
      parameters:
      - $ref: '#/components/parameters/scheduledReportIdPath'
      responses:
        '200':
          description: 'OK

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/reportInstance'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '404':
          $ref: '#/components/responses/404NotFound'
      tags:
      - Reports
  /reports/scheduled-reports/{scheduledReportId}/runs/{instanceRunId}:
    get:
      summary: Get Report Instance by ID
      description: Use this endpoint to get a scheduled report instance by it's instance run unique identifier. If the scheduled report requested is not available the response will be a not found error. If the instance of the scheduled report doesn't exists, the response will be a Not Found error
      operationId: getReportByInstanceId
      parameters:
      - $ref: '#/components/parameters/scheduledReportIdPath'
      - $ref: '#/components/parameters/instanceRunIdPath'
      responses:
        '200':
          description: 'OK

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/reportInstance'
        '204':
          description: 'No Content

            '
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '404':
          $ref: '#/components/responses/404NotFound'
      tags:
      - Reports
  /reports/scheduled-reports/{scheduledReportId}/runs/{instanceRunId}/recipients:
    get:
      summary: Get Report Instance Recipients
      description: Use this endpoint to get a list of recipients for a specific instance of a given scheduled report by it's unique identifier. If the scheduled report requested is not available the response will be a Not Found error. The instance of the report should be a valid instance of the scheduled report. If the scheduled report doesn't have any recipient the response will be an Empty response.
      operationId: getReportsRecipientsByInstanceId
      parameters:
      - $ref: '#/components/parameters/scheduledReportIdPath'
      - $ref: '#/components/parameters/instanceRunIdPath'
      - $ref: '#/components/parameters/pageSizeQuery'
      - $ref: '#/components/parameters/pageNumberQuery'
      responses:
        '200':
          description: 'OK

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/reportInstanceRecipientCollection'
        '204':
          description: 'No Content

            '
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '404':
          $ref: '#/components/responses/404NotFound'
        '416':
          $ref: '#/components/responses/416RangeNotSatisfiable'
      tags:
      - Reports
  /reports/scheduled-reports/{scheduledReportId}/runs/{instanceRunId}/recipients/{recipientId}:
    get:
      summary: Get Report Instance Recipient by ID
      description: Use this endpoint to get a scheduled report recipient data of a given instance by it's recipient unique identifier. If the scheduled report requested is not available the response will be a not found error. If the instance of the scheduled report doesn't exists, the response will be a Not Found error If the recipient of the scheduled report doesn't exists, the response will be a Not Found error
      operationId: getReportInstaceRecipientById
      parameters:
      - $ref: '#/components/parameters/scheduledReportIdPath'
      - $ref: '#/components/parameters/instanceRunIdPath'
      - $ref: '#/components/parameters/recipientIdPath'
      responses:
        '200':
          description: 'OK

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/reportInstanceRecipient'
        '204':
          description: 'No Content

            '
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '404':
          $ref: '#/components/responses/404NotFound'
      tags:
      - Reports
components:
  schemas:
    reportInstanceCollection:
      allOf:
      - $ref: '#/components/schemas/baseCollection'
      - type: object
        properties:
          items:
            type: array
            items:
              $ref: '#/components/schemas/reportInstance'
    error:
      type: object
      properties:
        type:
          type: string
          description: The URI of an explanation of the error
          example: https://tools.ietf.org/html/rfc7235#section-3.1
        title:
          type: string
          description: Error description
          example: This error happened.
        status:
          type: number
          description: HTTP status code
          example: 400
        detail:
          type: string
          description: Any details available for this error
          example: More info about this error.
        traceId:
          type: string
          description: An identifier that may be useful to AccuLynx support
          example: '|40f2a8f1-4db865dd47a69226.'
      required:
      - type
      - title
      - status
    reportRecipientFile:
      type: object
      properties:
        fileId:
          description: The unique identifier of the file of a recipient of a given report instance.
          type: string
          format: uuid
          example: bd110e4f-1b06-464c-b9cb-901d80ddc137
        fileUrl:
          description: The unique URI of the file of a recipient of a given report instance.
          type: string
          format: uri
          example: https://assets.acculynx.com/scheduledReports/reports/d8afe5c0-b2ad-46f5-b9a1-0c6e966632c9/reports/db672560-00f0-405d-af6e-8d0aa17a94df.csv
    reportInstanceRecipientCollection:
      allOf:
      - $ref: '#/components/schemas/baseCollection'
      - type: object
        properties:
          items:
            type: array
            items:
              $ref: '#/components/schemas/reportInstanceRecipient'
    reportInstanceRecipient:
      type: object
      properties:
        recipientId:
          description: The unique identifier of the report's instance recipient.
          type: string
          example: 5fafa5a5-74ad-4c31-8b33-005e16841d87
        reportId:
          description: The unique identifier of the report instance.
          type: string
          example: db672560-00f0-405d-af6e-8d0aa17a94df
        runInstanceId:
          description: The unique identifier of Report Recipient Instance.
          type: string
          format: uuid
          example: be6f252d-5aa6-49e3-a2e2-470a67f88711
        date:
          description: The generation of the report date and time in ISO 8601. https://en.wikipedia.org/wiki/ISO_8601
          type: string
          format: date-time
          example: '2022-06-22T19:47:10Z'
        files:
          type: array
          items:
            $ref: '#/components/schemas/reportRecipientFile'
    baseCollection:
      type: object
      properties:
        count:
          type: integer
          description: The total number of items matching the current query.
        pageSize:
          type: integer
          description: The requested or default page size.
        pageStartIndex:
          type: integer
          description: The requested or default index of the first element to return.
    reportInstance:
      type: object
      properties:
        reportId:
          description: The unique identifier of the report instance.
          type: string
          example: db672560-00f0-405d-af6e-8d0aa17a94df
        date:
          description: The generation of the report date and time in ISO 8601. https://en.wikipedia.org/wiki/ISO_8601
          type: string
          format: date-time
          example: '2022-06-22T19:47:10Z'
        runInstanceId:
          description: The unique identifier of Report Recipient Instance.
          type: string
          format: uuid
          example: be6f252d-5aa6-49e3-a2e2-470a67f88711
        recipientsCount:
          description: The amount of recipients within the scheduled report instance
          type: integer
          example: 100
  parameters:
    scheduledReportIdPath:
      name: scheduledReportId
      in: path
      description: The scheduled report's unique identifier
      required: true
      schema:
        type: string
        format: uuid
    pageSizeQuery:
      name: pageSize
      in: query
      description: How many items to be returned at a time.
      required: false
      schema:
        type: integer
    instanceRunIdPath:
      name: instanceRunId
      in: path
      description: The scheduled report's instance run unique identifier
      required: true
      schema:
        type: string
        format: uuid
    pageNumberQuery:
      name: pageStartIndex
      in: query
      description: The index of the page to return
      required: false
      schema:
        type: integer
        default: 0
    recipientIdPath:
      name: recipientId
      in: path
      description: The scheduled report's recipient unique identifier of a given instance run
      required: true
      schema:
        type: string
        format: uuid
  responses:
    401Unauthorized:
      description: The API key provided is missing, invalid, or has been deactivated. Verify your API key and try again.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
    400BadRequest:
      description: The request was malformed or contained invalid field values. Check the error response body for details.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
    416RangeNotSatisfiable:
      description: Range Not Satisfiable.
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
          examples:
            RangeNotSatisfiable:
              summary: Range Not Satisfiable
              value:
                message: The range of data requested from the resource is invalid.
            PaginationRangeNotSatisfiable:
              summary: Pagination Range Not Satisfiable
              value:
                message: The requested pagination range falls outside the available data. Check the `count` field from a prior response and adjust your pagination parameters.
    404NotFound:
      description: The requested resource was not found. Verify the ID in the request path is correct and that the resource exists.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
x-provenance:
  method: searched
  source: https://apidocs.acculynx.com/reference
  harvested: '2026-10-28'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://apidocs.acculynx.com/reference/createjob.md
  - https://apidocs.acculynx.com/reference/getaccountingintegrationssyncchangesforjob.md
  - https://apidocs.acculynx.com/reference/getaccounttypebyid.md
  - https://apidocs.acculynx.com/reference/getacculynxcountries.md
  - https://apidocs.acculynx.com/reference/getacculynxcountry.md
  - https://apidocs.acculynx.com/reference/getacculynxstate.md
  - https://apidocs.acculynx.com/reference/getacculynxstates.md
  - https://apidocs.acculynx.com/reference/getacculynxunitsofmeasure-1.md
  - https://apidocs.acculynx.com/reference/getactiveaccounttypes.md
  - https://apidocs.acculynx.com/reference/getactiveleadsources.md
  - https://apidocs.acculynx.com/reference/getadjusterforjob.md
  - https://apidocs.acculynx.com/reference/getappointmentbyid.md
  - https://apidocs.acculynx.com/reference/getappointments.md
  - https://apidocs.acculynx.com/reference/getarownerforjob.md
  - https://apidocs.acculynx.com/reference/getcalendars.md
  - https://apidocs.acculynx.com/reference/getcompanydocumentfolders.md
  - https://apidocs.acculynx.com/reference/getcompanyrepresentativeforjob.md
  - https://apidocs.acculynx.com/reference/getcompanysettings.md
  - https://apidocs.acculynx.com/reference/getcompanysettingscustomfields.md
  - https://apidocs.acculynx.com/reference/getcompanysettingsjobsettingsjobcategories.md
  - https://apidocs.acculynx.com/reference/getcompanysettingsjobsettingstradetypes.md
  - https://apidocs.acculynx.com/reference/getcompanysettingsjobsettingsworktypes.md
  - https://apidocs.acculynx.com/reference/getcompanysettingslocationsettingscountries.md
  - https://apidocs.acculynx.com/reference/getcompanysettingslocationsettingscountriescountryidstates.md
  - https://apidocs.acculynx.com/reference/getcontact.md
  - https://apidocs.acculynx.com/reference/getcontactcustomfieldbyid.md
  - https://apidocs.acculynx.com/reference/getcontactcustomfields.md
  - https://apidocs.acculynx.com/reference/getcontactemailaddressbyid.md
  - https://apidocs.acculynx.com/reference/getcontactemailaddresses.md
  - https://apidocs.acculynx.com/reference/getcontactjobs.md
  - https://apidocs.acculynx.com/reference/getcontactphonenumber.md
  - https://apidocs.acculynx.com/reference/getcontactphonenumberbyid.md
  - https://apidocs.acculynx.com/reference/getcontacts.md
  - https://apidocs.acculynx.com/reference/getcontacttypes.md
  - https://apidocs.acculynx.com/reference/getcurrentjobmilestone.md
  - https://apidocs.acculynx.com/reference/getestimatebyid.md
  - https://apidocs.acculynx.com/reference/getestimates.md
  - https://apidocs.acculynx.com/reference/getestimatesectionbyid.md
  - https://apidocs.acculynx.com/reference/getestimatesectionitem.md
  - https://apidocs.acculynx.com/reference/getestimatesectionitems.md
  - https://apidocs.acculynx.com/reference/getestimatesections.md
  - https://apidocs.acculynx.com/reference/getestimatesforjob.md
  - https://apidocs.acculynx.com/reference/getfinancialsbyfinancialid.md
  - https://apidocs.acculynx.com/reference/getfinancialsforjob.md
  - https://apidocs.acculynx.com/reference/getfinancialssupplementitemcollection.md
  - https://apidocs.acculynx.com/reference/getfinancialssupplementnotationcollection.md
  - https://apidocs.acculynx.com/reference/getfinancialssupplementsforcompany.md
  - https://apidocs.acculynx.com/reference/getinitialappointmentforjob.md
  - https://apidocs.acculynx.com/reference/getinsurancecompanies.md
  - https://apidocs.acculynx.com/reference/getinsuranceforjob.md
  - https://apidocs.acculynx.com/reference/getinvoicebyid.md
  - https://apidocs.acculynx.com/reference/getinvoicesforjob.md
  - https://apidocs.acculynx.com/reference/getjob.md
  - https://apidocs.acculynx.com/reference/getjobcontact.md
  - https://apidocs.acculynx.com/reference/getjobcontacts.md
  - https://apidocs.acculynx.com/reference/getjobcustomfieldbyid.md
  - https://apidocs.acculynx.com/reference/getjobcustomfields.md
  - https://apidocs.acculynx.com/reference/getjobexternalreferences.md
  - https://apidocs.acculynx.com/reference/getjobhistory.md
  - https://apidocs.acculynx.com/reference/getjobmilestonebyid.md
  - https://apidocs.acculynx.com/reference/getjobs.md
  - https://apidocs.acculynx.com/reference/getjobstatusbyid.md
  - https://apidocs.acculynx.com/reference/getleadhistory.md
  - https://apidocs.acculynx.com/reference/getleadsourcebyid.md
  - https://apidocs.acculynx.com/reference/getleadsourcechildbyid.md
  - https://apidocs.acculynx.com/reference/getmilestones.md
  - https://apidocs.acculynx.com/reference/getmilestonesforjob.md
  - https://apidocs.acculynx.com/reference/getpayments.md
  - https://apidocs.acculynx.com/reference/getpaymentsoverviewforjob.md
  - https://apidocs.acculynx.com/reference/getphotovideotags.md
  - https://apidocs.acculynx.com/reference/getping.md
  - https://apidocs.acculynx.com/reference/getreportbyinstanceid.md
  - https://apidocs.acculynx.com/reference/getreportinstacerecipientbyid.md
  - https://apidocs.acculynx.com/reference/getreportlatestinstance.md
  - https://apidocs.acculynx.com/reference/getreportsbyinstanceinstancerunsbyscheduleid.md
  - https://apidocs.acculynx.com/reference/getreportsrecipientsbyinstanceid.md
  - https://apidocs.acculynx.com/reference/getrepresentativesforjob.md
  - https://apidocs.acculynx.com/reference/getsalesownerforjob.md
  - https://apidocs.acculynx.com/reference/getstatusesformilestone.md
  - https://apidocs.acculynx.com/reference/getsupplementbyid.md
  - https://apidocs.acculynx.com/reference/getuser.md
  - https://apidocs.acculynx.com/reference/getusers.md
  - https://apidocs.acculynx.com/reference/getworksheetamendmentbyid.md
  - https://apidocs.acculynx.com/reference/getworksheetamendmentsbyid.md
  - https://apidocs.acculynx.com/reference/getworksheetbyid.md
  - https://apidocs.acculynx.com/reference/postaddjobdocument.md
  - https://apidocs.acculynx.com/reference/postarownerforjob.md
  - https://apidocs.acculynx.com/reference/postcompanyrepresentativeforjob.md
  - https://apidocs.acculynx.com/reference/postcontactemailaddresses.md
  - https://apidocs.acculynx.com/reference/postcontactlog.md
  - https://apidocs.acculynx.com/reference/postcontactnotes.md
  - https://apidocs.acculynx.com/reference/postcontactphonenumber.md
  - https://apidocs.acculynx.com/reference/postcontacts.md
  - https://apidocs.acculynx.com/reference/postcontactsearch.md
  - https://apidocs.acculynx.com/reference/postcreatejobexternalreference.md
  - https://apidocs.acculynx.com/reference/postcreatejobmessage.md
  - https://apidocs.acculynx.com/reference/postcreatepaymentadditionalexpense.md
  - https://apidocs.acculynx.com/reference/postcreatepaymentpaid.md
  - https://apidocs.acculynx.com/reference/postcreatepaymentreceived.md
  - https://apidocs.acculynx.com/reference/postjobmeasurementsupload.md
  - https://apidocs.acculynx.com/reference/postjobmeasurementsuploadfiles.md
  - https://apidocs.acculynx.com/reference/postreplyjobmessage.md
  - https://apidocs.acculynx.com/reference/postsalesownerforjob.md
  - https://apidocs.acculynx.com/reference/postuploadphotoorvideo.md
  - https://apidocs.acculynx.com/reference/postworksheetsectionitem.md
  - https://apidocs.acculynx.com/reference/putadjusterforjob.md
  - https://apidocs.acculynx.com/reference/putcontactcustomfieldbyid.md
  - https://apidocs.acculynx.com/reference/putcontactcustomfields.md
  - https://apidocs.acculynx.com/reference/putinitialappointmentforjob.md
  - https://apidocs.acculynx.com/reference/putinsurancecompanyforjob.md
  - https://apidocs.acculynx.com/reference/putinsuranceinformationforjob.md
  - https://apidocs.acculynx.com/reference/putjobcustomfieldbyid.md
  - https://apidocs.acculynx.com/reference/putjobcustomfields.md
  - https://apidocs.acculynx.com/reference/putjoblocationaddress.md
  - https://apidocs.acculynx.com/reference/putpriorityforjob.md
  - https://apidocs.acculynx.com/reference/searchjobs.md
  - https://apidocs.acculynx.com/reference/updatejobcategory.md
  - https://apidocs.acculynx.com/reference/updatejobleadsource.md
  - https://apidocs.acculynx.com/reference/updatejobtradetypes.md
  - https://apidocs.acculynx.com/reference/updatejobworktype.md
  merge:
    pages: 120
    deduped: 1079
    conflicts_kept_first: 0