postzen-dev

postzen-dev Profiles API

List, create, update, and delete PostZen profiles.

GitHub OpenAPI

Operations 5

GET /v1/profiles List profiles #
POST /v1/profiles Create a profile #
GET /v1/profiles/{profileId} Get a profile #
PUT /v1/profiles/{profileId} Update a profile #
DELETE /v1/profiles/{profileId} Delete a profile #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/postzen-dev/openapi/postzen-dev-profiles-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/postzen-dev/json-schema/postzen-dev-comment-automation-create-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/postzen-dev/json-schema/postzen-dev-contact-schema.json
📊
JSONSchema
https://artifacts.apis.io/postzen-dev/json-schema/postzen-dev-comment-automation-update-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/postzen-dev/json-schema/postzen-dev-contact-create-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/postzen-dev/json-schema/postzen-dev-contact-update-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/postzen-dev/json-schema/postzen-dev-contact-channel-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/postzen-dev:postzen-dev-profiles-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

postzen-dev-profiles-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: PostZen Public Profiles API
  version: 1.0.0
  description: The PostZen Public API lets server-side integrations manage profiles, connected social accounts, OAuth connection flows, media uploads, post creation, and outbound webhooks.
servers:
- url: https://api.postzen.dev
  description: Production API
security:
- bearerAuth: []
tags:
- name: Profiles
  description: List, create, update, and delete PostZen profiles.
paths:
  /v1/profiles:
    get:
      tags:
      - Profiles
      operationId: listProfiles
      summary: List profiles
      description: Returns profiles available to the API key, sorted by creation date (oldest first). Read-only and read-write API keys are accepted.
      responses:
        '200':
          description: Profiles returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfilesListResponse'
              example:
                profiles:
                - _id: jh72r5nqk9wx3v8m1t4cz6bs0fy5dg3e
                  userId: jd7cm2xw9krt4v1n8q6zs0b3hf5yg2pa
                  name: Marketing Team
                  description: Profile for marketing campaigns
                  color: '#4caf50'
                  isDefault: false
                  createdAt: '2026-06-13T16:00:00.000Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Failed to list profiles
    post:
      tags:
      - Profiles
      operationId: createProfile
      summary: Create a profile
      description: Creates a profile. This endpoint requires a read-write API key with access to all profiles.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProfileCreateRequest'
            example:
              name: Marketing Team
              description: Profile for marketing campaigns
              color: '#4caf50'
      responses:
        '201':
          description: Profile created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileWriteResponse'
              example:
                message: Profile created successfully
                profile:
                  _id: jh72r5nqk9wx3v8m1t4cz6bs0fy5dg3e
                  userId: jd7cm2xw9krt4v1n8q6zs0b3hf5yg2pa
                  name: Marketing Team
                  description: Profile for marketing campaigns
                  color: '#4caf50'
                  isDefault: false
                  createdAt: '2026-06-13T16:00:00.000Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalError'
  /v1/profiles/{profileId}:
    parameters:
    - name: profileId
      in: path
      required: true
      description: PostZen profile id.
      schema:
        type: string
    get:
      tags:
      - Profiles
      operationId: getProfile
      summary: Get a profile
      description: Returns a single profile visible to the API key.
      responses:
        '200':
          description: Profile returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
    put:
      tags:
      - Profiles
      operationId: updateProfile
      summary: Update a profile
      description: Updates one or more profile fields. This endpoint requires a read-write API key.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProfileUpdateRequest'
            example:
              name: Marketing Team (Updated)
              description: Updated profile description
              color: '#2196f3'
              isDefault: true
      responses:
        '200':
          description: Profile updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileWriteResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
    delete:
      tags:
      - Profiles
      operationId: deleteProfile
      summary: Delete a profile
      description: Deletes a profile. The default profile cannot be deleted, and profiles with connected accounts must be disconnected first.
      responses:
        '200':
          description: Profile deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
              example:
                message: Profile deleted successfully
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    ProfileResponse:
      type: object
      required:
      - profile
      properties:
        profile:
          $ref: '#/components/schemas/Profile'
    ErrorResponse:
      type: object
      required:
      - error
      properties:
        error:
          type: string
        type:
          type: string
        code:
          type: string
        param:
          type:
          - string
          - 'null'
    Profile:
      type: object
      required:
      - _id
      - userId
      - name
      - color
      - isDefault
      - createdAt
      properties:
        _id:
          type: string
          description: PostZen profile id.
        userId:
          type: string
          description: Owner user id.
        name:
          type: string
          maxLength: 80
        description:
          type: string
          maxLength: 240
        color:
          type: string
          pattern: ^#[0-9a-fA-F]{6}$
          description: Hex color in `#rrggbb` format.
        isDefault:
          type: boolean
        createdAt:
          type: string
          format: date-time
    ProfileUpdateRequest:
      type: object
      description: Include at least one field.
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 80
        description:
          type:
          - string
          - 'null'
          maxLength: 240
          description: Pass an empty string or `null` to clear the description.
        color:
          type: string
          pattern: ^#[0-9a-fA-F]{6}$
        isDefault:
          type: boolean
          description: Set to `true` to make this the default profile.
    MessageResponse:
      type: object
      required:
      - message
      properties:
        message:
          type: string
    ProfileWriteResponse:
      type: object
      required:
      - message
      - profile
      properties:
        message:
          type: string
        profile:
          $ref: '#/components/schemas/Profile'
    ProfilesListResponse:
      type: object
      required:
      - profiles
      properties:
        profiles:
          type: array
          items:
            $ref: '#/components/schemas/Profile'
    ProfileCreateRequest:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 80
        description:
          type: string
          maxLength: 240
        color:
          type: string
          pattern: ^#[0-9a-fA-F]{6}$
          default: '#ffeda0'
  responses:
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Not found
    BadRequest:
      description: Invalid request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: JSON body is required
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Unauthorized
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Failed to create post
    Forbidden:
      description: The API key does not have sufficient permission or profile access.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: API key requires read_write permission
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: PostZen API key.