Postscript Identity API

Verify which partner or shop the calling API token resolves to.

OpenAPI Specification

postscript-identity-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Postscript Identity API
  description: The Postscript Partner API (v2) lets partners and Shopify shops manage SMS subscribers, send custom events
    into Flows, send transactional and conversational messages, read opt-in keywords, configure webhook subscriptions, and
    run TCPA compliance operations (unsubscribe, redact). Harvested verbatim from the per-operation OpenAPI definitions published
    on https://developers.postscript.io/reference.
  version: '2.0'
  contact:
    name: Postscript Developer Support
    email: developersupport@postscript.io
    url: https://developers.postscript.io
  termsOfService: https://postscript.io/api-terms-of-service
servers:
- url: https://api.postscript.io
security:
- sec0: []
tags:
- name: Identity
  description: Verify the identity and scope of the calling API token.
paths:
  /api/v2/me:
    get:
      summary: Verify Identity
      description: ''
      operationId: verify-identity
      parameters:
      - name: X-Postscript-Shop-Token
        in: header
        schema:
          type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"resource_id\": \"shop_1234567abcde\",\n  \"resource_name\": \"Postscript\",\n  \"resource_type\"\
                    : \"shop\"\n}"
              schema:
                type: object
                properties:
                  resource_id:
                    type: string
                    example: shop_1234567abcde
                  resource_name:
                    type: string
                    example: Postscript
                  resource_type:
                    type: string
                    example: shop
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"errors\": [\n    {\n      \"ctx\": {},\n      \"log\": [\n        \"string\"\n      ],\n\
                    \      \"msg\": \"string\",\n      \"type\": \"string\"\n    }\n  ]\n}"
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        ctx:
                          type: object
                          properties: {}
                        log:
                          type: array
                          items:
                            type: string
                            example: string
                        msg:
                          type: string
                          example: string
                        type:
                          type: string
                          example: string
      deprecated: false
      tags:
      - Identity
components:
  securitySchemes:
    sec0:
      type: apiKey
      in: header
      name: Authorization
      x-bearer-format: bearer