# Get the tracking settings for the current hosted sign-in

Needs the auth state header (401 without a client in it).

`GET /api/v1/auth/tracking`

- Sign-in: No credential. Name the organization with the hosted sign-in state header or the org query parameter.
- Rate limit: Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted).

Needs the auth state header (401 without a client in it). Returns the org and client ids, the org's sign-in hosts, the visitor's cookie consent and analytics identity carried from the app, and the consent prompt setting.

## Request

This operation takes no parameters and no body.

## Example request

Replace each `YOUR_...` value with your own.

```bash title="cURL"
curl -X GET "https://api.console.buildbase.app/api/v1/auth/tracking?org=YOUR_ORG_ID"
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/auth/tracking?org=YOUR_ORG_ID',
  {
    method: 'GET',
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();
```

```python title="Python"
import requests

response = requests.get(
    "https://api.console.buildbase.app/api/v1/auth/tracking?org=YOUR_ORG_ID",
    timeout=30,
)
response.raise_for_status()
data = response.json()
```

## Responses

### 200 OK

OK

```json title="Example"
{
  "data": {
    "clientId": "tM2dJvpRsAzDaTbQpl3zQJcemZdfDJzqSta4imqI",
    "consent": {
      "analytics": true,
      "marketing": true
    },
    "consentPrompt": {
      "enabled": true
    },
    "identity": null,
    "orgId": "000000000000000000000001",
    "ownDomain": null,
    "ownHosts": [],
    "sharedHost": "localhost:4103"
  },
  "success": true
}
```

### Any other status

Any other answer the handler sends itself (its own refusals). Not described yet.

## Errors

Each refusal, what it means, and what to do. The request changed nothing.

### 401 Unauthorized

**What it means:** The credential is missing, expired or not accepted here, or the caller's role has no grant for `x-permission` (refused with 401 too). The body is the plain text `Unauthorized`, or a JSON body with a `code` where the gate says why.

**What to do:** Send the credential this operation asks for (see Sign-in above), or sign in again if it expired. A valid credential is also refused when the role has no grant for the permission above.

```text title="Example"
Unauthorized
```

### 429 Too Many Requests

**What it means:** A rate limit in `x-rateLimit` was reached. `retryAfter` and the `Retry-After` header say how many seconds until the window resets.

**What to do:** Wait the number of seconds in the `Retry-After` header (also `retryAfter` in the body), then retry. Slow down repeated calls.

```json title="Example"
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}
```

## Related

- [Auth guide](/authentication/overview): how this part of BuildBase works
- [All Auth operations](/http-api/reference/auth)
- [API reference](/http-api/reference): every operation, by tag
- [Sign-in and credentials for the HTTP API](/http-api/authentication)
- [How the HTTP API reports errors](/http-api/errors)
- [Make your first call](/http-api/first-call)
- [Error codes](/reference/error-codes): every `code` the API returns
- OpenAPI: operation `auth.tracking.list` in [public-v1.json](https://docs.buildbase.app/openapi/public-v1.json)
