Puzzle Requests API

The Requests API from Puzzle — 1 operation(s) for requests.

Operations 2

GET /company/{id}/requests Get Requests #
POST /company/{id}/requests Create Requests #

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/puzzle-requests-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.

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

OpenAPI Specification

puzzle-requests-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Puzzle Requests API
  description: Puzzle Api
  version: '0'
servers:
- url: https://staging.southparkdata.com/rest/v0
tags:
- name: Requests
paths:
  /company/{id}/requests:
    get:
      operationId: requests
      summary: Get Requests
      description: 'Retrieve a list of requests in a company.


        Required scope: read:company'
      tags:
      - Requests
      parameters:
      - name: id
        in: path
        required: true
        description: The company ID
        schema:
          type: string
          minLength: 1
          description: Partner-facing external identifier
      - name: status
        in: query
        required: false
        schema:
          type: string
      - name: type
        in: query
        required: false
        schema:
          type: string
      - name: transactionIds
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            minLength: 1
            description: Partner-facing external identifier
          - type: array
            items:
              type: string
              minLength: 1
              description: Partner-facing external identifier
      - name: requestedUserIds
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            minLength: 1
            description: Partner-facing external identifier
          - type: array
            items:
              type: string
              minLength: 1
              description: Partner-facing external identifier
      - name: requestedByUserIds
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            minLength: 1
            description: Partner-facing external identifier
          - type: array
            items:
              type: string
              minLength: 1
              description: Partner-facing external identifier
      - name: startDate
        in: query
        required: false
        schema:
          type: string
          minLength: 1
          description: Calendar date, YYYY-MM-DD
      - name: endDate
        in: query
        required: false
        schema:
          type: string
          minLength: 1
          description: Calendar date, YYYY-MM-DD
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  requests:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          minLength: 1
                          description: Partner-facing external identifier
                        transactionId:
                          type:
                          - string
                          - 'null'
                          minLength: 1
                          description: Partner-facing external identifier
                        status:
                          type: string
                          enum:
                          - Cancelled
                          - Completed
                          - Open
                        type:
                          type: string
                          enum:
                          - CategoryReview
                          - Documentation
                          - Message
                          - Integration
                        requestedByUserId:
                          type:
                          - string
                          - 'null'
                          minLength: 1
                          description: Partner-facing external identifier
                        requestedUserId:
                          type:
                          - string
                          - 'null'
                          minLength: 1
                          description: Partner-facing external identifier
                        requestedUserEmail:
                          type:
                          - string
                          - 'null'
                        requestedByUserEmail:
                          type:
                          - string
                          - 'null'
                        requestedByUserPosition:
                          type:
                          - string
                          - 'null'
                          enum:
                          - Founder
                          - CompanyEmployee
                          - OutsourcedAccountantOrCFO
                        requestedUserPosition:
                          type:
                          - string
                          - 'null'
                          enum:
                          - Founder
                          - CompanyEmployee
                          - OutsourcedAccountantOrCFO
                        requestedByUserFirmGroups:
                          type:
                          - array
                          - 'null'
                          items:
                            type: string
                        requestedUserFirmGroups:
                          type:
                          - array
                          - 'null'
                          items:
                            type: string
                        completedByUserId:
                          type:
                          - string
                          - 'null'
                          minLength: 1
                          description: Partner-facing external identifier
                        completedByUserEmail:
                          type:
                          - string
                          - 'null'
                        completedByUserPosition:
                          type:
                          - string
                          - 'null'
                          enum:
                          - Founder
                          - CompanyEmployee
                          - OutsourcedAccountantOrCFO
                        completedByUserFirmGroups:
                          type:
                          - array
                          - 'null'
                          items:
                            type: string
                        cancelledByUserId:
                          type:
                          - string
                          - 'null'
                          minLength: 1
                          description: Partner-facing external identifier
                        cancelledByUserEmail:
                          type:
                          - string
                          - 'null'
                        cancelledByUserPosition:
                          type:
                          - string
                          - 'null'
                          enum:
                          - Founder
                          - CompanyEmployee
                          - OutsourcedAccountantOrCFO
                        cancelledByUserFirmGroups:
                          type:
                          - array
                          - 'null'
                          items:
                            type: string
                        message:
                          type:
                          - string
                          - 'null'
                      required:
                      - id
                      - transactionId
                      - status
                      - type
                      - requestedByUserId
                      - requestedUserId
                      - requestedUserEmail
                      - requestedByUserEmail
                      - requestedByUserPosition
                      - requestedUserPosition
                      - requestedByUserFirmGroups
                      - requestedUserFirmGroups
                      - completedByUserId
                      - completedByUserEmail
                      - completedByUserPosition
                      - completedByUserFirmGroups
                      - cancelledByUserId
                      - cancelledByUserEmail
                      - cancelledByUserPosition
                      - cancelledByUserFirmGroups
                      - message
                required:
                - requests
    post:
      operationId: createRequests
      summary: Create Requests
      description: 'Creates category, documentation, and message requests in a company for a transaction.


        Required scope: write:request'
      tags:
      - Requests
      parameters:
      - name: id
        in: path
        required: true
        description: The company ID
        schema:
          type: string
          minLength: 1
          description: Partner-facing external identifier
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                transactionId:
                  type: string
                  minLength: 1
                  description: Partner-facing external identifier
                requests:
                  type: object
                  properties:
                    categoryReview:
                      type: object
                      properties:
                        requestedUserId:
                          type: string
                          minLength: 1
                          description: Partner-facing external identifier
                        status:
                          type: string
                          enum:
                          - Cancelled
                          - Completed
                          - Open
                      required:
                      - status
                    documentationReview:
                      type: object
                      properties:
                        requestedUserId:
                          type: string
                          minLength: 1
                          description: Partner-facing external identifier
                        status:
                          type: string
                          enum:
                          - Cancelled
                          - Completed
                          - Open
                      required:
                      - status
                    messages:
                      type: array
                      items:
                        type: object
                        properties:
                          message:
                            type: string
                            minLength: 1
                        required:
                        - message
              required:
              - transactionId
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  transactionId:
                    type: string
                    minLength: 1
                    description: Partner-facing external identifier
                  requests:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          minLength: 1
                          description: Partner-facing external identifier
                        transactionId:
                          type:
                          - string
                          - 'null'
                          minLength: 1
                          description: Partner-facing external identifier
                        status:
                          type: string
                          enum:
                          - Cancelled
                          - Completed
                          - Open
                        type:
                          type: string
                          enum:
                          - CategoryReview
                          - Documentation
                          - Message
                          - Integration
                        requestedByUserId:
                          type:
                          - string
                          - 'null'
                          minLength: 1
                          description: Partner-facing external identifier
                        requestedUserId:
                          type:
                          - string
                          - 'null'
                          minLength: 1
                          description: Partner-facing external identifier
                        requestedUserEmail:
                          type:
                          - string
                          - 'null'
                        requestedByUserEmail:
                          type:
                          - string
                          - 'null'
                        requestedByUserPosition:
                          type:
                          - string
                          - 'null'
                          enum:
                          - Founder
                          - CompanyEmployee
                          - OutsourcedAccountantOrCFO
                        requestedUserPosition:
                          type:
                          - string
                          - 'null'
                          enum:
                          - Founder
                          - CompanyEmployee
                          - OutsourcedAccountantOrCFO
                        requestedByUserFirmGroups:
                          type:
                          - array
                          - 'null'
                          items:
                            type: string
                        requestedUserFirmGroups:
                          type:
                          - array
                          - 'null'
                          items:
                            type: string
                        completedByUserId:
                          type:
                          - string
                          - 'null'
                          minLength: 1
                          description: Partner-facing external identifier
                        completedByUserEmail:
                          type:
                          - string
                          - 'null'
                        completedByUserPosition:
                          type:
                          - string
                          - 'null'
                          enum:
                          - Founder
                          - CompanyEmployee
                          - OutsourcedAccountantOrCFO
                        completedByUserFirmGroups:
                          type:
                          - array
                          - 'null'
                          items:
                            type: string
                        cancelledByUserId:
                          type:
                          - string
                          - 'null'
                          minLength: 1
                          description: Partner-facing external identifier
                        cancelledByUserEmail:
                          type:
                          - string
                          - 'null'
                        cancelledByUserPosition:
                          type:
                          - string
                          - 'null'
                          enum:
                          - Founder
                          - CompanyEmployee
                          - OutsourcedAccountantOrCFO
                        cancelledByUserFirmGroups:
                          type:
                          - array
                          - 'null'
                          items:
                            type: string
                        message:
                          type:
                          - string
                          - 'null'
                        createdAt:
                          type: string
                          minLength: 1
                          description: ISO 8601 timestamp
                        updatedAt:
                          type: string
                          minLength: 1
                          description: ISO 8601 timestamp
                      required:
                      - id
                      - transactionId
                      - status
                      - type
                      - requestedByUserId
                      - requestedUserId
                      - requestedUserEmail
                      - requestedByUserEmail
                      - requestedByUserPosition
                      - requestedUserPosition
                      - requestedByUserFirmGroups
                      - requestedUserFirmGroups
                      - completedByUserId
                      - completedByUserEmail
                      - completedByUserPosition
                      - completedByUserFirmGroups
                      - cancelledByUserId
                      - cancelledByUserEmail
                      - cancelledByUserPosition
                      - cancelledByUserFirmGroups
                      - message
                      - createdAt
                      - updatedAt
                required:
                - transactionId
                - requests