AccuLynx Users API

openapi: 3.2.0
info:
  version: 2.2614.0
  title: AccuLynx API V2 Users 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: Users
  description: Manage user accounts within the company.
paths:
  /users:
    get:
      summary: Get Users
      description: Use this endpoint to get the list of users for a company. The status filter can be used to filter users based on status - active, inactive, archived, or deleted. By default, only active users will be returned. This endpoint will return a paginated response starting from the given record index.
      operationId: getUsers
      parameters:
      - $ref: '#/components/parameters/pageSizeQuery'
      - $ref: '#/components/parameters/pageStartIndexQuery'
      - $ref: '#/components/parameters/statusFilterQuery'
      responses:
        '200':
          description: 'OK

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/companyUserCollection'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '416':
          $ref: '#/components/responses/416RangeNotSatisfiable'
      tags:
      - Users
  /users/{userId}:
    get:
      summary: Get User
      description: Use this endpoint to get the details of a specific user.
      operationId: getUser
      parameters:
      - $ref: '#/components/parameters/userIdPath'
      responses:
        '200':
          description: 'OK

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/companyUser'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '404':
          $ref: '#/components/responses/404NotFound'
      tags:
      - Users
components:
  schemas:
    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
    companyUserCollection:
      allOf:
      - $ref: '#/components/schemas/baseCollection'
      - type: object
        properties:
          items:
            type: array
            items:
              $ref: '#/components/schemas/companyUser'
    companyUser:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of the Company User.
          format: uuid
          example: 228db892-3b49-4455-b839-ffd8576d8731
        displayName:
          type: string
          description: The display name of the user.
        firstName:
          type: string
          description: The user's first name.
        lastName:
          type: string
          description: The user's last name.
        initials:
          type: string
          description: The user's initials.
        role:
          $ref: '#/components/schemas/companyUserRole'
        status:
          type: string
          enum:
          - Active
          - Inactive
          - Archived
          - Deleted
          description: the status of this user account.
        phone:
          type: string
          description: The user's phone number.
        mobilePhone:
          type: string
          description: The user's mobile phone number.
        email:
          type: string
          description: The user's email address.
        _link:
          type: string
          description: The unique URI of the AccuLynx User.
          example: https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731
    companyUserRole:
      type: object
      properties:
        id:
          type: integer
          description: The id/enum value of the user role.
          example: 3
        name:
          type: string
          enum:
          - Company Administrator
          - Location Administrator
          - Manager
          - Office
          - Sales
          - Crew
          description: The name of the role.
          example: Manager
    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.
  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'
  parameters:
    userIdPath:
      name: userId
      in: path
      description: The user'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
    statusFilterQuery:
      name: status
      in: query
      description: Return users of the listed status.  Possible values are Active, Inactive, Archived, and Deleted. Multiple values are given comma seperated.  To return all users - Active,Inactive,Archive,Deleted.  When no status parameter is given, the Active users are returned.
      required: false
      schema:
        type: string
    pageStartIndexQuery:
      name: pageStartIndex
      in: query
      description: The value of pageStartIndex will specify the index of the record that the list begins with.
      required: false
      schema:
        type: integer
        default: 0
  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