> ## Documentation Index > Fetch the complete documentation index at: https://docs.lobbystack.com/llms.txt > Use this file to discover all available pages before exploring further. # Get the partner > The partner the key acts as: its name, domains and tier. pool says what its businesses used of the pool they share this month, when the key also holds partner.billing:read. ## OpenAPI ````yaml /api-reference/openapi.json get /partner openapi: 3.1.0 info: title: LobbyStack API version: v1 description: >- Read calls, contacts, appointments and messages, book appointments, and subscribe to webhooks. Authenticate with an API key in the Authorization header. A platform key also names the business it acts on in the LobbyStack-Business header. Each key allows 120 requests per minute by default. servers: - url: https://app.lobbystack.com/api/v1 security: - bearerAuth: [] tags: - name: Business - name: Receptionist - name: Agents - name: Billing - name: Phone numbers - name: Onboarding - name: Team - name: Website chat - name: Calendars - name: Notifications - name: Calls - name: Contacts - name: Appointments - name: Messages - name: Knowledge - name: Webhooks - name: Platform - name: Partner paths: /partner: get: tags: - Partner summary: Get the partner description: >- The partner the key acts as: its name, domains and tier. pool says what its businesses used of the pool they share this month, when the key also holds partner.billing:read. operationId: getPartner responses: '200': description: OK content: application/json: schema: type: object required: - data properties: data: $ref: '#/components/schemas/Partner' '400': description: The request is invalid (invalid_request). content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: The API key is missing, invalid, or revoked (unauthorized). content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: >- Refused. insufficient_scope: the key lacks the partner:read scope. forbidden: only a partner's platform keys can call this endpoint, or what only the partner's owners may do. key_owner_inactive: the person the key acts for can't any more: a per-business key's creator is no longer an owner or admin, or a platform key's owner_email has no verified LobbyStack account. content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: >- Too many requests (rate_limited). Wait for the Retry-After header's number of seconds. content: application/json: schema: $ref: '#/components/schemas/Error' headers: Retry-After: schema: type: integer description: Seconds to wait. security: - bearerAuth: [] components: schemas: Partner: type: object properties: id: type: string format: uuid description: Stable identifier (UUID). name: type: string slug: type: string subdomain: description: >- The partner's subdomain under the deployment's partner domain, such as acme.receptionistportal.com, or null for none. type: - string - 'null' custom_domain: description: The partner's own domain once it's active, or null. type: - string - 'null' dashboard_url: description: >- Where the partner's businesses open their dashboard: its own domain once active, else its subdomain. Null for neither. type: - string - 'null' tier: type: object properties: billed: type: boolean description: Whether this deployment bills partners for tiers. slug: type: string enum: - free - starter - growth - scale interval: anyOf: - type: string enum: - monthly - annual - type: 'null' required: - billed - slug - interval additionalProperties: false pool: anyOf: - type: object properties: period: type: string description: The month, YYYY-MM, in UTC. voice_seconds_limit: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Voice seconds the partner's businesses share this month, or null for no limit. chats_limit: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Chats they share this month, or null for no limit. voice_seconds_used: type: integer minimum: -9007199254740991 maximum: 9007199254740991 chats_used: type: integer minimum: -9007199254740991 maximum: 9007199254740991 overage_spend_cents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- What overage past the pool costs so far this month, in US cents. required: - period - voice_seconds_limit - chats_limit - voice_seconds_used - chats_used - overage_spend_cents additionalProperties: false - type: 'null' description: >- What the businesses used of the pool they share this month. Null when nothing limits the pool, or when the key lacks partner.billing:read. required: - id - name - slug - subdomain - custom_domain - dashboard_url - tier - pool additionalProperties: false description: The partner the platform key acts as. Error: type: object properties: error: type: object properties: code: type: string enum: - invalid_request - unauthorized - forbidden - insufficient_scope - not_found - conflict - idempotency_key_reused - idempotency_request_in_progress - booking_disabled - booking_requires_confirmation - slot_unavailable - rate_limited - rate_limit_unavailable - method_not_allowed - internal_error - business_required - key_owner_inactive - plan_limit_reached - phone_numbers_unavailable message: type: string details: type: array items: type: object properties: path: type: string message: type: string required: - path - message additionalProperties: false required: - code - message additionalProperties: false required: - error additionalProperties: false securitySchemes: bearerAuth: type: http scheme: bearer description: >- An API key from Settings > API keys (lsk_...), which acts on its own business, or a platform key from the PLATFORM_API_KEYS setting (lsp_...), which onboards and manages businesses. Scopes: business:read, business:write, calls:read, contacts:read, contacts:write, appointments:read, appointments:write, messages:read, knowledge:read, knowledge:write, webhooks:manage, billing:manage, phone_numbers:manage, team:manage, businesses:create, users:create, phone_numbers:purchase, partner:read, partner.businesses:write, partner.demos:write, partner.packages:write, partner.branding:write, partner.templates:write, partner.team:write, partner.billing:read, partner.billing:write. Only platform keys can hold businesses:create and users:create, and only a key a partner made in its console can hold the partner scopes, which the Partner endpoints use. Only a partner's owners grant partner.billing:read and partner.billing:write. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.