> ## Documentation Index > Fetch the complete documentation index at: https://docs.immoteur.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Auth Info > Returns the authenticated user's email and token information as a simple test endpoint. ## OpenAPI ````yaml /immoteur-api-public-v1.spec.yaml get /auth openapi: 3.1.0 info: title: Immoteur Public API version: 1.1.0 description: >- Public API for the Immoteur service. ## Authentication Use a **Personal Access Token** from your Immoteur dashboard and send it in the `Authorization` header: ``` Authorization: Bearer YOUR_TOKEN_HERE ``` ### cURL example ```bash curl -sS https://api.immoteur.com/public/v1/auth \ -H "Authorization: Bearer $IMMOTEUR_TOKEN" ``` ## Environments - **Production:** `https://api.immoteur.com/public/v1` ## Errors & Rate Limiting - `400 Bad Request`: malformed request or invalid syntax. - `401 Unauthorized`: missing or invalid token. - `403 Forbidden`: token valid but not permitted for this resource. - `429 Too Many Requests`: back off and retry with exponential delay. - `422 Validation Error`: payload is syntactically correct but fails validation. ## Pagination - Requests specify `page` (1..500). Responses include `page`, `nextPage`, `perPage`, `total`, `totalPages`. ## Data Access Limits The `meta.dataAccessLimit` block shows **implicit filters** tied to your plan (e.g., whitelisted departments/SIREN/SIRET). Your effective result set equals **your filters ∩ requested filters**. ## Using AI/LLMs - Always include the `Authorization` header. - Prefer explicit filters (departments, INSEE, postcodes) with **existing** French codes/names. - Follow the examples below as canonical payload shapes. ## Contact & Docs - Website: https://immoteur.com - Support: Use your customer portal or contact listed on the website. contact: url: https://immoteur.com name: Immoteur email: support@immoteur.com servers: - url: https://api.immoteur.com/public/v1 description: Production server security: - BearerAuth: [] tags: - name: Info description: Token/account info - name: Property description: Property operations - name: Classified description: Classified operations - name: Issue description: User-submitted issue reports externalDocs: description: Full product documentation url: https://docs.immoteur.com paths: /auth: get: tags: - Info summary: Get Auth Info description: >- Returns the authenticated user's email and token information as a simple test endpoint. operationId: auth responses: '200': description: Authenticated account and token information content: application/json: schema: type: object required: - email - tokenName - tokenCreatedAt - meta properties: email: type: string format: email description: Email address of the authenticated account example: buyer@example.com meta: type: object required: - subscriptionPlan - dataAccessLimit properties: dataAccessLimit: $ref: '#/components/schemas/DataAccessLimit' subscriptionPlan: $ref: '#/components/schemas/SubscriptionPlan' tokenCreatedAt: type: string format: date-time description: Creation date of the token example: '2025-09-01T10:15:30Z' tokenName: type: string description: Name of the current auth token example: prod-ci-key-1 example: email: buyer@example.com tokenCreatedAt: '2025-09-01T10:15:30Z' tokenName: prod-ci-key-1 meta: subscriptionPlan: pro200 dataAccessLimit: departments: - '75' - '92' sirens: - '123456789' sirets: - '12345678900011' '400': $ref: '#/components/responses/BadRequestError' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/RateLimitError' default: $ref: '#/components/responses/DefaultError' components: schemas: DataAccessLimit: description: >- Inner filters applied to your search, see `https://immoteur.com/en/dashboard/billing` type: object required: - departments - sirens - sirets properties: departments: type: array description: Departments implicitly whitelisted for this account. items: type: string example: - '75' - '92' sirens: type: array description: SIREN identifiers implicitly whitelisted for this account. items: type: string example: - '123456789' sirets: type: array description: SIRET identifiers implicitly whitelisted for this account. items: type: string example: - '12345678900011' SubscriptionPlan: type: string description: Active plan that governs rate limits and pagination caps for this token. enum: - enterprise500 - free - growth100 - pro200 - starter30 example: pro200 ProblemDetails: type: object required: - type - title - status - detail - instance - code - traceId properties: code: type: string description: Stable machine-readable error code. example: resource_not_found detail: type: string description: Human-readable explanation specific to this occurrence. example: The requested resource could not be found. instance: type: string description: Request URI identifying the specific occurrence. example: /public/v1/properties/019c12dc-339f-72ce-98db-663b44c0d924 status: type: integer format: int32 minimum: 400 maximum: 599 description: HTTP status code generated for this occurrence. example: 404 title: type: string description: Short, human-readable summary of the problem type. example: Resource not found traceId: type: string format: uuid description: Trace identifier to correlate client errors with server logs. example: b94f4db5-2f5e-4b8f-9dd0-f2fe5c7a7a4f type: type: string format: uri description: URI reference identifying the problem type. example: https://docs.immoteur.com/problems/resource_not_found responses: BadRequestError: description: >- Bad request — the request could not be understood or was missing required information. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' UnauthorizedError: description: Authentication required / invalid token content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' ForbiddenError: description: Authenticated but not allowed for this resource content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' NotFoundError: description: Resource not found content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' RateLimitError: description: Too many requests. Rate limit headers are returned on all responses. headers: RateLimit-Policy: $ref: '#/components/headers/RateLimitPolicy' RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' Retry-After: $ref: '#/components/headers/RateLimitRetryAfter' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' DefaultError: description: Undocumented error content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' headers: RateLimitPolicy: description: Comma-separated policy values ordered as second, minute, day. schema: type: string example: 1;w=1, 20;w=60, 250;w=86400 RateLimitLimit: description: Comma-separated limit values ordered as second, minute, day. schema: type: string example: 1, 20, 250 RateLimitRemaining: description: Comma-separated remaining request counts ordered as second, minute, day. schema: type: string example: 0, 18, 240 RateLimitReset: description: >- Comma-separated seconds until the current windows reset (second, minute, day). schema: type: string example: 1, 45, 8200 RateLimitRetryAfter: description: Seconds to wait before retrying after a rate limit response. schema: type: integer format: int32 minimum: 1 example: 1 securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: Personal Access Token description: |- Send your Immoteur Personal Access Token in the `Authorization` header: `Authorization: Bearer ` You can create and manage your Personal Access Tokens here: https://immoteur.com/dashboard/settings status: current: available ````