> ## Documentation Index > Fetch the complete documentation index at: https://docs.ya.works/llms.txt > Use this file to discover all available pages before exploring further. # Get company profile > Retrieve the authenticated merchant's company profile. ## OpenAPI ````yaml /openapi.json get /v1/company openapi: 3.1.0 info: title: YV Business API description: >- Public API for YaVendio merchants to access orders, product catalog, conversations, contacts and company profile, and to send WhatsApp template messages. ## Authentication All endpoints require a valid API key sent via the `X-API-Key` header. API keys are created and managed from the [YaVendio Dashboard](https://ya.onl) under **Settings → API Keys**. Use the **Authorize** button above to set your key for all requests. Every endpoint declares the scope it requires (e.g. `orders:read`, `products:write`, `conversations:read`, `contacts:read`, `company:read`, `outbound:send`, `outbound:read`), listed on its reference page. Keys created from the dashboard today carry no scopes and therefore have full access; a key that has scopes but lacks the one an endpoint requires gets `403 Forbidden`. ## Rate Limiting Requests are rate-limited per merchant. Every response includes `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset` headers. Check these headers to know your current limit and remaining quota. When the limit is exceeded, the API responds with `429 Too Many Requests` and adds a `Retry-After` header. ## Pagination List endpoints support pagination via `page` and `limit` query parameters. Responses include a `pagination` object with `total_pages`, `total_items`, and `has_more` fields. Maximum `limit` is 100. version: 1.14.2 servers: - url: https://api.ya.onl security: [] tags: - name: Orders description: Retrieve merchant orders and their details. - name: Products description: CRUD operations on merchant products. - name: Product Variants description: Manage variants of a product. - name: Product Options description: Manage product options. - name: Product Option Values description: Manage individual option values. - name: Product Media description: Manage media files attached to product variants. - name: Categories description: CRUD operations on merchant categories (tags). - name: Product Categories description: Assign and remove categories from products. - name: Catalogs description: Retrieve merchant catalogs. - name: Webhooks description: Manage webhook subscriptions for real-time order events. - name: Conversations description: Read WhatsApp conversations and their messages. - name: Contacts description: Retrieve campaign contacts. - name: Company description: Retrieve the merchant's company profile. - name: Templates description: >- List the WhatsApp templates approved for the merchant, with the variables each one expects. - name: Template Messages description: >- Send approved WhatsApp templates to customers and follow their delivery status. paths: /v1/company: get: tags: - Company summary: Get company profile description: Retrieve the authenticated merchant's company profile. operationId: get_company_v1_company_get responses: '200': description: Successful Response headers: X-RateLimit-Limit: description: Maximum number of requests allowed in the current window schema: type: integer example: 100 X-RateLimit-Remaining: description: Number of requests remaining in the current window schema: type: integer example: 87 X-RateLimit-Reset: description: Unix timestamp when the rate limit window resets schema: type: integer example: 1710288000 content: application/json: schema: $ref: '#/components/schemas/CompanyResponse' '401': description: Invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '403': description: API key lacks the `company:read` scope content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '429': description: Rate limit exceeded headers: X-RateLimit-Limit: description: Maximum number of requests allowed in the current window schema: type: integer example: 100 X-RateLimit-Remaining: description: Number of requests remaining in the current window schema: type: integer example: 87 X-RateLimit-Reset: description: Unix timestamp when the rate limit window resets schema: type: integer example: 1710288000 Retry-After: description: Seconds to wait before making another request schema: type: integer example: 30 content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' security: - APIKeyHeader: [] components: schemas: CompanyResponse: properties: id: type: integer title: Id description: Unique company identifier name: type: string title: Name description: Company name phone_number: anyOf: - type: string - type: 'null' title: Phone Number description: WhatsApp business phone number country: anyOf: - type: string - type: 'null' title: Country description: Company country examples: - PERU currency: anyOf: - type: string - type: 'null' title: Currency description: Default currency code (ISO 4217) examples: - PEN plan_name: anyOf: - type: string - type: 'null' title: Plan Name description: Subscription plan identifier examples: - pro plan_display_name: anyOf: - type: string - type: 'null' title: Plan Display Name description: Subscription plan display name examples: - Pro type: object required: - id - name title: CompanyResponse description: |- Public-safe subset of the merchant's company profile. Internal identifiers (billing, auth, Meta assets) are deliberately excluded from the public API surface. APIErrorResponse: properties: type: type: string title: Type description: Error type identifier, e.g. 'UnauthorizedError' detail: type: string title: Detail description: Human-readable error message type: object required: - type - detail title: APIErrorResponse securitySchemes: APIKeyHeader: type: apiKey description: Merchant API key for authentication in: header name: X-API-Key ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.