Unified.to

Unified.to list API

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

GitHub OpenAPI

Documentation

📖
Documentation
https://unified.to/accounting
📖
Documentation
https://docs.unified.to/accounting/overview
📖
Documentation
https://unified.to/ads
📖
Documentation
https://docs.unified.to/ads/overview
📖
Documentation
https://unified.to/assessment
📖
Documentation
https://unified.to/ats
📖
Documentation
https://docs.unified.to/ats/overview
📖
Documentation
https://unified.to/calendar
📖
Documentation
https://unified.to/uc
📖
Documentation
https://unified.to/crm
📖
Documentation
https://docs.unified.to/crm/overview
📖
Documentation
https://unified.to/ecommerce
📖
Documentation
https://unified.to/hris
📖
Documentation
https://docs.unified.to/hris/overview
📖
Documentation
https://unified.to/messaging
📖
Documentation
https://unified.to/payment
📖
Documentation
https://docs.unified.to/payment/overview
📖
Documentation
https://unified.to/ticketing
📖
Documentation
https://docs.unified.to/ticketing/overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/unified-to/refs/heads/main/openapi/unified-to-list-api-openapi.yml

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

🔗
Examples
https://raw.githubusercontent.com/api-evangelist/unified-to/refs/heads/main/examples/unified-to-list-ats-jobs-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/unified-to/refs/heads/main/examples/unified-to-list-crm-contacts-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/unified-to/refs/heads/main/examples/unified-to-create-hris-employee-example.json

OpenAPI Specification

unified-to-list-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 list 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: list
paths:
  /martech/{connection_id}/list:
    get:
      operationId: listMartechLists
      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: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - name
            - description
            - start_at
            - end_at
            - user_id
            - is_active
            - address
            - subject
            - sender_name
            - sender_email
            - language
            - sender_company
            - sender_phone
            - 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/MarketingLists'
          description: Successful
      security:
      - jwt: []
      summary: List All Lists
      tags:
      - list
    post:
      operationId: createMartechList
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - name
            - description
            - start_at
            - end_at
            - user_id
            - is_active
            - address
            - subject
            - sender_name
            - sender_email
            - language
            - sender_company
            - sender_phone
            - 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/MarketingList'
        description: Mailing List
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketingList'
          description: Successful
      security:
      - jwt: []
      summary: Create a List
      tags:
      - list
  /martech/{connection_id}/list/{id}:
    delete:
      operationId: removeMartechList
      parameters:
      - description: ID of the connection
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      - description: ID of the List
        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 List
      tags:
      - list
    get:
      operationId: getMartechList
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - name
            - description
            - start_at
            - end_at
            - user_id
            - is_active
            - address
            - subject
            - sender_name
            - sender_email
            - language
            - sender_company
            - sender_phone
            - 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 List
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketingList'
          description: Successful
      security:
      - jwt: []
      summary: Retrieve a List
      tags:
      - list
    patch:
      operationId: patchMartechList
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - name
            - description
            - start_at
            - end_at
            - user_id
            - is_active
            - address
            - subject
            - sender_name
            - sender_email
            - language
            - sender_company
            - sender_phone
            - 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 List
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MarketingList'
        description: Mailing List
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketingList'
          description: Successful
      security:
      - jwt: []
      summary: Update a List
      tags:
      - list
    put:
      operationId: updateMartechList
      parameters:
      - description: Fields to return
        in: query
        name: fields
        required: false
        schema:
          items:
            enum:
            - id
            - created_at
            - updated_at
            - name
            - description
            - start_at
            - end_at
            - user_id
            - is_active
            - address
            - subject
            - sender_name
            - sender_email
            - language
            - sender_company
            - sender_phone
            - 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 List
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MarketingList'
        description: Mailing List
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketingList'
          description: Successful
      security:
      - jwt: []
      summary: Update a List
      tags:
      - list
components:
  schemas:
    MarketingList:
      description: Mailing List
      properties:
        address:
          $ref: '#/components/schemas/property_MarketingList_address'
        created_at:
          format: date-time
          type: string
        description:
          type: string
        end_at:
          format: date-time
          type: string
        id:
          type: string
        is_active:
          type: boolean
        language:
          type: string
        name:
          type: string
        raw:
          additionalProperties: true
          type: object
        sender_company:
          type: string
        sender_email:
          type: string
        sender_name:
          type: string
        sender_phone:
          type: string
        start_at:
          format: date-time
          type: string
        subject:
          type: string
        updated_at:
          format: date-time
          type: string
        user_id:
          type: string
      type: object
    property_MarketingList_address:
      properties:
        address1:
          type: string
        address2:
          type: string
        city:
          type: string
        country:
          type: string
        country_code:
          type: string
        postal_code:
          type: string
        region:
          type: string
        region_code:
          type: string
      type: object
    MarketingLists:
      items:
        $ref: '#/components/schemas/MarketingList'
      type: array
  securitySchemes:
    jwt:
      in: header
      name: authorization
      type: apiKey
externalDocs:
  description: API Documentation
  url: https://docs.unified.to