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

# Read the project

> GET /project on the WISEPIM Public API: the bound project's name, status, locales, industry and live product count. Requires project:read.



## OpenAPI

````yaml openapi.json GET /api/public/v1/project
openapi: 3.1.0
info:
  title: WISEPIM Public API
  version: 1.0.0
  description: >-
    Read and update your WisePIM catalogue from your own systems. Authenticate
    with `Authorization: Bearer wpk_…`; create keys under Settings → API keys.
    Each key is bound to one project and to the scopes it was created with.
  summary: >-
    Read and update a WISEPIM project's products, categories and attributes from
    your own systems.
  termsOfService: https://wisepim.com/terms
  contact:
    name: WISEPIM support
    url: https://wisepim.com/contact
    email: info@wisepim.com
  x-logo:
    url: >-
      https://docs.wisepim.com/logo/wisepim-logo-horizontal-transparant-lightmode.png
    altText: WISEPIM
servers:
  - url: https://wisepim.com
    description: Production. Every path below already starts with /api/public/v1.
security:
  - ProjectApiKeyAuth: []
tags:
  - name: Key and project
    description: Check which key you are calling with and read the project it is bound to.
  - name: Products
    description: >-
      Read, create and update products. Reads need products:read, writes need
      products:write.
  - name: Categories
    description: >-
      Read the project's categories as a flat list with parent ids. Needs
      categories:read.
  - name: Attributes
    description: Read the project's attribute definitions. Needs attributes:read.
externalDocs:
  description: WISEPIM API reference and guides
  url: https://docs.wisepim.com/en/api-reference/introduction
paths:
  /api/public/v1/project:
    get:
      tags:
        - Key and project
      summary: Read the project
      description: |-
        The project the key is bound to: identity, status, locales, industry
        and the live product count. Requires `project:read`.
      operationId: public_v1_get_project
      parameters: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectOut'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
      security:
        - ProjectApiKeyAuth: []
components:
  schemas:
    ProjectOut:
      properties:
        id:
          title: Id
          type: integer
        name:
          title: Name
          type: string
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        status:
          title: Status
          type: string
        primary_locale:
          title: Primary Locale
          type: string
        available_locales:
          items:
            type: string
          title: Available Locales
          type: array
        primary_industry:
          anyOf:
            - type: string
            - type: 'null'
          title: Primary Industry
        product_count:
          title: Product Count
          type: integer
        created_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Created At
      required:
        - id
        - name
        - status
        - primary_locale
        - available_locales
        - product_count
      title: ProjectOut
      type: object
    ErrorOut:
      description: |-
        The shared error envelope every NinjaAPI instance renders.

        `code` is present for :class:`user_app.ninja_api.errors.ApiError`
        (`insufficient_scope`, `rate_limited`, `invalid_cursor`, …) so machine
        clients can branch without parsing `error`.
      properties:
        error:
          title: Error
          type: string
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
        request_id:
          title: Request Id
          type: string
      required:
        - error
        - request_id
      title: ErrorOut
      type: object
  securitySchemes:
    ProjectApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: Project API key (wpk_...)
      description: >-
        Send a project API key as `Authorization: Bearer wpk_...`. Create keys
        under Settings > API Access in the WISEPIM app (project owners and
        admins). A key is bound to one project and to the scopes chosen when it
        was created; scopes cannot be widened afterwards. Scopes: `project:read`
        - Read the project's name, languages, industry and limits.;
        `products:read` - List and read products, including attribute values and
        category ids.; `products:write` - Create and update products: names,
        descriptions, identifiers, prices, SEO fields, categories and attribute
        values.; `categories:read` - List and read the project's category tree.;
        `attributes:read` - List and read the project's attribute definitions.
      x-scopes:
        project:read: Read the project's name, languages, industry and limits.
        products:read: List and read products, including attribute values and category ids.
        products:write: >-
          Create and update products: names, descriptions, identifiers, prices,
          SEO fields, categories and attribute values.
        categories:read: List and read the project's category tree.
        attributes:read: List and read the project's attribute definitions.

````

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