What's New?

•  Review API updates captured in the specified releases. This page lists both additive changes and changes that require updating your integration. 

6.25.0 - 6/25/2025

As part of the 6.25 American Sycamore release, Aspire’s API documentation has moved to a new location. We’ve updated the structure to make it easier to navigate, with improved schema accuracy and clearer endpoint definitions.

These changes include minor updates to the swagger.json file, such as adding operationId values, removing unsupported content types, and refining schema details. These updates do not change any API functionality but may affect tools or integrations that directly parse theswagger.json file.

If your integration relies onswagger.json, we recommend testing it in Sandbox, ahead of the Production release on July 16, 2025.

If you don’t useswagger.json directly, no action is needed.

To support this transition, we’ve included redirect rules to help ensure that links to older API documentation continue to work.

6.24.0 - 4/9/2025

• The following updates have been made to the Aspire External REST API to support flat rate pay alongside hourly pay:

  • GET Paycodes: The GET /Paycodes endpoint now returns the paycode type as either Hourly or Flat Rate.

  • PUT Paycodes: The PUT /Paycodes endpoint now includes error checking for flat rate paycodes, ensuring proper validation when updating paycode types.

  • POST Paycodes: The POST /Paycodes endpoint now defaults to Hourly if the paycode type name is left blank during the request, preventing API failures when creating a paycode.

6.19.0 - 5/16/2024

• The following additional endpoints have been added: 
  • GET OpportunityServiceGroups
  • GET OpportunityServiceKitItems

6.18.0 - 3/14/2024

• The following additional fields are returned from the GET Addresses endpoint: 
  • CreatedByUserName: Username of the contact who created the address entry. 
  • LastModifiedByUserName: Username of the contact who made the last update. 
• The following additional fields are returned for the GET Contacts endpoint: 
  • LastModifiedByUserID: Contains the unique identifier of the user who made the last modification.
  • LastModifiedByUserName: Contains the username of the user who made the last modification. 
• The GET Version/GETAPiVersion endpoint is now available by default. As an Admin, when selecting endpoints to provision with a set of credentials, this endpoint (as with POST Authorization and POST RefreshToken) will be grayed out since they are selected by default.
• Access to the Aspire External REST API Guide is now also available from the Swagger UI by clicking the API Documentation link.  

6.17.0 - 12/14/2023 

💭The following endpoints have been added to the Aspire External REST API to provide you with the ability to update the following records so that you have more flexibility when integrating with accounting systems: 

• PUT Localities: update locality records. 
• PUT TaxEntities: update tax entities. 
• PUT TaxJurisdictions: update tax jurisdictions.  

💭The following endpoints have been added to the Aspire External REST API to provide you with the ability to add the following records so that you have more flexibility when integrating with accounting systems: 

• POST Localities: update locality records. 
• POST TaxEntities: update tax entities. 
• POST TaxJurisdictions: update tax jurisdictions.  

💭 A PUT Users endpoint has been added to Aspire External REST API so that you can change a user record. 

6.16.0 - 10/12/2023

• Endpoint Level Security - customize authorization by granting or revoking access to endpoints using new or existing API credentials. You will only see the endpoints you can access in the Aspire External API reference. Enable or disable API credentials to control access to the associated granted endpoints using the Active toggle at the top of the screen. You can not regenerate a secret when your credential set is inactive.  You can go to this feature in Aspire by taking these steps:

1. Go to Administration > Application. 
2. Select API.
3. Select an existing or create a new Client ID/Secret.
4. Activate or deactivate credential access using the Active toggle.
5. Choose the endpoints to which you want to grant access under the Scope section of the page.
6. Save changes.  

•  POST PartialPayments endpoint has been added to the REST API reference and replicates the behavior of the SOAP Payments endpoint. The SOAP payments endpoint remains intact unchanged. 
• The following fields are now returned for the GET Receipts endpoint response:
  • LastModifiedDateTime: provides the date and time of the last modification made to a receipt.
  • LastModifiedByUserID: contains the unique identifier of the user who made the last modification.
  • LastModifiedByUserName: contains the name of the user who made the last modification.
• The following fields are now returned for the GET WorkTicketTimes endpoint:
  • LastModifiedDateTime: provides the date and time of the last modification made to a work ticket time entry.
  • LastModifiedByUserID: contains the unique identifier of the user who made the last modification.
  • LastModifiedByUserName: contains the name of the user who made the last modification.

💭- denotes new and improved functionality implemented in response to client portal feedback.