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

# Profile Details

> Retrieve the current workspace profile details including plan information and settings.



## OpenAPI

````yaml en-openapi POST /profile
openapi: 3.0.0
info:
  description: >-
    The Pubrio API is used to search, preview and enrich Contacts and Accounts.
    Pubrio database provides extensive B2B contacts and sales intelligence data.
  version: 1.0.0
  title: Pubrio OpenAPI
  termsOfService: https://pubrio.com/en/terms-of-service
  contact:
    email: king.lai@pubrio.com
    name: King Lai
    url: https://pubrio.com/en/get-in-touch
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: https://api.pubrio.com
security:
  - pubrio_api_key: []
tags:
  - name: Profile
    description: Workspace profile information and usage statistics
  - name: Enrichment
    description: Enrich people and company records with detailed B2B data
  - name: Lookalike
    description: Find companies similar to a given company
  - name: Search
    description: Search for people, companies, jobs, news, and advertisements with filters
  - name: Lookup
    description: >-
      Look up detailed information for specific people, companies, jobs, news,
      advertisements, and technologies
  - name: LinkedIn
    description: Look up people and company data via LinkedIn profile URLs
  - name: Redeem
    description: Redeem credits to unlock people contact details (single and batch)
  - name: Channels
    description: Manage outreach channel templates (create, update, delete, list)
  - name: Monitor
    description: Create and manage data monitors with webhooks, statistics, and processing
  - name: Filters
    description: >-
      Retrieve available filter values for search parameters (technologies,
      locations, verticals, etc.)
externalDocs:
  description: >-
    The Pubrio API is used to search, preview and enrich Contacts and Accounts.
    Pubrio database provides extensive B2B contacts and sales intelligence data.
  url: https://docs.pubrio.com
paths:
  /profile:
    post:
      tags:
        - Profile
      summary: Get workspace profile
      description: >-
        Retrieve the current workspace profile details including plan
        information and settings.
      operationId: profile_get
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                profile_id:
                  $ref: '#/components/schemas/profile_id'
      responses:
        '200':
          description: Successful response containing profile details.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/data'
              example:
                data:
                  profile_id: 1
                  credit: 457499
                  topup_credit: 235237
                  name: Pubrio
                  description: null
                  is_auto_top_up_credits_enabled: false
                  auto_top_up_credit: 2500
                  auto_top_up_balance_fall_below: 500
                  subscription:
                    id: 7
                    credit: 2250
                    max_api_monthly_query: 0
                    max_api_daily_query: 0
                    max_api_hourly_query: 0
                    is_not_able_to_subscribe: false
                    max_portal_monthly_query: 60000
                    max_portal_daily_query: 2000
                    max_portal_hourly_query: 1000
                    amount: 59
                    is_custom_plan: false
                    currency_id: 14
                    currency: usd
                    topup_credit_amount: 0.035
                    name: Business - Annual Subscription
                    slug: business-annual
                    collection: business
                    is_annual: true
                    is_default: null
                    identifier: 2618b67a-cc4d-4fd1-bbe8-f906e4f6632d
                    last_charged: '2024-11-09T03:40:41.995Z'
                    next_charge_date: '2025-11-09T03:40:41.995Z'
                    last_usage_charged: '2024-10-30T15:01:54.895Z'
                    next_usage_charge_date: '2024-11-13T15:01:54.895Z'
                    last_refill_date: '2024-11-09T03:40:41.995Z'
                    next_refill_date: '2024-12-09T03:40:41.995Z'
                    usage_charge_period: 2
                    usage_charge_period_type: week
                    charge_period: 12
                    charge_period_type: month
                    web_intent_signal_credit: 25
                    max_search_page: 100
                    max_search_per_page: 25
                    phone_number_redeem_credit: 30
                    email_redeem_credit: 15
                    people_search_credit: 3
                    company_search_credit: 1
                    data_export_credit: 1
                    max_session_per_page: 100
                    max_export_limit: 25000
                    max_select_limit: 5000
                    max_record_upload_size: 100000
                    max_company_search_select_limit: 1000
                    max_people_search_select_limit: 25
                    max_channel_email_account: 1
                    max_channel_linkedin_account: 1
                    max_channel_slack_account: 0
                    is_full_export_available: true
                    is_api_access_available: false
                    is_add_user_available: true
                    is_refill_without_charge: false
                    is_skip_user_related_calculation: false
                    is_credit_rollover_available: false
                    is_quota_sharing_available: true
                    last_modified: '2024-11-09T03:40:41.995Z'
                    total_credit_used: 7025
                    total_charge_credit: 7000
                    credit_refill: 459000
                    total_amount: 8988
                    products:
                      - currency_id: 14
                        currency: usd
                        waived_quantity: 6
                        is_full_waived: false
                        id: 3
                        name: Additional User Licence
                        slug: additional-user-licence
                        quantity: 16
                        amount: 59
                        prorated_amount: 11328
                        metadata:
                          next_charge_date: '2025-11-09T03:40:41.995Z'
                          is_annual: true
                          charge_period: 12
                          charge_period_type: month
                          total_used_subscription: 16
                          total_user_subscriptions: 33
                        total_amount: 7080
                      - currency_id: 14
                        currency: usd
                        waived_quantity: 0
                        is_full_waived: false
                        id: 5
                        name: Profile Subscription
                        slug: profile-subscription
                        quantity: 1
                        amount: 59
                        prorated_amount: 708
                        metadata:
                          next_charge_date: '2025-11-09T03:40:41.995Z'
                          is_annual: true
                          charge_period: 12
                          charge_period_type: month
                        total_amount: 708
                    usage_products:
                      - currency_id: 14
                        currency: usd
                        waived_quantity: 1
                        is_full_waived: false
                        id: 2
                        name: Website Intent Data
                        slug: website-intent-data
                        quantity: 281
                        amount: 0.88
                        prorated_amount: 245.88
                        metadata:
                          web_intent_signal_credit: 25
                          topup_credit_amount: 0.035
                        total_amount: 245
                        total_credit_used: 7025
                        total_charge_credit: 7000
        '400':
          $ref: '#/components/responses/general_error'
        '429':
          $ref: '#/components/responses/rate_limit_error'
        '500':
          $ref: '#/components/responses/server_error'
components:
  schemas:
    profile_id:
      type: integer
      description: >-
        Optional. An identifier for the user profile (workspace) making the
        request. This is no longer required as the API key already includes your
        workspace information. If provided, it helps in associating the lookup
        with a specific user, allowing for data retrieval and credit tracking. 

         Check out `user details` endpoints under the Profile tab for more information.
    data:
      type: object
      nullable: true
      description: Response info depends on specific endpoint.
  responses:
    general_error:
      description: >-
        Bad request. The request was malformed or contained invalid parameters.
        Check the error code and message for details.
      content:
        application/json:
          schema:
            required:
              - code
              - message
              - details
            type: object
            properties:
              code:
                example: 40001
                type: integer
              message:
                example: >-
                  Errors and codes will vary depending on the scenario, please
                  see the documentation for information.
                type: string
              details:
                type: object
    rate_limit_error:
      description: >-
        Rate limit exceeded. Too many requests were made in a given time period.
        Retry after the rate limit window resets.
      content:
        application/json:
          schema:
            required:
              - error
            type: object
            properties:
              error:
                example: Request rate limit exceeded. Please wait and try again later.
                type: string
    server_error:
      description: >-
        Internal server error. An unexpected error occurred on the server.
        Contact support if the error persists.
      content:
        application/json:
          schema:
            required:
              - error
            type: object
            properties:
              error:
                example: An unexpected error occurred on the server.
                type: string
  securitySchemes:
    pubrio_api_key:
      type: apiKey
      name: pubrio-api-key
      description: >-
        A unique API token that represents the actions you perform through the
        API and the corresponding permissions and operations. You can create it
        through the [Settings](https://dashboard.pubrio.com/#/settings/)
        section.
      in: header

````