Unified.to API — crm

naftiko: 1.0.0-alpha2
info:
  label: Unified.to  API — crm
  description: 'Unified.to  API — crm. 36 operations. Lead operation: List all companies. Self-contained Naftiko capability
    covering one Unified To business surface.'
  tags:
  - Unified To
  - crm
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    UNIFIED_TO_API_KEY: UNIFIED_TO_API_KEY
capability:
  consumes:
  - type: http
    namespace: crm-crm
    baseUri: https://api.unified.to
    description: Unified.to  API — crm business capability. Self-contained, no shared references.
    resources:
    - name: crm-connection_id-company
      path: /crm/{connection_id}/company
      operations:
      - name: listcrmcompanies
        method: GET
        description: List all companies
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: number
        - name: offset
          in: query
          type: number
        - name: updated_gte
          in: query
          type: string
          description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ
            format)
        - name: sort
          in: query
          type: string
        - name: order
          in: query
          type: string
        - name: query
          in: query
          type: string
          description: Query string to search. eg. email address or name
        - name: deal_id
          in: query
          type: string
          description: The deal ID to filter by (reference to CrmDeal)
        - name: contact_id
          in: query
          type: string
          description: The contact ID to filter by (reference to CrmContact)
        - name: user_id
          in: query
          type: string
          description: The user/employee ID to filter by (reference to HrisEmployee)
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          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'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
      - name: createcrmcompany
        method: POST
        description: Create a company
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          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'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: crm-connection_id-company-id
      path: /crm/{connection_id}/company/{id}
      operations:
      - name: removecrmcompany
        method: DELETE
        description: Remove a company
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: id
          in: path
          type: string
          description: ID of the Company
          required: true
      - name: getcrmcompany
        method: GET
        description: Retrieve a company
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          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'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: id
          in: path
          type: string
          description: ID of the Company
          required: true
      - name: patchcrmcompany
        method: PATCH
        description: Update a company
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          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'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: id
          in: path
          type: string
          description: ID of the Company
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: updatecrmcompany
        method: PUT
        description: Update a company
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          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'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: id
          in: path
          type: string
          description: ID of the Company
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: crm-connection_id-contact
      path: /crm/{connection_id}/contact
      operations:
      - name: listcrmcontacts
        method: GET
        description: List all contacts
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: number
        - name: offset
          in: query
          type: number
        - name: updated_gte
          in: query
          type: string
          description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ
            format)
        - name: sort
          in: query
          type: string
        - name: order
          in: query
          type: string
        - name: query
          in: query
          type: string
          description: Query string to search. eg. email address or name
        - name: company_id
          in: query
          type: string
          description: The company ID to filter by (reference to CrmCompany)
        - name: deal_id
          in: query
          type: string
          description: The deal ID to filter by (reference to CrmDeal)
        - name: user_id
          in: query
          type: string
          description: The user/employee ID to filter by (reference to HrisEmployee)
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          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'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
      - name: createcrmcontact
        method: POST
        description: Create a contact
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          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'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: crm-connection_id-contact-id
      path: /crm/{connection_id}/contact/{id}
      operations:
      - name: removecrmcontact
        method: DELETE
        description: Remove a contact
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: id
          in: path
          type: string
          description: ID of the Contact
          required: true
      - name: getcrmcontact
        method: GET
        description: Retrieve a contact
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          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'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: id
          in: path
          type: string
          description: ID of the Contact
          required: true
      - name: patchcrmcontact
        method: PATCH
        description: Update a contact
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          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'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: id
          in: path
          type: string
          description: ID of the Contact
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: updatecrmcontact
        method: PUT
        description: Update a contact
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          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'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: id
          in: path
          type: string
          description: ID of the Contact
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: crm-connection_id-deal
      path: /crm/{connection_id}/deal
      operations:
      - name: listcrmdeals
        method: GET
        description: List all deals
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: number
        - name: offset
          in: query
          type: number
        - name: updated_gte
          in: query
          type: string
          description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ
            format)
        - name: sort
          in: query
          type: string
        - name: order
          in: query
          type: string
        - name: query
          in: query
          type: string
          description: Query string to search. eg. email address or name
        - name: company_id
          in: query
          type: string
          description: The company ID to filter by (reference to CrmCompany)
        - name: contact_id
          in: query
          type: string
          description: The contact ID to filter by (reference to CrmContact)
        - name: user_id
          in: query
          type: string
          description: The user/employee ID to filter by (reference to HrisEmployee)
        - name: pipeline_id
          in: query
          type: string
          description: The pipeline ID to filter by
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          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'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
      - name: createcrmdeal
        method: POST
        description: Create a deal
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          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'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: crm-connection_id-deal-id
      path: /crm/{connection_id}/deal/{id}
      operations:
      - name: removecrmdeal
        method: DELETE
        description: Remove a deal
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: id
          in: path
          type: string
          description: ID of the Deal
          required: true
      - name: getcrmdeal
        method: GET
        description: Retrieve a deal
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          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'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: id
          in: path
          type: string
          description: ID of the Deal
          required: true
      - name: patchcrmdeal
        method: PATCH
        description: Update a deal
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          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'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: id
          in: path
          type: string
          description: ID of the Deal
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: updatecrmdeal
        method: PUT
        description: Update a deal
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          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'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: id
          in: path
          type: string
          description: ID of the Deal
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: crm-connection_id-event
      path: /crm/{connection_id}/event
      operations:
      - name: listcrmevents
        method: GET
        description: List all events
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: number
        - name: offset
          in: query
          type: number
        - name: updated_gte
          in: query
          type: string
          description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ
            format)
        - name: sort
          in: query
          type: string
        - name: order
          in: query
          type: string
        - name: query
          in: query
          type: string
          description: Query string to search. eg. email address or name
        - name: deal_id
          in: query
          type: string
          description: The deal ID to filter by (reference to CrmDeal)
        - name: contact_id
          in: query
          type: string
          description: The contact ID to filter by (reference to CrmContact)
        - name: company_id
          in: query
          type: string
          description: The company ID to filter by (reference to CrmCompany)
        - name: user_id
          in: query
          type: string
          description: The user/employee ID to filter by (reference to HrisEmployee)
        - name: type
          in: query
          type: string
        - name: lead_id
          in: query
          type: string
          description: The CRM lead ID to filter by (reference to CrmLead)
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          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'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
      - name: createcrmevent
        method: POST
        description: Create an event
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          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'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: crm-connection_id-event-id
      path: /crm/{connection_id}/event/{id}
      operations:
      - name: removecrmevent
        method: DELETE
        description: Remove an event
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: id
          in: path
          type: string
          description: ID of the Event
          required: true
      - name: getcrmevent
        method: GET
        description: Retrieve an event
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          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'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: id
          in: path
          type: string
          description: ID of the Event
          required: true
      - name: patchcrmevent
        method: PATCH
        description: Update an event
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          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'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: id
          in: path
          type: string
          description: ID of the Event
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: updatecrmevent
        method: PUT
        description: Update an event
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          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'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: id
          in: path
          type: string
          description: ID of the Event
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: crm-connection_id-lead
      path: /crm/{connection_id}/lead
      operations:
      - name: listcrmleads
        method: GET
        description: List all leads
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: number
        - name: offset
          in: query
          type: number
        - name: updated_gte
          in: query
          type: string
          description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ
            format)
        - name: sort
          in: query
          type: string
        - name: order
          in: query
          type: string
        - name: query
          in: query
          type: string
          description: Query string to search. eg. email address or name
        - name: company_id
          in: query
          type: string
          description: The company ID to filter by (reference to CrmCompany)
        - name: contact_id
          in: query
          type: string
          description: The contact ID to filter by (reference to CrmContact)
        - name: user_id
          in: query
          type: string
          description: The user/employee ID to filter by (reference to HrisEmployee)
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          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'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
      - name: createcrmlead
        method: POST
        description: Create a lead
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          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'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: crm-connection_id-lead-id
      path: /crm/{connection_id}/lead/{id}
      operations:
      - name: removecrmlead
        method: DELETE
        description: Remove a lead
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: id
          in: path
          type: string
          description: ID of the Lead
          required: true
      - name: getcrmlead
        method: GET
        description: Retrieve a lead
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          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'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: id
          in: path
          type: string
          description: ID of the Lead
          required: true
      - name: patchcrmlead
        method: PATCH
        description: Update a lead
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          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'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: id
          in: path
          type: string
          description: ID of the Lead
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: updatecrmlead
        method: PUT
        description: Update a lead
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          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'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: id
          in: path
          type: string
          description: ID of the Lead
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: crm-connection_id-pipeline
      path: /crm/{connection_id}/pipeline
      operations:
      - name: listcrmpipelines
        method: GET
        description: List all pipelines
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: number
        - name: offset
          in: query
          type: number
        - name: updated_gte
          in: query
          type: string
          description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ
            format)
        - name: sort
          in: query
          type: string
        - name: order
          in: query
          type: string
        - name: query
          in: query
          type: string
          description: Query string to search. eg. email a

# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/unified-to/refs/heads/main/capabilities/crm-crm.yaml