Audatex

Audatex Terminal API

The Terminal API from Audatex — 3 operation(s) for terminal.

GitHub OpenAPI

Operations 3

GET /api/sites Get details about a company's' sites #
GET /api/sites/{siteId} Get details about a specific site #
GET /api/users/{id}/terminals Gets all the terminals belonging to the specified user #

Documentation

📖
Documentation
https://audaconnect.ax-aee.co.uk/AudaAPI.WebAPI/help
📖
APIReference
https://audaconnect.ax-aee.co.uk/AudaAPI.WebAPI/help
📖
Authentication
https://audaconnect.ax-aee.co.uk/AudaAPI.BMSAPI/home/help
📖
GettingStarted
https://audaconnect.ax-aee.co.uk/AudaAPI.BMSAPI/home/register
📖
Documentation
https://audaconnect.ax-aee.co.uk/AudaAPI.BMSAPI/home/help
📖
Documentation
https://services-pat.auda-target.com/APIGateway/swagger/index.html
📖
APIReference
https://services-pat.auda-target.com/APIGateway/swagger/index.html
📖
Documentation
https://api-demo.audatex.com/TestGICapi/docs/index.html
📖
Documentation
https://api-demo.audatex.com/TestAssignmentapi/docs/index.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/audatex/refs/heads/main/openapi/audatex-terminal-api-openapi.yml

Other Resources

🔗
DeveloperPortal
https://audaconnect.ax-aee.co.uk/AudaAPI.Portal/
🔗
Sandbox
https://audaconnect-demo.ax-aee.co.uk/AudaAPI.WebAPI/
🔗
Webhooks
https://audaconnect.ax-aee.co.uk/AudaAPI.WebAPI/Help/Topic/NotificationTopics
🔗
Sandbox
https://audaconnect-demo.ax-aee.co.uk/AudaAPI.Bmsapi/
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/audatex/refs/heads/main/asyncapi/audatex-webhooks.yml
🔗
Sandbox
https://api-demo.audatex.com/TestGICapi/docs/index.html
🔗
Sandbox
https://api-demo.audatex.com/TestAssignmentapi/docs/index.html

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/audatex:audatex-terminal-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

audatex-terminal-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: v1
  title: AudaConnect Terminal API
  description: 'AudaConnect. You can use this Swagger page to test the API. You will need to authenticate either at the top of the page for multiple scopes or clicking on the authentication status image on each operation. You will need to use your supplied Client Application ID during when selecting scopes. AudaConnect API Build Version: 2.25.26048.2'
  contact:
    name: Audatex UK
    url: https://audaconnect.ax-aee.co.uk/AudaAPI.WebAPI/help
    email: servicedesk@audatex.co.uk
servers:
- url: https://audaconnect.ax-aee.co.uk/AudaAPI.WebAPI
tags:
- name: Terminal
paths:
  /api/sites:
    get:
      tags:
      - Terminal
      summary: Get details about a company's' sites
      operationId: Terminal_GetSites
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AudaAPI.Models.SiteDetails'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AudaAPI.Models.SiteDetails'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AudaAPI.Models.SiteDetails'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AudaAPI.Models.SiteDetails'
      security:
      - oauth2:
        - ReferenceData.System
  /api/sites/{siteId}:
    get:
      tags:
      - Terminal
      summary: Get details about a specific site
      operationId: Terminal_GetSite
      parameters:
      - name: siteId
        in: path
        description: Site ID>
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AudaAPI.Models.SiteDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/AudaAPI.Models.SiteDetails'
            application/xml:
              schema:
                $ref: '#/components/schemas/AudaAPI.Models.SiteDetails'
            text/xml:
              schema:
                $ref: '#/components/schemas/AudaAPI.Models.SiteDetails'
      security:
      - oauth2:
        - ReferenceData.System
  /api/users/{id}/terminals:
    get:
      tags:
      - Terminal
      summary: Gets all the terminals belonging to the specified user
      operationId: Terminal_GetUserTerminals
      parameters:
      - name: id
        in: path
        description: The unique ID of the user.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AudaAPI.Models.Terminal'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AudaAPI.Models.Terminal'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AudaAPI.Models.Terminal'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AudaAPI.Models.Terminal'
      security:
      - oauth2:
        - ReferenceData.System
components:
  schemas:
    AudaAPI.Models.Site:
      type: object
      properties:
        ID:
          format: uuid
          type: string
        Contact:
          $ref: '#/components/schemas/AudaAPI.Models.Contact'
        Address:
          $ref: '#/components/schemas/AudaAPI.Models.Address'
        AKAName:
          type: string
        CompanyName:
          type: string
        SiteId:
          type: string
        ExternalCode:
          type: string
    AudaAPI.Models.SiteOption:
      type: object
      properties:
        Name:
          type: string
        Value:
          type: string
    AudaAPI.Models.Contact:
      type: object
      properties:
        ContactType:
          type: string
        AbleToAuthorise:
          type: string
        Name:
          type: string
        Title:
          type: string
        Forename:
          type: string
        Surname:
          type: string
        EMailAddress:
          type: string
        Line01:
          type: string
        Line02:
          type: string
        Line03:
          type: string
        Line04:
          type: string
        Line05:
          type: string
        PostCode:
          type: string
        TelHome:
          type: string
        TelBusiness:
          type: string
        TelMobile:
          type: string
        TelOther:
          type: string
        Fax:
          type: string
    AudaAPI.Models.MasterList_CustomerNumber:
      type: object
      properties:
        ID:
          format: uuid
          type: string
        AddressLine1:
          type: string
        AddressLine2:
          type: string
        AddressLine3:
          type: string
        AddressLine4:
          type: string
        CustomerNumber:
          type: string
    AudaAPI.Models.SiteDetails:
      type: object
      properties:
        SiteId:
          type: string
        SiteName:
          type: string
        ExternalType:
          type: string
        Status:
          type: string
        AddressLine1:
          type: string
        AddressLine2:
          type: string
        AddressLine3:
          type: string
        AddressLine4:
          type: string
        AddressLine5:
          type: string
        Postcode:
          type: string
        Telephone:
          type: string
        Fax:
          type: string
        SiteOptions:
          type: array
          items:
            $ref: '#/components/schemas/AudaAPI.Models.SiteOption'
    AudaAPI.Models.Address:
      type: object
      properties:
        ID:
          format: uuid
          type: string
        AddressLine1:
          type: string
        AddressLine2:
          type: string
        AddressLine3:
          type: string
        AddressLine4:
          type: string
        AddressLine5:
          type: string
        PostCode:
          type: string
    AudaAPI.Models.Terminal:
      type: object
      properties:
        Id:
          format: uuid
          type: string
        MasterList_SiteId:
          $ref: '#/components/schemas/AudaAPI.Models.Site'
        MasterList_CustomerNumber:
          $ref: '#/components/schemas/AudaAPI.Models.MasterList_CustomerNumber'
        AudaMailName:
          type: string
        HexId:
          type: string
        IsAudaMailAddress:
          type: boolean
        TerminalId:
          type: string
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        implicit:
          scopes:
            System.Notifications: Create subscriptions and poll for notifications
            System.PushNotifications: Create subscriptions and receive push notifications
            Assessment.MainIndex: ''
            Assessment.Detail+ImageAccess: ''
            Assessment.ImageAdmin: ''
            Assessment.EditAssessmentAdminData: ''
            Assessment.MailReport: Creates a PDF for a mail.
            Parts.GetParts: ''
            Parts.UpdateParts: ''
            Manage.Suppliers: ''
            ReferenceData.My: Read access to your basic info e.g. email, user name
            ReferenceData.Company: Read access to basic info on your company
            ReferenceData.System: ''
            ReferenceData.SystemAdmin: ''
            TLA.CreateQuote: Create Total Loss Avoidance quotes
            Vehicle.Lookup: ''
            Vehicle.LookupDetailed: ''
            Vehicle.Valuation: Perform CAP valuations
          authorizationUrl: https://audaconnect.ax-aee.co.uk/AudaAPI.Portal/Oauth20
      description: OAuth2 Implicit Grant