> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sendora.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Read workspace settings, the team and billing

> Reads parts of the workspace. include is a comma list of org (default), company_profile, ai_reply, mailing_address, holidays, team (members and invitations), access_catalog (the roles and permissions that exist), member_access (one member's role, grants and limits; needs member_id) and billing.wallet, billing.subscription, billing.usage, billing.usage_daily (days), billing.capacity, billing.credit_summary, billing.credit_activity (limit, before, event_type, channel) and billing.cap. Billing is read only. Requires a Sendora API key.



## OpenAPI

````yaml /openapi.json get /api/v1/public/workspace-settings
openapi: 3.1.0
info:
  description: >-
    Customer-facing API for managing outreach, leads, conversations, voice
    agents, knowledge bases, analytics, and webhooks.
  title: Sendora Public API
  version: 1.0.0
servers:
  - description: Production
    url: https://api.sendora.ai
security: []
tags:
  - description: Leads, lead lists, importing, enriching and finding new prospects.
    name: Leads
  - description: Build, run and measure outreach, and enroll leads.
    name: Campaigns
  - description: Read and send messages, and manage who must not be contacted.
    name: Conversations
  - description: >-
      Voice and chat agents, their tools, knowledge bases, voices and website
      widgets.
    name: Agents
  - description: >-
      Start calls, and manage phone numbers, SMS registration, sending accounts
      and email domains.
    name: Calls and numbers
  - description: Webhooks, jobs, analytics and the Copilot assistant.
    name: Platform
  - description: Manage client workspaces, plans and branding.
    name: Agency
paths:
  /api/v1/public/workspace-settings:
    get:
      tags:
        - Platform
      summary: Read workspace settings, the team and billing
      description: >-
        Reads parts of the workspace. include is a comma list of org (default),
        company_profile, ai_reply, mailing_address, holidays, team (members and
        invitations), access_catalog (the roles and permissions that exist),
        member_access (one member's role, grants and limits; needs member_id)
        and billing.wallet, billing.subscription, billing.usage,
        billing.usage_daily (days), billing.capacity, billing.credit_summary,
        billing.credit_activity (limit, before, event_type, channel) and
        billing.cap. Billing is read only. Requires a Sendora API key.
      operationId: read_settings_api_v1_public_workspace_settings_get
      parameters:
        - description: >-
            Comma list: org, company_profile, ai_reply, mailing_address,
            holidays, consents (read only), team, access_catalog, member_access,
            billing.wallet, billing.subscription, billing.usage,
            billing.usage_daily, billing.capacity, billing.credit_summary,
            billing.credit_activity, billing.cap
          in: query
          name: include
          required: false
          schema:
            default: org
            description: >-
              Comma list: org, company_profile, ai_reply, mailing_address,
              holidays, consents (read only), team, access_catalog,
              member_access, billing.wallet, billing.subscription,
              billing.usage, billing.usage_daily, billing.capacity,
              billing.credit_summary, billing.credit_activity, billing.cap
            title: Include
            type: string
        - description: 'member_access: the team member''s `id`, from include=team'
          in: query
          name: member_id
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: 'member_access: the team member''s `id`, from include=team'
            title: Member Id
        - description: 'billing.usage_daily: how many days'
          in: query
          name: days
          required: false
          schema:
            default: 30
            description: 'billing.usage_daily: how many days'
            maximum: 365
            minimum: 1
            title: Days
            type: integer
        - description: 'billing.credit_activity: rows'
          in: query
          name: limit
          required: false
          schema:
            default: 50
            description: 'billing.credit_activity: rows'
            maximum: 100
            minimum: 1
            title: Limit
            type: integer
        - description: 'billing.credit_activity: the next_before from the previous page'
          in: query
          name: before
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: 'billing.credit_activity: the next_before from the previous page'
            title: Before
        - description: 'billing.credit_activity: filter by type'
          in: query
          name: event_type
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: 'billing.credit_activity: filter by type'
            title: Event Type
        - description: 'The channel: email, linkedin, whatsapp or phone.'
          in: query
          name: channel
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: 'billing.credit_activity: filter by channel'
            title: Channel
        - in: header
          name: X-API-Key
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
        - in: header
          name: Authorization
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
      responses:
        '200':
          content:
            application/json:
              schema:
                title: Response Read Settings Api V1 Public Workspace Settings Get
                type: object
          description: Successful Response
        '401':
          description: The X-API-Key header is missing, invalid, expired, or revoked.
        '402':
          description: >-
            The workspace is suspended for billing, or the request would exceed
            a plan or usage limit.
        '403':
          description: >-
            The key is valid but lacks the required scope, or the workspace has
            no active plan, lacks the entitlement, or has this feature turned
            off or view-only.
        '410':
          description: The workspace behind this key has been deleted.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        '500':
          description: >-
            An unexpected Sendora error occurred. Retry only if the operation is
            safe to repeat.
        '503':
          description: >-
            An entitlement or billing check is temporarily unavailable. Retry
            after the Retry-After interval.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - label: cURL
          lang: bash
          source: >-
            curl -X GET
            'https://api.sendora.ai/api/v1/public/workspace-settings' -H
            "X-API-Key: $SENDORA_API_KEY"
        - label: Python
          lang: python
          source: |-
            import requests

            url = 'https://api.sendora.ai/api/v1/public/workspace-settings'
            headers = {'X-API-Key': '$SENDORA_API_KEY'}
            response = requests.get(url, headers=headers)
            response.raise_for_status()
            print(response.json())
        - label: JavaScript
          lang: javascript
          source: >-
            const response = await
            fetch("https://api.sendora.ai/api/v1/public/workspace-settings", {
              method: "GET",
              headers: { 'X-API-Key': process.env.SENDORA_API_KEY },
            });

            if (!response.ok) throw new Error(await response.text());

            console.log(await response.json());
        - label: Go
          lang: go
          source: >-
            req, err := http.NewRequest("GET",
            "https://api.sendora.ai/api/v1/public/workspace-settings", nil)

            if err != nil { log.Fatal(err) }

            req.Header.Set("X-API-Key", os.Getenv("SENDORA_API_KEY"))

            resp, err := http.DefaultClient.Do(req)

            if err != nil { log.Fatal(err) }

            defer resp.Body.Close()
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          description: Detail returned by the Sendora API.
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      required: []
      title: HTTPValidationError
      type: object
    ValidationError:
      properties:
        loc:
          description: Loc returned by the Sendora API.
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          description: Msg returned by the Sendora API.
          title: Message
          type: string
        type:
          description: Type returned by the Sendora API.
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: Customer API key created in the Sendora dashboard.
      in: header
      name: X-API-Key
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.