Australian Taxation Office API Info API

This will return the status and version of the API

Operations 1

GET / Will give current status of this API #

Documentation

Specifications

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/australian-taxation-office/json-schema/australian-taxation-office-relying-party-schema.json
📊
JSONSchema
https://artifacts.apis.io/australian-taxation-office/json-schema/australian-taxation-office-combined-minimum-global-domestic-return-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/australian-taxation-office/json-schema/australian-taxation-office-global-domestic-minimum-tax-return-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/australian-taxation-office/json-schema/australian-taxation-office-global-domestic-minimum-group-entity-tax-return-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/australian-taxation-office/json-schema/australian-taxation-office-global-domestic-minimum-group-entity-tax-return-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/australian-taxation-office/json-schema/australian-taxation-office-transaction-payment-reference-number-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/australian-taxation-office/json-schema/australian-taxation-office-gstproperty-settlement-withholding-notification-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/australian-taxation-office/json-schema/australian-taxation-office-gstproperty-settlement-date-confirmation-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/australian-taxation-office/json-schema/australian-taxation-office-heartbeat-info-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/australian-taxation-office/json-schema/australian-taxation-office-provider-list-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/australian-taxation-office/json-schema/australian-taxation-office-stapled-super-fund-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/australian-taxation-office/json-schema/australian-taxation-office-stapled-super-fund-response-schema.json

Other Resources

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/australian-taxation-office:australian-taxation-office-apiinfo-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.

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

OpenAPI Specification

australian-taxation-office-apiinfo-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Australian Taxation Office API Info API
  x-status:
    status: Active
  version: '1.0'
  description: 'Operations tagged ApiInfo across 4 of this provider''s published API definitions: dsg-health-check-v1_10_0_0.yaml, dsg-smsfaliaslookup-v1-prod_0_0.yaml, australian-taxation-office-health-check-openapi.yml, australian-taxation-office-smsf-alias-lookup-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{env}/healthcheck/v1
  description: Production Environment
  variables:
    env:
      default: api.ato.gov.au
      enum:
      - api.ato.gov.au
      - sandbox.api.ato.gov.au
- url: https://{env}/dsg-smsfaliaslookup/v1
  description: Production Environment
  variables:
    env:
      default: api.ato.gov.au
      enum:
      - api.ato.gov.au
      - sandbox.api.ato.gov.au
tags:
- name: ApiInfo
  description: This will return the status and version of the API
paths:
  /:
    get:
      tags:
      - ApiInfo
      summary: Will give current status of this API
      description: This will return the details specifically for this API and the status of the API
      operationId: GetStatus
      responses:
        '200':
          $ref: '#/components/responses/ApiInfoResponse'
      security:
      - ScopeAuth:
        - ato.healthcheck.*.*
    servers:
    - url: https://{env}/healthcheck/v1
      description: Production Environment
      variables:
        env:
          default: api.ato.gov.au
          enum:
          - api.ato.gov.au
          - sandbox.api.ato.gov.au
components:
  responses:
    ApiInfoResponse:
      description: ''
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiInfo'
          examples:
            successful:
              summary: API Status Example
              description: Example of the response that will be returned
              value: "{\n  \"api_version\": \"1.0.0\",\n  \"api_status\": \"Proposed\"\n}"
  schemas:
    ApiInfo:
      description: This will hold infomation of the version of the API as well as the status
      type: object
      additionalProperties: false
      properties:
        api_version:
          type:
          - string
          - 'null'
          example: 1.0.0
        api_status:
          type:
          - string
          - 'null'
          enum:
          - Proposed
          - Cancelled
          - Active
          - Deprecated
          - Deactivated
          example: Proposed
  securitySchemes:
    ScopeAuth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.ato.gov.au/core2/connect/token
          scopes:
            ato.healthcheck.*.*: Grants ability to access the Healthcheck API
x-refined-from:
- dsg-health-check-v1_10_0_0.yaml
- dsg-smsfaliaslookup-v1-prod_0_0.yaml
- australian-taxation-office-health-check-openapi.yml
- australian-taxation-office-smsf-alias-lookup-openapi.yml