# Get the hosted sign-in page configuration for an organization

Returns the org's auth page config (branding, waitlist screens) with per-request facts such as whether sign-up is open, the sign-up mode, the captcha and...

`GET /api/v1/auth/config`

- 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).

Returns the org's auth page config (branding, waitlist screens) with per-request facts such as whether sign-up is open, the sign-up mode, the captcha and bot-protection public settings, the client's own branding and the white-label entitlement. Creates the org's default auth config on first read when none exists.

## 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/config?org=YOUR_ORG_ID"
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/auth/config?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/config?org=YOUR_ORG_ID",
    timeout=30,
)
response.raise_for_status()
data = response.json()
```

## Responses

### 200 OK

OK

```json title="Example"
{
  "appName": "Acme & Co",
  "betaConfigData": {
    "approvalEmail": false,
    "screen": {
      "register": {
        "description": "Register with your email for beta access",
        "title": "Register to Beta Users"
      },
      "thankYou": {
        "description": "You have successfully registered for beta access.",
        "title": "Thank You for Registering"
      }
    }
  },
  "botProtection": {
    "mode": "off"
  },
  "branding": {},
  "client": {
    "copy": {
      "byLocale": {
        "de": {
          "login": {
            "title": {
              "from": "Use your work email",
              "text": "Mit Ihrer Firmen-E-Mail anmelden"
            }
          }
        }
      },
      "words": {
        "login": {
          "description": "Staff only. Ask IT if you cannot get in.",
          "title": "Use your work email"
        }
      }
    },
    "name": null
  },
  "copyByLocale": {
    "es": {
      "consent": {
        "label": {
          "from": "Yes, Acme may use cookies to measure its ads.",
          "text": "Sí, Acme puede usar cookies para medir los anuncios."
        }
      },
      "login": {
        "title": {
          "from": "",
          "text": "Inicia sesión para continuar"
        }
      }
    },
    "fr": {
      "login": {
        "title": {
          "from": "",
          "text": "Connectez-vous pour continuer"
        }
      }
    }
  },
  "isBetaEnabled": false,
  "logo": null,
  "logoFallBack": null,
  "name": "Acme & Co",
  "orgId": "000000000000000000000001",
  "privacyPolicy": null,
  "screen": {
    "login": {
      "description": "Fast <3 \"really\"",
      "title": "Sign in to {app} & friends"
    }
  },
  "security": {
    "accountDeletionGraceDays": 7
  },
  "shortName": "Acme & Co",
  "signupCaptcha": null,
  "signupMode": "open",
  "signupOpen": true,
  "smallName": "BuildBase Auth",
  "supportUrl": null,
  "termsOfService": "https://acme.test/terms",
  "username": {
    "enabled": false,
    "required": false
  },
  "websiteUrl": null,
  "whiteLabel": false
}
```

### 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.config.list` in [public-v1.json](https://docs.buildbase.app/openapi/public-v1.json)
