Unified.to page API

The page API from Unified.to — 2 operation(s) for page.

Documentation

Specifications

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/unified-to/refs/heads/main/json-schema/unified-to-accounting-account-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/unified-to/refs/heads/main/json-schema/unified-to-accounting-invoice-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/unified-to/refs/heads/main/json-schema/unified-to-accounting-transaction-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/unified-to/refs/heads/main/json-schema/unified-to-ats-job-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/unified-to/refs/heads/main/json-schema/unified-to-ats-candidate-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/unified-to/refs/heads/main/json-schema/unified-to-ats-application-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/unified-to/refs/heads/main/json-schema/unified-to-calendar-event-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/unified-to/refs/heads/main/json-schema/unified-to-crm-contact-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/unified-to/refs/heads/main/json-schema/unified-to-crm-company-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/unified-to/refs/heads/main/json-schema/unified-to-crm-deal-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/unified-to/refs/heads/main/json-schema/unified-to-commerce-item-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/unified-to/refs/heads/main/json-schema/unified-to-commerce-review-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/unified-to/refs/heads/main/json-schema/unified-to-hris-employee-schema.json

Other Resources

OpenAPI Specification

unified-to-page-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  contact:
    email: hello@unified.to
    url: https://unified.to/contact
  description: One API to Rule Them All
  termsOfService: https://unified.to/tos
  title: Unified.to account page API
  version: '1.0'
servers:
- description: North American data region
  url: https://api.unified.to
- description: European data region
  url: https://api-eu.unified.to
- description: Australian data region
  url: https://api-au.unified.to
security:
- jwt: []
tags:
- name: page
paths:
  /kms/{connection_id}/page:
    get:
      operationId: listKmsPages
      parameters:
      - in: query
        name: limit
        required: false
        schema:
          type: number
      - in: query
        name: offset
        required: false
        schema:
          type: number
      - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
        in: query
        name: updated_gte
        required: false
        schema:
          type: string
      - in: query
        name: sort
        required: false
        schema:
          type: string
      - in: query
        name: order
        required: false
        schema:
          type: string
      - description: Query string to search. eg. email address or name
        in: query
        name: query
        required: false
        schema:
          type: string
      - description: The space ID to filter by (reference to KmsSpace)
        in: query
        name: space_id
        required: false
        schema:
          type: string
      - description: The parent ID to filter by
        in: query
        name: parent_id
        required: false
        schema:
          type: string
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - title
            - type
            - space_id
            - parent_id
            - is_active
            - user_id
            - download_url
            - metadata
            - has_children
            - web_url
            - raw
            type: string
          type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KmsPages'
          description: Successful
      security:
      - jwt: []
      summary: List All Pages
      tags:
      - page
    post:
      operationId: createKmsPage
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - title
            - type
            - space_id
            - parent_id
            - is_active
            - user_id
            - download_url
            - metadata
            - has_children
            - web_url
            - raw
            type: string
          type: array
        type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KmsPage'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KmsPage'
          description: Successful
      security:
      - jwt: []
      summary: Create a Page
      tags:
      - page
  /kms/{connection_id}/page/{id}:
    delete:
      operationId: removeKmsPage
      parameters:
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the Page
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful
        default:
          content: {}
          description: Successful
          headers:
            Content-Type:
              required: false
              schema:
                type: string
      security:
      - jwt: []
      summary: Remove a Page
      tags:
      - page
    get:
      operationId: getKmsPage
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - title
            - type
            - space_id
            - parent_id
            - is_active
            - user_id
            - download_url
            - metadata
            - has_children
            - web_url
            - raw
            type: string
          type: array
        type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the Page
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KmsPage'
          description: Successful
      security:
      - jwt: []
      summary: Retrieve a Page
      tags:
      - page
    patch:
      operationId: patchKmsPage
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - title
            - type
            - space_id
            - parent_id
            - is_active
            - user_id
            - download_url
            - metadata
            - has_children
            - web_url
            - raw
            type: string
          type: array
        type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the Page
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KmsPage'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KmsPage'
          description: Successful
      security:
      - jwt: []
      summary: Update a Page
      tags:
      - page
    put:
      operationId: updateKmsPage
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - title
            - type
            - space_id
            - parent_id
            - is_active
            - user_id
            - download_url
            - metadata
            - has_children
            - web_url
            - raw
            type: string
          type: array
        type: array
      - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        in: query
        name: raw
        required: false
        schema:
          type: string
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the Page
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KmsPage'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KmsPage'
          description: Successful
      security:
      - jwt: []
      summary: Update a Page
      tags:
      - page
components:
  schemas:
    property_KmsPage_metadata:
      items:
        $ref: '#/components/schemas/KmsPageMetadata'
      type: array
    KmsPageMetadata:
      properties:
        extra_data:
          additionalProperties: true
          anyOf:
          - type: object
          - type: string
          - type: number
          - type: boolean
          - items:
              anyOf:
              - type: object
              - type: string
              - type: number
              - type: boolean
            type: array
        format:
          enum:
          - TEXT
          - NUMBER
          - DATE
          - BOOLEAN
          - FILE
          - TEXTAREA
          - SINGLE_SELECT
          - MULTIPLE_SELECT
          - MEASUREMENT
          - PRICE
          - YES_NO
          - CURRENCY
          - URL
          - PERCENT
          - EMAIL
          - PHONE
          - REFERENCE
          - TIME
          type: string
          x-speakeasy-unknown-values: allow
        id:
          type: string
        namespace:
          type: string
        slug:
          type: string
        value:
          additionalProperties: true
          anyOf:
          - type: object
          - type: string
          - type: number
          - type: boolean
          - items:
              anyOf:
              - type: object
              - type: string
              - type: number
              - type: boolean
            type: array
      type: object
    KmsPages:
      items:
        $ref: '#/components/schemas/KmsPage'
      type: array
    KmsPage:
      properties:
        created_at:
          format: date-time
          type: string
        download_url:
          type: string
        has_children:
          type: boolean
        id:
          type: string
        is_active:
          type: boolean
        metadata:
          $ref: '#/components/schemas/property_KmsPage_metadata'
        parent_id:
          type: string
        raw:
          additionalProperties: true
          type: object
        space_id:
          type: string
        title:
          type: string
        type:
          enum:
          - HTML
          - MARKDOWN
          - TEXT
          - OTHER
          type: string
          x-speakeasy-unknown-values: allow
        updated_at:
          format: date-time
          type: string
        user_id:
          type: string
        web_url:
          type: string
      required:
      - title
      - type
      type: object
  securitySchemes:
    jwt:
      in: header
      name: authorization
      type: apiKey
externalDocs:
  description: API Documentation
  url: https://docs.unified.to