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

# Get a customer

> A customer you provisioned, with their workspaces.



## OpenAPI

````yaml /api-reference/partner.openapi.json get /partner/users/{external_id}
openapi: 3.1.0
info:
  title: Partner API
  version: 1.0.0
  description: >-
    Provision your customers, sign them in with single sign-on, issue their
    workspace API keys and connect their messaging channels. Authenticated by
    your partner key as `X-API-KEY`, from your backend only.
servers:
  - url: https://app.onlysocial.io/api
    description: OnlySocial
security:
  - partnerKey: []
tags:
  - name: Customers
    description: Create or refresh a customer's account and workspace.
  - name: Single sign-on
    description: Swap a token signed with your SSO secret for a one-time sign-in link.
  - name: Workspace API keys
    description: Issue, list and revoke the `osk_` keys of a workspace you provisioned.
  - name: Channel Connect
    description: Hosted links that connect a customer's own messaging channels.
paths:
  /partner/users/{external_id}:
    get:
      tags:
        - Customers
      summary: Get a customer
      description: A customer you provisioned, with their workspaces.
      parameters:
        - name: external_id
          in: path
          required: true
          schema:
            type: string
          example: dealer-4821
      responses:
        '200':
          description: The customer
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    $ref: '#/components/schemas/Customer'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    Customer:
      type: object
      properties:
        user_id:
          type: integer
          example: 184
        external_id:
          type: string
          example: dealer-4821
        email:
          type: string
          example: sales@acmemotors.test
        name:
          type: string
          example: Acme Motors
        is_active:
          type: boolean
          example: true
        last_sso_login:
          type:
            - string
            - 'null'
          format: date-time
          example: '2026-10-21T08:03:11+00:00'
        created_at:
          type: string
          format: date-time
          example: '2026-10-20T09:12:04+00:00'
        workspace_id:
          type:
            - string
            - 'null'
          format: uuid
          description: >-
            The customer's first workspace, which provisioning created. `null`
            if they administer none.
          example: 6b1f0e2c-…
        workspace_ids:
          type: array
          items:
            type: string
            format: uuid
          description: Every workspace the customer administers, oldest first.
    Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
        error_code:
          type: string
  responses:
    Unauthenticated:
      description: Missing or invalid partner key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            message: Invalid or inactive API key.
    NotFound:
      description: >-
        Not found, or not yours. Another partner's workspace and a uuid that
        does not exist look the same.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    partnerKey:
      type: apiKey
      in: header
      name: X-API-KEY
      description: Your partner API key, `pk_…`. Backend only.

````

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