> For the complete documentation index, see [llms.txt](https://academy.synap.ac/organisation-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://academy.synap.ac/organisation-api/api-reference/status.md).

# /status

## Status

<mark style="color:blue;">`GET`</mark> `https://api-org.synap.ac/status`

This method allows you to test if your connection is configured properly

#### Headers

| Name             | Type   | Description                                                    |
| ---------------- | ------ | -------------------------------------------------------------- |
| x-api-key        | string | Your API usage token.                                          |
| x-syn-org-id     | string | Your organisation's identifier on Synap                        |
| x-syn-org-secret | string | Your organisation's secret key, used to authorise each request |

{% tabs %}
{% tab title="200 " %}

```
{ "status": "healthy", "timestamp": string}
```

{% endtab %}

{% tab title="401 " %}

```
{  "code": 401, "error": "Unauthorised request." }
```

{% endtab %}

{% tab title="404 Your organisation identifier does not exist on our system" %}

```
{ "code": 404, "error": "Object not found."}
```

{% endtab %}
{% endtabs %}

#### Examples

{% tabs %}
{% tab title="cURL Request" %}

```typescript
curl --request GET \
  --url https://api-org.synap.ac/status \
  --header 'x-syn-org-id: org123test' \
  --header 'x-syn-org-secret: secret123test' \
  --header 'x-api-key: test123api' \
```

{% endtab %}

{% tab title="Response" %}

```typescript
200 OK
{
  "status": "healthy",
  "timestamp": "2020-03-30T10:05:16.754Z"
}

--

403 Forbidden
{
  "code": 403,
  "error": "Unauthorised request."
}

--

404 Not Found
{ 
  "code": 404, 
  "error": "Object not found."
}
```

{% endtab %}
{% endtabs %}