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

# Get org settings

> Returns the current organization's settings, plan, limits, custom domain, and updatable meta.

Get the current org's settings, plan, limits, and meta



## OpenAPI

````yaml /api-reference/specs/org.json get /api/org
openapi: 3.1.0
info:
  title: ConveYour API — Org
  description: >-
    Read and update the current organization's settings, limits, plan, and
    billing.
  version: 1.0.0
servers:
  - url: https://{subdomain}.conveyour.com
    description: Your organization's ConveYour instance
    variables:
      subdomain:
        default: acme
        description: >-
          Your organization's slug — the subdomain you sign in on. Replace
          `acme` with yours: if you sign in at `bigco.conveyour.com`, enter
          `bigco`.
security:
  - conveyourToken: []
tags:
  - name: Org
    description: >-
      Read and update the current organization's settings, limits, plan, and
      billing.
paths:
  /api/org:
    get:
      tags:
        - Org
      summary: Get org settings
      description: >-
        Returns the current organization's settings, plan, limits, custom
        domain, and updatable meta.


        Get the current org's settings, plan, limits, and meta
      operationId: getTheCurrentOrgSSettingsPlanLimitsAndMeta
      parameters:
        - name: sudo
          in: query
          description: >-
            When `true` and the caller has an elevated (sudo) session, returns
            the org's full raw meta object instead of just the user-updatable
            meta keys.
          schema:
            type: boolean
        - $ref: '#/components/parameters/teams'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/OrgSettings'
              example:
                status: ok
                message: success
                data:
                  name: Acme Inc
                  cg_style: ''
                  cg_highlight: '#2b8aff'
                  plan: {}
                  limits:
                    campaigns: 100
                    automations: 100
                    groups: 100
                    sms_registration: 0
                    emails: 50000
                    users: 10
                    contacts: 25000
                    mal: 0
                    locations: 0
                    onboardees: 0
                    sms: 50000
                    video_upload: 0
                    portal_search: 0
                    workflows: 0
                    workflow_size: 0
                    teams: 0
                    custom_objects: 0
                    custom_records: 0
                    form_collections: 0
                    form_records: 0
                  custom_domain: app.acme.com
                  custom_domain_ssl: 1
                  trial_end: null
                  meta:
                    logo: ''
                    icon: ''
                    timezone: America/New_York
                    portal_auth:
                      type: ''
                  public_encryption_key: ''
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  parameters:
    teams:
      name: teams[]
      in: query
      description: >-
        Team scope for the request, as one or more team ObjectIds. The brackets
        are required: PHP keeps only the last value for a repeated plain key, so
        `teams=A&teams=B` silently resolves to B alone. On requests with a JSON
        body you may send `teams` (no brackets) in the body instead.


        **Values that are not valid ObjectIds are silently ignored** — a
        mistyped team ID behaves as if no team was sent. See the [teams section
        of the API conventions guide](/guides/api-conventions#team-scoping).
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
      example:
        - 64a1b2c3d4e5f6a7b8c9d0ff
  schemas:
    Envelope:
      type: object
      description: The common response envelope shared by all ConveYour endpoints.
      properties:
        status:
          type: string
          enum:
            - ok
            - failed
          description: '`ok` on success, `failed` on error.'
        message:
          type: string
          description: Human-readable description of the result.
        data:
          description: >-
            The response payload — an object or an array depending on the
            endpoint.
    OrgSettings:
      type: object
      description: Organization settings. Builds this literal — it is not the Org record.
      properties:
        name:
          type: string
          description: Organization name.
        cg_style:
          type: string
          description: Contact-grid style setting.
        cg_highlight:
          type: string
          description: Contact-grid highlight setting.
        plan:
          type: object
          description: Plan overview, from planOverview()->getPlanData().
        limits:
          type: object
          description: Plan limits.
        custom_domain:
          type: string
          description: Custom domain, or an empty string when none is set.
        custom_domain_ssl:
          type: integer
          description: SSL state for the custom domain; 0 when unset.
        trial_end:
          type:
            - string
            - 'null'
          description: Trial end date, when on trial.
        meta:
          type: object
          description: >-
            Org meta. Normally only the user-updatable keys; a sudo user passing
            sudo=true instead receives the full meta with blocked keys removed,
            plus portal_sections.
        public_encryption_key:
          type: string
          description: The org public encryption key.
  responses:
    Forbidden:
      description: >-
        The token is missing or invalid, or the service account behind it lacks
        the permission this endpoint requires.
      content:
        application/json:
          example:
            status: failed
            message: Lacking necessary permission add_contacts
            data:
              permission: add_contacts
  securitySchemes:
    conveyourToken:
      type: apiKey
      in: header
      name: x-conveyour-token
      description: >-
        Your API key token. Contacts endpoints require a **Server-only — Full
        API** key — see [Authentication](/quickstart).

````

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