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

# Get Connected Account

> Returns the workspace these credentials act on. With an OAuth app token it also returns the Postiz user who approved the app, so your integration can show who is connected. API keys belong to the whole workspace, so `user` is `null`.



## OpenAPI

````yaml GET /me
openapi: 3.1.0
info:
  title: Postiz Public API
  description: >-
    API for managing social media posts, integrations, and media uploads in
    Postiz.


    ## Authentication


    All endpoints require an API key passed in the `Authorization` header:


    ```

    Authorization: your-api-key

    ```


    Get your API key from Postiz Settings.


    ## Rate Limits


    There is a limit of **30 requests per hour**.


    ## Terminology


    The UI uses `channel`, but the API uses `integration`. They refer to the
    same thing.


    ## Supported Platforms (27)


    **Social Platforms:** X (Twitter), LinkedIn, LinkedIn Page, Facebook,
    Instagram, Instagram Standalone, Threads, Bluesky, Mastodon, Warpcast
    (Farcaster), Nostr, VK


    **Video Platforms:** YouTube, TikTok


    **Community Platforms:** Reddit, Lemmy, Discord, Slack, Telegram


    **Design Platforms:** Pinterest, Dribbble


    **Blogging Platforms:** Medium, Dev.to, Hashnode, WordPress


    **Business:** Google My Business (GMB), Listmonk (newsletters)
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.postiz.com/public/v1
    description: Postiz Cloud
  - url: https://{your-domain}/api/public/v1
    description: Self-hosted
    variables:
      your-domain:
        default: localhost:5000
        description: Your Postiz instance domain
security:
  - ApiKeyAuth: []
tags:
  - name: Integrations
    description: Manage connected social media channels
  - name: Posts
    description: Create, list, and delete posts
  - name: Uploads
    description: Upload media files
  - name: Notifications
    description: View organization notifications
  - name: Analytics
    description: View analytics for integrations and posts
  - name: Video Generation
    description: Generate videos with AI
  - name: Clipping
    description: Turn long YouTube videos into short vertical clips
paths:
  /me:
    get:
      tags:
        - Integrations
      summary: Get connected account
      description: >-
        Returns the workspace these credentials act on. With an OAuth app token
        it also returns the Postiz user who approved the app, so your
        integration can show who is connected. API keys belong to the whole
        workspace, so `user` is `null`.
      operationId: getMe
      responses:
        '200':
          description: Connected workspace and user
          content:
            application/json:
              schema:
                type: object
                properties:
                  organization:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                  user:
                    type:
                      - object
                      - 'null'
                    description: Only set for OAuth app tokens
                    properties:
                      id:
                        type: string
                      name:
                        type:
                          - string
                          - 'null'
                      picture:
                        type:
                          - string
                          - 'null'
                        description: Absolute URL of the user's avatar
              example:
                organization:
                  id: cm4ean69r0003w8w1cdomox9n
                  name: My Company
                user:
                  id: cm4eamz9f0001w8w1k2b7x0ab
                  name: Nevo David
                  picture: https://uploads.postiz.com/avatar.jpg
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Your Postiz API key

````

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