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

# Get the team

> The store's teams, each with its `permissions`, how many of them are `sensitive`, the parts of the dashboard it `reach`es, its `people` and how many invites are `waiting`; every `invite` not yet taken up; the store's `owner`, who is on no team and can do everything; and `permissions`, every permission there is in its `groups`, each with its `label`, what it lets a person do (`about`), whether it is `sensitive` and what it `needs`, and the `presets` a team can start from. `limits` says how many teams a store and people a team may have (10 and 30, invites not yet taken up counted among the people), how long a team's `name` may be, how many addresses one invite takes (`perInvite`) and how many days an invite lasts (`inviteDays`).

Needs the `team.read` permission (Read the Team).



## OpenAPI

````yaml /api-reference/openapi.json get /stores/{storeId}/team
openapi: 3.1.0
info:
  title: Shoply API
  version: '1'
  description: >-
    Everything a store's own server can do with a secret API key: its catalogue,
    orders, customers, marketing, finance and the rest of what the dashboard
    does. And the Customer API, which a buyer's own device asks with a token of
    theirs.
servers:
  - url: https://api.shoply.gg/v1
security:
  - apiKey: []
tags:
  - name: API key
  - name: Store
  - name: Domain
  - name: Payment methods
  - name: Analytics
  - name: Storefronts
  - name: Storefront code
  - name: Payment Routing
  - name: Custom payment methods
  - name: Products
  - name: Product pictures
  - name: Stock
  - name: Categories
  - name: Upsells
  - name: Subscriptions
  - name: Orders
  - name: Invoices
  - name: Reviews
  - name: Coupons
  - name: Coupon categories
  - name: Coupon pop-up
  - name: Sales
  - name: Blog
  - name: Search settings
  - name: Redirects
  - name: Sitemap
  - name: Cart Recovery
  - name: Email Marketing
  - name: Email Templates
  - name: Customers
  - name: Affiliates
  - name: Support Tickets
  - name: Teams
  - name: Blacklist
  - name: Fraud protection
  - name: Disputes
  - name: Finance
  - name: Tax
  - name: Expenses
  - name: Expense setup
  - name: API requests
  - name: Webhook endpoints
  - name: Webhook deliveries
  - name: Customer API
paths:
  /stores/{storeId}/team:
    get:
      tags:
        - Teams
      summary: Get the team
      description: >-
        The store's teams, each with its `permissions`, how many of them are
        `sensitive`, the parts of the dashboard it `reach`es, its `people` and
        how many invites are `waiting`; every `invite` not yet taken up; the
        store's `owner`, who is on no team and can do everything; and
        `permissions`, every permission there is in its `groups`, each with its
        `label`, what it lets a person do (`about`), whether it is `sensitive`
        and what it `needs`, and the `presets` a team can start from. `limits`
        says how many teams a store and people a team may have (10 and 30,
        invites not yet taken up counted among the people), how long a team's
        `name` may be, how many addresses one invite takes (`perInvite`) and how
        many days an invite lasts (`inviteDays`).


        Needs the `team.read` permission (Read the Team).
      operationId: team.get
      parameters:
        - name: storeId
          in: path
          required: true
          description: >-
            The store's ID. A key reaches the store it was made in: `GET /key`
            answers which.
          schema:
            type: string
      responses:
        '200':
          description: It worked.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    nullable: true
                  code:
                    nullable: true
                  data:
                    type: object
                    properties:
                      teams:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            name:
                              type: string
                            permissions:
                              type: array
                              items:
                                type: string
                            sensitive:
                              type: integer
                            reach:
                              type: array
                              items:
                                type: string
                            people:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                  userId:
                                    type: string
                                  teamId:
                                    type: string
                                  name:
                                    type: string
                                  email:
                                    type: string
                                  avatarUrl:
                                    nullable: true
                                  invitedBy:
                                    type: string
                                  joinedAt:
                                    type: string
                                  lastSeenAt:
                                    nullable: true
                                  keys:
                                    type: integer
                                  me:
                                    type: boolean
                            waiting:
                              type: integer
                            createdAt:
                              type: string
                            updatedAt:
                              type: string
                      invites:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            kind:
                              type: string
                            email:
                              type: string
                            teamId:
                              type: string
                            team:
                              type: string
                            invitedBy:
                              type: string
                            sends:
                              type: integer
                            sentAt:
                              type: string
                            expiresAt:
                              type: string
                            expired:
                              type: boolean
                      owner:
                        type: object
                        properties:
                          userId:
                            type: string
                          name:
                            nullable: true
                          email:
                            type: string
                          avatarUrl:
                            nullable: true
                      me:
                        type: object
                        properties:
                          role:
                            type: string
                          teamId:
                            nullable: true
                          permissions:
                            type: array
                            items:
                              type: string
                      permissions:
                        type: object
                        properties:
                          groups:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                title:
                                  type: string
                                permissions:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id: {}
                                      label: {}
                                      about: {}
                                      sensitive: {}
                                      needs: {}
                          presets:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                name:
                                  type: string
                                about:
                                  type: string
                                permissions:
                                  type: array
                                  items:
                                    type: string
                      limits:
                        type: object
                        properties:
                          teams:
                            type: integer
                          people:
                            type: integer
                          name:
                            type: integer
                          perInvite:
                            type: integer
                          inviteDays:
                            type: integer
              example:
                success: true
                message: null
                code: null
                data:
                  teams:
                    - id: 76da1aed-1f2d-4fc5-8b6c-d2ec8235f7de
                      name: Support
                      permissions:
                        - orders.view
                        - customers.view
                      sensitive: 0
                      reach:
                        - Orders
                        - Audience
                      people:
                        - id: c680707e-2171-421f-bb2e-e0204898fd6e
                          userId: 6555d424-6a96-4c06-8152-027ccf47df8e
                          teamId: 76da1aed-1f2d-4fc5-8b6c-d2ec8235f7de
                          name: Mila Novak
                          email: mila@example.com
                          avatarUrl: null
                          invitedBy: owner@example.com
                          joinedAt: '2026-10-24T16:33:36Z'
                          lastSeenAt: null
                          keys: 0
                          me: false
                      waiting: 1
                      createdAt: '2026-10-24T16:33:36Z'
                      updatedAt: '2026-10-24T16:33:36Z'
                    - id: 39f41117-fab9-4758-8a48-f4cc36d1eac0
                      name: Packers
                      permissions:
                        - orders.view
                      sensitive: 0
                      reach:
                        - Orders
                      people: []
                      waiting: 0
                      createdAt: '2026-10-24T16:33:36Z'
                      updatedAt: '2026-10-24T16:33:36Z'
                  invites:
                    - id: 4518a713-d7d0-4d0a-89ec-f905cf2a9e55
                      kind: email
                      email: sam@example.com
                      teamId: 76da1aed-1f2d-4fc5-8b6c-d2ec8235f7de
                      team: Support
                      invitedBy: owner@example.com
                      sends: 1
                      sentAt: '2026-10-24T16:33:36Z'
                      expiresAt: '2026-10-31T16:33:36Z'
                      expired: false
                  owner:
                    userId: 030385fc-91cf-452b-ab61-0cf43e9d9367
                    name: null
                    email: owner@example.com
                    avatarUrl: null
                  me:
                    role: key
                    teamId: null
                    permissions:
                      - sales.figures
                      - orders.view
                  permissions:
                    groups:
                      - id: dashboard
                        title: Dashboard
                        permissions:
                          - id: sales.figures
                            label: See Sales Figures
                            about: >-
                              Revenue, orders and average order on the Dashboard
                              with their charts, and every money figure in
                              Analytics.
                            sensitive: false
                            needs: []
                      - id: orders
                        title: Orders
                        permissions:
                          - id: orders.view
                            label: View Orders
                            about: >-
                              The list and each order's page: what was bought,
                              the buyer, how it was paid and its timeline.
                            sensitive: false
                            needs: []
                          - id: orders.delivered
                            label: See What Was Delivered
                            about: >-
                              The keys, files and text an order handed over.
                              Without it an order says how many, not what.
                            sensitive: true
                            needs:
                              - orders.view
                    presets:
                      - id: support
                        name: Support
                        about: >-
                          Orders and what they delivered, customers, tickets and
                          reviews.
                        permissions:
                          - orders.view
                          - orders.delivered
                      - id: catalogue
                        name: Catalogue
                        about: Products, stock, categories, coupons and upsells.
                        permissions:
                          - products.view
                          - products.edit
                  limits:
                    teams: 10
                    people: 30
                    name: 40
                    perInvite: 10
                    inviteDays: 7
        '401':
          $ref: '#/components/responses/NoKey'
        '403':
          $ref: '#/components/responses/NotAllowed'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooMany'
      x-codeSamples:
        - lang: javascript
          label: Node.js
          source: |
            import Shoply from "@shoplygg/node";

            const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });

            const result = await shoply.team.get();
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

            $shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);

            $result = $shoply->team->get();
        - lang: python
          label: Python
          source: |
            import shoply

            client = shoply.Client()  # reads SHOPLY_API_KEY

            result = client.team.get()
components:
  responses:
    NoKey:
      description: >-
        No API key was sent, or the one sent is not a live key:
        `api_key_required`, `invalid_api_key`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotAllowed:
      description: >-
        The key is real and may not do this: `missing_scope` (with
        `requiredScope`), `ip_not_allowed`, `account_unavailable`, or
        `dashboard_only` for something only a person in the dashboard may do.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotFound:
      description: >-
        There is no such thing in this store: `not_found`. A store that is not
        the key's own is answered the same way.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    TooMany:
      description: >-
        The key has used up its budget for now: `rate_limited`. `Retry-After`
        says how many seconds to wait.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
  schemas:
    Refusal:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          description: What is wrong, in words for a person.
        code:
          type: string
          description: What is wrong, as a word that does not change.
        data:
          nullable: true
        errors:
          type: object
          description: >-
            For `validation_failed`: what is wrong with each field, by the
            field's name.
          additionalProperties:
            type: string
      required:
        - success
        - message
        - code
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        A secret API key, made under Developers in the dashboard:
        `Authorization: Bearer shoply_sk_...`

````

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