AccuLynx Accu Lynx Common API
The accuLynxCommon API from AccuLynx — 5 operation(s) for acculynxcommon.
The accuLynxCommon API from AccuLynx — 5 operation(s) for acculynxcommon.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/acculynx:acculynx-acculynxcommon-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: 2.2614.0
title: AccuLynx API V2 Accu Lynx Common 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: accuLynxCommon
paths:
/acculynx/units-of-measure:
get:
summary: Get Units of Measure
description: Use this endpoint to get the list of the catalog units of measure.
operationId: getAccuLynxUnitsOfMeasure
responses:
'200':
description: 'OK
'
content:
application/json:
schema:
$ref: '#/components/schemas/unitOfMeasureCollection'
'401':
$ref: '#/components/responses/401Unauthorized'
tags:
- accuLynxCommon
/acculynx/countries:
get:
summary: Get AccuLynx Countries
description: 'Use this endpoint to get a listing of the countries supported by AccuLynx.
**Supported includes:** `states`.'
operationId: getAccuLynxCountries
parameters:
- $ref: '#/components/parameters/includesQuery'
responses:
'200':
description: 'OK
'
content:
application/json:
schema:
$ref: '#/components/schemas/countryCollection'
'401':
$ref: '#/components/responses/401Unauthorized'
tags:
- accuLynxCommon
/acculynx/countries/{countryId}:
get:
summary: Get an AccuLynx Country
description: 'Use this endpoint to get a specific country.
**Supported includes:** `states`.'
operationId: getAccuLynxCountry
parameters:
- $ref: '#/components/parameters/countryIdPath'
- $ref: '#/components/parameters/includesQuery'
responses:
'200':
description: 'OK
'
content:
application/json:
schema:
$ref: '#/components/schemas/country'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorized'
'404':
$ref: '#/components/responses/404NotFound'
tags:
- accuLynxCommon
/acculynx/countries/{countryId}/states:
get:
summary: Get States
description: 'Use this endpoint to get the states supported by AccuLynx for a country.
**Supported includes:** `states`.'
operationId: getAccuLynxStates
parameters:
- $ref: '#/components/parameters/countryIdPath'
responses:
'200':
description: 'OK
'
content:
application/json:
schema:
$ref: '#/components/schemas/stateCollection'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorized'
'404':
$ref: '#/components/responses/404NotFound'
tags:
- accuLynxCommon
/acculynx/countries/{countryId}/states/{stateId}:
get:
summary: Get a Particular State
description: Use this endpoint to get a specific state within a specific country.
operationId: getAccuLynxState
parameters:
- $ref: '#/components/parameters/countryIdPath'
- $ref: '#/components/parameters/stateIdPath'
responses:
'200':
description: 'OK
'
content:
application/json:
schema:
$ref: '#/components/schemas/state'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorized'
'404':
$ref: '#/components/responses/404NotFound'
tags:
- accuLynxCommon
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
unitOfMeasure:
type: object
properties:
id:
type: string
format: uuid
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
description: Unit of measure unique identifier
name:
description: The name of the unit of measure.
type: string
example: YD
friendlyName:
description: The friendly name of the unit of measure.
type: string
example: Yarda
unitOfMeasureCollection:
type: object
properties:
unitsOfMeasure:
type: array
items:
$ref: '#/components/schemas/unitOfMeasure'
stateCollection:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/state'
state:
type: object
properties:
id:
type: integer
description: The id for the state.
example: 43
name:
type: string
description: The name of the State.
example: Texas
abbreviation:
type: string
description: The 2 character abbreviation for the State.
example: TX
minLength: 2
maxLength: 2
_link:
type: string
description: The URI of the State.
example: https://api.acculynx.com/api/v2/acculynx/countries/1/states/43
countryCollection:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/country'
country:
type: object
properties:
id:
type: integer
description: The id for the Country.
example: 1
name:
type: string
description: The name of the Country.
example: United States
abbreviation:
type: string
description: The 2 character abbreviation for the Country.
example: US
minLength: 2
maxLength: 2
_link:
type: string
description: The URI of the Country.
example: https://api.acculynx.com/api/v2/acculynx/countries/1
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'
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:
includesQuery:
name: includes
in: query
description: A comma-separated list of related resources to expand inline in the response. Valid values vary by endpoint and are documented in each operation description.
required: false
schema:
type: string
stateIdPath:
name: stateId
in: path
description: The state's identifier.
required: true
schema:
type: string
format: integer
countryIdPath:
name: countryId
in: path
description: The country's identifier
required: true
schema:
type: string
format: integer
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