---
title: "Attempts to ping the API"
method: GET
path: "/api/v1/ping"
tags: ["ping"]
---

# Attempts to ping the API

`GET /api/v1/ping`

## Request

- Base URL: `https://demo.invoiceninja.com`
- URL: `https://demo.invoiceninja.com/api/v1/ping`
- Auth: none declared. Required headers: `X-Requested-With`
- TypeScript: <https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/docs/api/v1/ping/get.ts> (a function with typed inputs; its response is checked against the schema)

Attempts to ping the API

## Headers

- `X-Requested-With` string, required

## Response `200`

The company and user name

## Other responses

- `401`: Authentication error

## Changes

- **2026-02-09** `c85938f55efd`: 1 info
  - added the non-success response with the status `401`
- **2024-01-24** `9dab078a46b5`: 1 info
  - endpoint added
- **2024-01-20** `70cd94370516`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/changes/api/v1/ping/get.md)

---

[API](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference.md) - [All operations](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/revisions/bcda1f823746?raw)