Skip to content
Changelog

Report a bug

Acculynx integration: operations for AI agents

Acculynx connects to Type.com as an integration. This page lists the 127 operations documented for Claude and Codex in Type.com: 89 read, 22 write, 16 destructive.

About Acculynx

AccuLynx is the leading, all-in-one roofing software designed to streamline every aspect of a roofing business.

Categories: Sales & CRM

How to connect Acculynx to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

127 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

127 operations listed.

Acculynx Common

  • Read

    Get AccuLynx Countries

    Use this endpoint to get a listing of the countries supported by AccuLynx. Supported includes: states.

  • Read

    Get an AccuLynx Country

    Use this endpoint to get a specific country. Supported includes: states.

  • Read

    Get States

    Use this endpoint to get the states supported by AccuLynx for a country. Supported includes: states.

  • Read

    Get a Particular State

    Use this endpoint to get a specific state within a specific country.

Accu Lynx Common

  • Read

    Get Units of Measure

    Use this endpoint to get the list of the catalog units of measure.

Calendar

  • Read

    Get Calendars

    Use this endpoint to get a list of calendars for the location. This endpoint will return a paginated response starting from the given record index.

  • Read

    Get Calendar Appointments

    Use this endpoint to get a list of appointments for the specified calendar. The request range should not exceed 90 days.

  • Read

    Get Appointment Details

    Use this endpoint to get the appointment details for a specific calendar event.

Company

  • Read

    Get Company Settings

    Use this endpoint to get a list of settings for the current location.

  • Read

    Get Custom Field Definitions

    Use this endpoint to retrieve custom field definitions and the options related to each custom field definition by company. Returns Custom Field Definitions for types "contact" and "job" with only active status. Includes field options with active status by default.

  • Read

    Get Document Folders

    Use this endpoint to get the document folders for a company. This endpoint will return a paginated response starting from the given record index.

  • Read

    Get Company Photo and Video Tags

    Use this endpoint to get a list of the photo and video tags for the current location.

  • Read

    Get Company Active Account Types

    Use this endpoint to get a list of 'active' Account Types for the current company.

  • Read

    Get Company Active Account Type by ID

    Use this endpoint to get an account type by ID.

  • Read

    Get Company Countries

    Use this endpoint to get a list of countries supported by the current company. This endpoint will return a paginated response starting from the given record index.

  • Read

    Get Company States

    Use this endpoint to get a list of the states supported by the current company. CountryId must be an existing country supported by the current company. This endpoint will return a paginated response starting from the given record index. StartIndex starts at 0.

  • Read

    Get Insurance Companies

    Use this endpoint to get a list of insurance companies for the current location. The response is paginated based on the pageSize and StartIndex query parameters and sorted by based on tag name in the order given by the sortOrder query parameter.

  • Read

    Get Job Categories of the Company

    Use this endpoint to get all the Job Categories for a company. StartIndex starts at 0. Default PageSize is 25. Pagination parameters are optional. Only active job category values are returned.

  • Read

    Get Trade Types of the Company

    Use this endpoint to get all the Trade Types for a company. StartIndex starts at 0. Default PageSize is 25. Pagination parameters are optional. This endpoint will return a paginated response starting from the given record index. Only active trade type values are returned.

  • Read

    Get Work Types of a Company

    Use this endpoint to get all the Work Types for a company. StartIndex starts at 0. Default PageSize is 100. Pagination parameters are optional. Only active work type values are returned.

  • Read

    Get Active Lead Sources for a Company

    Use this endpoint to get a list of active lead sources for the current location. This will return the complete lead sources list available for the current location. Inactive lead sources won't be returned. StartIndex starts at 0. Default PageSize is 25.

  • Read

    Get Company Lead Source by ID

    Use this endpoint to get a lead source for the current location. This will return a lead source available for the current location.

  • Read

    Get Company Child Lead Source by ID

    Use this endpoint to get a child lead source for the current location. This will return a child lead source available for the current location.

  • Read

    Get Milestones

    Get milestones related to company. For including statuses, the company must have enabled custom workflows. Supported includes: status.

  • Read

    Get Statuses for a Milestone

    Get statuses for a milestone.

Contacts

  • Read

    Get Contacts

    Use this endpoint to get a listing of Contacts. Supported includes: emailAddress, phoneNumber.

  • Read

    Get Contact Types

    Use this endpoint to get the list of contact types from a company.

  • Read

    Search Contacts

    Use this endpoint to get a list of contacts matching the given search criteria. Contacts are returned if they include a given first name, last name, company name, and contact type. it will filter by range of dates, using the CreationDate of the contact.

  • Read

    Get Contact by ID

    Use this endpoint to get details for a specific contact. Supported includes: emailAddress, phoneNumber.

  • Read

    Get Contact Custom Fields

    Get a list of all custom fields related to a specific contact by its contact Id. This endpoint will return a paginated response starting from the given record index. StartIndex starts at 0. Default PageSize is 25. Pagination parameters are optional.

  • Read

    Get Contact Custom Field

    Get a custom field object inside a contact provided a custom field id and a valid contact id

  • Read

    Get Email Addresses

    Use this endpoint to get the list of email addresses for a specific contact.

  • Read

    Get Email Address

    Use this endpoint to get the email addresses for a specific emailId associated with a specific contact.

  • Read

    Get Jobs for a Contact

    Retrieves a paginated list of all jobs that the contact is associated with.

  • Read

    Get Phone Numbers

    Use this endpoint to get the list of phone numbers for a specific contact.

  • Read

    Get Phone Number

    Use this endpoint to get the phone number for a specific phoneId associated with a specific contact.

  • Write

    Create Contact

    Use this endpoint to create a new contact. This endpoint is rate limited. Use the RateLimit- response headers to check current limits and remaining quota.

  • Write

    Create Email Address

    Use this endpoint to add an email address to the list of addresses for a specific contact. This endpoint is rate limited. Use the RateLimit- response headers to check current limits and remaining quota.

  • Write

    Create Phone Number

    Use this endpoint to add a phone number to the list of phone numbers for a specific contact. This endpoint is rate limited. Use the RateLimit- response headers to check current limits and remaining quota.

  • Write

    Create Contact Log

    Use this endpoint to create a new Log for an existing contact. This endpoint is rate limited. Use the RateLimit- response headers to check current limits and remaining quota.

  • Write

    Create Contact Note

    Creates a new note entry associated with a specific contact. Required Fields: - note: The body text of the note (max 1000 characters). Behavior: - Returns 201 with empty body. - Returns 400 if required fields are missing or fail validation constraints.

  • Destructive

    Update Contact Custom Fields

    Use this endpoint to update multiple custom field values for a contact. The limit of the Custom Field list to update cannot be greater than 120. If the custom field type is Text, the maximum lenght of the text is 500 characters. Any text beyond that limit will be truncated.

  • Destructive

    Update Contact Custom Field

    Sets a value for the specified custom field in the contact. If the custom field type is Text, the maximum lenght of the text is 500 characters. Any text beyond that limit will be truncated. This endpoint is rate limited.

Diagnostics

  • Read

    Check if the API Server Is Responsive

    Use this endpoint to verify that the API server is responsive.

Estimates

  • Read

    Get Estimates

    Use this endpoint to get all estimates for the current location. Supported includes: job.

  • Read

    Get Estimate

    Use this endpoint to get a specific estimate. Supported includes: job, createdBy, modifiedBy, sections.

  • Read

    Get Estimate Sections

    Use this endpoint to get all sections for the given estimate. Supported includes: createdBy, modifiedBy, items.

  • Read

    Get Estimate Section

    Use this endpoint to get a specific estimate section. Supported includes: createdBy, modifiedBy, items.

  • Read

    Get Estimate Section Items

    Use this endpoint to get all items for the given estimate section.

  • Read

    Get Estimate Section Item

    Use this endpoint to get a specific estimate item.

Jobs

  • Read

    Get Jobs

    Use this endpoint to get a listing of Jobs. When startDate and endDate are specified, jobs returned will be filtered to the given date range (inclusive). The date field to filter on is given with dateFilterType which defaults to CreatedDate.

  • Read

    Get Job External References

    Use this endpoint to retrieve the external references that link an AccuLynx job to a project in an external system. source is required.

  • Read

    Search Jobs

    Use this endpoint to get a listing of jobs matching the given search criteria. Jobs are returned if they include a given search term and/or they are near a given set of map coordinates. At least one of searchTerm or geoLocation must be included.

  • Read

    Get Job by ID

    Use this endpoint to get details for a specific job. Unassigned leads or jobs will not be returned. Supported includes: contact, initialAppointment.

  • Read

    Get Job Adjuster

    This endpoint returns the job's insurance adjuster information.

  • Read

    Get Job Contacts

    Use this endpoint to get the list of contacts for a job. Supported includes: contact.

  • Read

    Get Job Contact by ID

    Use this endpoint to get details of a specific job contact. Supported includes: contact.

  • Read

    Get Job Custom Fields

    Get a list of all custom fields related to a specific job by its job Id. This endpoint will return a paginated response starting from the given record index. StartIndex starts at 0. Default PageSize is 25. Pagination parameters are optional.

  • Read

    Get Job Custom Field by ID

    Get a custom field object inside a job, provided a custom field ID and a valid job ID

  • Read

    Get Job Estimates

    Use this endpoint to get a list of estimates for the specified job. This endpoint will return a paginated response starting from the given record index.

  • Read

    Get Job Invoices

    Use this endpoint to get a list of invoices for the specified job.

  • Read

    Get Job Financials

    Use this endpoint to get the Financials for the specified job. Supported includes: worksheet, amendments.

  • Read

    Get Job Accounting Integration Status

    Use this endpoint to get status of the accounting integration sync for the specified job.

  • Read

    Get Job Change History

    Use this endpoint to get a history of actions performed for a job. Supported includes: createdBy. When startDate and endDate are specified, actions returned will be filtered to those created between those dates (inclusive).

  • Read

    Get Job Initial Appointment

    Use this endpoint to get the initial appointment for a job.

  • Read

    Get Job Insurance

    This endpoint returns the job's insurance information.

  • Read

    Get Job Milestone History

    Get milestone history for the specified Job.

  • Read

    Get Job Milestone by ID

    Get a single milestone information by id. For including statuses the company must have enabled custom workflows. Supported includes: status.

  • Read

    Get Job Milestone Status by ID

    Get a single status information by ID.

  • Read

    Get Current Job Milestone

    Get the current milestone information. For including statuses the company must have enabled custom workflows. Supported includes: status.

  • Read

    Get Job Payments

    Returns all payment records associated with the specified job, organized into three groups: received payments (amounts collected from the customer), paid payments (amounts paid to vendors or subcontractors), and additional expenses.

  • Read

    Get Job Payments Overview

    Use this endpoint to get a high-level overview of financial information for the specified job.

  • Read

    Get Job Representatives

    Use this endpoint to get the list of representatives for a Job. This endpoint will return a paginated response starting from the given record index.

  • Read

    Get Job Company Representative

    Use this endpoint to get the company representative for a job.

  • Read

    Get Job Sales Owner

    Use this endpoint to get the sales owner for a job.

  • Read

    Get Job A/R Owner

    Use this endpoint to get the A/R representative for a job.

  • Write

    Create Job

    Use this endpoint to create a new job. The job is created in the Lead milestone with no assigned representative (Unassigned). The contact field is required and links an existing contact as the primary contact for the job. This endpoint is rate limited.

  • Write

    Create Job External Reference

    Use this endpoint to create a new external reference for a job to an external source and project. This endpoint is rate limited. Use the RateLimit- response headers to check current limits and remaining quota.

  • Write

    Add Job Document

    Use this endpoint to add a job document for a specific job. Special characters and spaces will be removed from the file name before upload. This endpoint is rate limited. Use the RateLimit- response headers to check current limits and remaining quota.

  • Write

    Create Job Message

    Use this endpoint to post a comment to the job's message feed. The comment will be visible in the job's Messages section within the AccuLynx web and mobile applications. This endpoint is rate limited.

  • Write

    Create Job Message Reply

    Use this endpoint to post a reply to an existing comment in the job's message feed. The reply will be visible in the job's Messages section within the AccuLynx web and mobile applications. This endpoint is rate limited.

  • Write

    Create Received Payment

    Use this endpoint to create a new payment received. This endpoint is rate limited. Use the RateLimit- response headers to check current limits and remaining quota.

  • Write

    Create Paid Payment

    Use this endpoint to create a new payment paid. This endpoint is rate limited. Use the RateLimit- response headers to check current limits and remaining quota.

  • Write

    Create Additional Job Expense

    Use this endpoint to create a new payment Additional Job Expenses. This endpoint is rate limited. Use the RateLimit- response headers to check current limits and remaining quota.

  • Write

    Update Company Representative

    Use this endpoint to update the company representative for a job. This endpoint is rate limited. Use the RateLimit- response headers to check current limits and remaining quota.

  • Write

    Add or Update Sales Owner

    Use this endpoint to add or update the sales owner for a job. This endpoint is rate limited. Use the RateLimit- response headers to check current limits and remaining quota.

  • Write

    Add or Update A/R Owner

    Use this endpoint to add or update the A/R Owner for a job. This endpoint is rate limited. Use the RateLimit- response headers to check current limits and remaining quota.

  • Write

    Upload Job Photo or Video

    Use this endpoint to Upload a single Photo or Video for the specified job. Special characters and spaces will be removed from the file name before upload. This endpoint is rate limited. Use the RateLimit- response headers to check current limits and remaining quota.

  • Write

    Create Job Manual Measurements

    - Use this endpoint to create one or more manual measurements using a list of measurements entered in a file - The measurements file must contain the measurements information for the measurements to be created on the job.

  • Write

    Create Job Measurements Order

    Use this endpoint to create a measurements order with the external provider Information for a specific job. - The measurement file can be an XML or JSON file. - The file content has to be a valid XML or JSON structure.

  • Destructive

    Update Job Address

    This endpoint updates the job location address information. This endpoint is rate limited. Use the RateLimit- response headers to check current limits and remaining quota.

  • Destructive

    Update Job Adjuster

    This endpoint sets or updates the job adjuster information. This endpoint is rate limited. Use the RateLimit- response headers to check current limits and remaining quota.

  • Destructive

    Update Job Custom Fields

    Use this endpoint to update multiple custom field values for a Job. The limit of the Custom Field list to update cannot be greater than 120. If the custom field type is Text, the maximum lenght of the text is 500 characters. Any text beyond that limit that will be truncated.

  • Destructive

    Update Job Custom Field by ID

    Sets a value for the specified custom field in the Job. If the custom field type is Text, the maximum lenght of the text is 500 characters. Any text beyond that limit will be truncated. This endpoint is rate limited.

  • Destructive

    Update Job Initial Appointment

    Use this endpoint to add or modify the initial appointment for a job. All datetimes should be UTC and in ISO 8601 format (suffixed with 'Z'). This endpoint is rate limited. Use the RateLimit- response headers to check current limits and remaining quota.

  • Destructive

    Update Job Insurance

    This endpoint sets the insurance information for an existing job. - "Insurance company" section: It can be set by ID or by name, but not both. The ID should belong to the existing insurance companies. If the name is used it will be assigned to "Other" (active) insurance company.

  • Destructive

    Update Job Insurance Company

    This endpoint sets an insurance company to an existing job. It can be set by ID or by name, but not both. The ID should belong to the existing insurance companies. If the name is used it will be assigned to "Other" (active) insurance company.

  • Destructive

    Update Job Priority

    This endpoint sets the priority for an existing job. This endpoint is rate limited. Use the RateLimit- response headers to check current limits and remaining quota.

  • Destructive

    Update Job Category

    Allows a user to set a job category for a given job. This endpoint is rate limited. Use the RateLimit- response headers to check current limits and remaining quota.

  • Destructive

    Update Job Lead Source

    Updates the lead source for a specified job. The endpoint validates that both job and lead source belong to the company associated with the API key. If the provided lead source ID matches the current one, no update will be performed. Empty GUIDs are not allowed.

  • Destructive

    Update Job Work Type

    Updates work type for a specific job. This endpoint is rate limited. Use the RateLimit- response headers to check current limits and remaining quota.

  • Destructive

    Update Job Trade Types

    Updates trade types for a specific job. Trade types passed on the body will replace those already existing on the job. If an empty array is provided, current trade types in the job will be unassigned. This endpoint is rate limited.

Leads

  • Read

    Get Lead History

    Use this endpoint to get a history of actions performed for a lead. Supported includes: createdBy.

Users

  • Read

    Get Users

    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.

  • Read

    Get User

    Use this endpoint to get the details of a specific user.

Reports

  • Read

    Get Report Schedule Runs

    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.

  • Read

    Get Report Instance by ID

    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

  • Read

    Get Latest Report Instance

    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.

  • Read

    Get Report Instance Recipients

    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.

  • Read

    Get Report Instance Recipient by ID

    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.

Supplements

  • Read

    Get Supplements

    Use this endpoint to get a list of supplements for the current location. The page start index begins at 0. The default page size is 25. Pagination parameters are optional. Supported includes: items, notations.

  • Read

    Get Supplement by ID

    Use this endpoint to get a particular supplement for the current location.

  • Read

    Get Supplement Items

    Use this endpoint to get a list of items for a specific supplement in the current location. StartIndex starts at 0. The default PageSize is 25. Pagination parameters are optional. Example: api/v2/supplements/{supplementId}/items?pageSize=25&pageStartIndex=0

  • Read

    Get Supplement Notations

    Use this endpoint to get a list of notations for a specific supplement in the current location. StartIndex starts at 0. The default PageSize is 25. Pagination parameters are optional. Example: api/v2/supplements/{supplementId}/notations?pageSize=25&pageStartIndex=0

Invoices

  • Read

    Get Invoice

    Use this endpoint to get a specific Invoice.

Financials

  • Read

    Get Financials

    Use this endpoint to get the Financials for the specified financialID. Supported includes: worksheet, amendments.

  • Read

    Get Worksheet

    Use this endpoint to get a specific Worksheet by financial ID.

  • Read

    Get Financial Amendments

    Use this endpoint to get a specific Financial's Amendments.

  • Read

    Get Financial Amendment

    Use this endpoint to get a specific Amendment.

  • Write

    Create Worksheet Item

    Creates a new item in a worksheet using its financial ID. If the worksheet does not exist, it will be created, and the sectionId parameter should be left empty.

Subscriptions

  • Read

    Get subscriptions

    Retrieves all webhook subscriptions for your company. This endpoint returns a paginated list of webhook subscriptions, including: - Subscription status (enabled/disabled) - Consumer URLs where webhook events are sent - Technical contact information - Topics each subscription is…

  • Read

    Get subscription

    Retrieves detailed information about a specific subscription.

  • Write

    Create Subscription

    Creates a new webhook subscription for your company. You must provide: - A valid consumer URL where webhook events will be sent - A technical contact email for notifications about the subscription - At least one topic name to subscribe to - An integration type that indicates the…

  • Write

    Send a test event

    Sends a test event to your webhook endpoint. This is extremely useful for: - Verifying your webhook receiver is properly configured - Testing your event handling logic - Confirming connectivity between AccuLynx and your systems You must specify a valid topic name in the request…

  • Destructive

    Update subscription by id

    Updates an existing subscription. You can modify: - The technical contact email address - The list of topics this subscription is listening for Note that you cannot update the consumer URL after creation.

  • Destructive

    Delete subscription by id

    Permanently deletes a subscription. Once deleted: - The subscription will no longer receive any webhook events - The subscription cannot be recovered - Any new events for the topics it was listening to will not be sent Use this endpoint when you no longer need a particular webho…

Topics

  • Read

    Get topics

    Retrieves all available webhook topics you can subscribe to. This endpoint returns a paginated list of all active topics, including: - Topic names that you can use when creating or updating subscriptions - Descriptions explaining what events each topic represents Use this endpoi…

See How connections work for access and permissions, or browse all integrations.