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

# The signed-in supplier’s own profile

> The supplier record the user token resolves to in this project, as the MarketBox dashboard shows it under My Profile, built by the same code. It is the supplier’s own record, resolved from the user token: phone, email, address, `active`, time zone, service and skill ids, languages and locales. `GET /suppliers/{supplierId}` is an API-key route that also returns contact fields, so do not proxy it to browsers unfiltered. `avatarUrl` is the display-size photo, or null when none is set. Requires the API key and the supplier’s user token.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/projects/{projectId}/suppliers/me
openapi: 3.0.0
info:
  title: MarketBox 2.0 Open API
  version: 1.0.0
  description: >-
    The MarketBox public API for building booking experiences. Core model:
    create an order, then draw its order items down into bookings. Single
    bookings reference an order item per service line; package bookings draw one
    PACKAGE item down across N sessions. To schedule a package, build a slate
    (POST /availability/package-slate) and book it by slateId (POST
    /orders/{orderId}/package-bookings). See the guides for end-to-end
    walkthroughs.
  contact:
    name: MarketBox support
servers:
  - url: https://apiv2.gomarketbox.com
    description: MarketBox Open API
security:
  - ApiKeyAuth: []
paths:
  /v1/projects/{projectId}/suppliers/me:
    get:
      tags:
        - Supplier plane
      summary: The signed-in supplier’s own profile
      description: >-
        The supplier record the user token resolves to in this project, as the
        MarketBox dashboard shows it under My Profile, built by the same code.
        It is the supplier’s own record, resolved from the user token: phone,
        email, address, `active`, time zone, service and skill ids, languages
        and locales. `GET /suppliers/{supplierId}` is an API-key route that also
        returns contact fields, so do not proxy it to browsers unfiltered.
        `avatarUrl` is the display-size photo, or null when none is set.
        Requires the API key and the supplier’s user token.
      parameters:
        - schema:
            type: string
            minLength: 1
            description: >-
              The project (tenant) that owns the resource. Every resource in
              this API is scoped to a project, and your API key is restricted to
              the projects it was issued for — a project outside that scope
              returns 403.
            example: prj_01kv60qgnef2kt3pvqgwmkbzfr
          required: true
          description: >-
            The project (tenant) that owns the resource. Every resource in this
            API is scoped to a project, and your API key is restricted to the
            projects it was issued for — a project outside that scope returns
            403.
          name: projectId
          in: path
      responses:
        '200':
          description: The supplier
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      supplierId:
                        type: string
                      projectId:
                        type: string
                      firstName:
                        type: string
                      lastName:
                        type: string
                      fullName:
                        type: string
                      email:
                        type: string
                      phone:
                        type: string
                      addressoneline:
                        type: string
                      street:
                        type: string
                      city:
                        type: string
                      state:
                        type: string
                      country:
                        type: string
                      postalcode:
                        type: string
                      longitude:
                        type: number
                      latitude:
                        type: number
                      timezone:
                        type: string
                      bio:
                        type: string
                      maxTravelTime:
                        type: number
                      externalId:
                        type: string
                      externalData:
                        type: object
                        additionalProperties:
                          nullable: true
                      languages:
                        type: array
                        items:
                          type: string
                      locales:
                        type: array
                        items:
                          type: string
                      defaultLocale:
                        type: string
                      userId:
                        type: string
                      invitationStatus:
                        type: string
                        enum:
                          - NONE
                          - INVITED
                          - LINKED
                      avatar:
                        type: object
                        nullable: true
                        properties:
                          variantId:
                            type: string
                            minLength: 1
                          updatedAt:
                            type: string
                            format: date-time
                        required:
                          - variantId
                          - updatedAt
                      avatarUrl:
                        type: string
                        nullable: true
                        format: uri
                      active:
                        type: boolean
                      deleted:
                        type: boolean
                      createdAt:
                        type: string
                      updatedAt:
                        type: string
                      serviceIds:
                        type: array
                        items:
                          type: string
                      skillIds:
                        type: array
                        items:
                          type: string
                    required:
                      - supplierId
                      - projectId
                      - firstName
                      - lastName
                      - fullName
                      - email
                      - languages
                      - locales
                      - active
                      - deleted
                      - createdAt
                      - updatedAt
                      - serviceIds
                      - skillIds
                required:
                  - data
        '401':
          description: Missing or invalid API key or user token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: >-
            The API key cannot access this project (FORBIDDEN) or lacks standard
            API access (CAPABILITY_NOT_GRANTED); or the signed-in user has no
            MarketBox account record (FORBIDDEN, "User account not found.
            Complete registration first."); or the signed-in user is not a
            member of the project (NOT_A_MEMBER), their membership has ended
            (MEMBERSHIP_INACTIVE), or the roles they act under lack the route’s
            permission (NO_SUPPLIER_ROLE); or X-MB-Acting-Role names a role they
            do not hold (ACTING_ROLE_NOT_HELD)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: >-
            The signed-in user has no supplier record here: no SUPPLIER among
            the roles they act under (NO_SUPPLIER_ROLE), or no single supplier
            record linked to them (SUPPLIER_NOT_LINKED)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
        - ApiKeyAuth: []
          EndUserBearer: []
components:
  schemas:
    ErrorMessage:
      type: object
      properties:
        code:
          type: string
          description: Stable machine-readable error code, e.g. NOT_FOUND.
        message:
          type: string
          description: Human-readable description of what went wrong.
        statusCode:
          type: integer
          description: The HTTP status code of this response.
        requestId:
          type: string
          description: >-
            The id of this request, also returned as the X-Request-Id header.
            Quote it in a support ticket.
      required:
        - code
        - message
        - statusCode
        - requestId
      example:
        code: NOT_FOUND
        message: Booking not found
        statusCode: 404
        requestId: a3f1c2de-9b64-4a2f-8f0e-5c9d1b7a2e10
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key minted in the MarketBox dashboard. Scope is restricted to the
        projects you select at creation time. Every route needs the key's
        standard API access (`*`) except `POST /v1/projects/{projectId}/events`,
        which needs `events:write`; a key without `*` is refused with 403
        `CAPABILITY_NOT_GRANTED`.
    EndUserBearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        The signed-in person's Cognito access token, issued to this
        application's app client. Sent with the API key on the /clients/me and
        /suppliers/me routes.

````

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