Loops

Loops Components API

Create, read and update reusable LMX email components. 4 operation(s) in the Loops REST API v1 (OpenAPI 1.21.6).

GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/components/{componentId} Get an email component · Get a component #
Ask an LLM
“How do I view the LMX body of a reusable email component?”
“What does a specific component contain?”
Tell an agent
Show email component {componentId}.
Get the LMX for component {componentId}.
POST /v1/components/{componentId} Update an email component · Update a component #
Ask an LLM
“If I edit a shared component, do the emails using it change too?”
“How do I change the body of an existing component?”
Tell an agent
Replace the LMX of component {componentId} with {lmx}.
Rename component {componentId} to {name}.
GET /v1/components List email components · List components #
Ask an LLM
“Which reusable email components exist on my team?”
“Can I page through all components?”
Tell an agent
List my email components.
Show {perPage} components per page.
POST /v1/components Create an email component · Create a component #
Ask an LLM
“How do I create a reusable block I can drop into emails?”
“What format does a new component body need to be in?”
Tell an agent
Create a component named {name} from LMX {lmx}.
Save this LMX {lmx} as a new component called {name}.

Documentation

📖
Documentation
https://loops.so/docs/api-reference/list-components
📖
APIReference
https://loops.so/docs/api-reference/intro

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/loops/refs/heads/main/openapi/loops-components-api-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/loops/refs/heads/main/overlays/loops-components-overlay.yaml

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/loops:loops-components-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.

GitHub Google LinkedIn

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

OpenAPI Specification

loops-components-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Loops OpenAPI Spec Components API
  description: This is the OpenAPI Spec for the Loops API.
  version: 1.21.6
servers:
- url: https://app.loops.so/api
tags:
- name: Components
  description: View email components
paths:
  /v1/components/{componentId}:
    parameters:
    - name: componentId
      in: path
      required: true
      description: The ID of the component.
      schema:
        type: string
        examples:
        - clp2o4i6u8y0t5r3e1w7q9s1
    get:
      operationId: getComponent
      tags:
      - Components
      summary: Get a component
      description: Retrieve a single component by ID.
      x-mint:
        href: /api-reference/get-component
      responses:
        '200':
          description: Successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentResponse'
        '400':
          description: Invalid `componentId`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentFailureResponse'
        '401':
          description: Invalid API key or content API not enabled for this team.
        '404':
          description: Component not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentFailureResponse'
        '405':
          description: Wrong HTTP request method.
      security:
      - apiKey: []
    post:
      operationId: updateComponent
      tags:
      - Components
      summary: Update a component
      description: Update a component's name and/or body. When the `lmx` body changes, the update cascades to every email using this component, and `affectedEmailCount` reports how many were affected. A change that would introduce a dynamic variable an email using the component cannot use is rejected.
      x-mint:
        href: /api-reference/update-component
        content: When the `lmx` body changes, the update cascades to every email using this component, and `affectedEmailCount` reports how many were affected. A change that would introduce a dynamic variable an email using the component cannot use is rejected.
        metadata:
          description: Update a component's name and/or LMX body. Body changes cascade to every email using the component.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateComponentBody'
      responses:
        '200':
          description: Successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateComponentResponse'
        '400':
          description: Invalid `componentId` or request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentFailureResponse'
        '401':
          description: Invalid API key or content API not enabled for this team.
        '404':
          description: Component not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentFailureResponse'
        '405':
          description: Wrong HTTP request method.
        '413':
          description: LMX body exceeds the size limit.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentFailureResponse'
        '422':
          description: Invalid LMX, or a body change that would break emails using the component.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentValidationFailureResponse'
      security:
      - apiKey: []
  /v1/components:
    get:
      operationId: listComponents
      tags:
      - Components
      summary: List components
      description: Retrieve a paginated list of email components.
      x-mint:
        href: /api-reference/list-components
      parameters:
      - name: perPage
        in: query
        required: false
        description: How many results to return in each request. Must be between 10 and 50. Default is 20.
        schema:
          type: string
      - name: cursor
        in: query
        required: false
        description: A cursor to return a specific page of results. Cursors can be found from the `pagination.nextCursor` value in each response.
        schema:
          type: string
      responses:
        '200':
          description: Successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListComponentsResponse'
        '400':
          description: Invalid `perPage` value.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentFailureResponse'
        '401':
          description: Invalid API key or content API not enabled for this team.
        '405':
          description: Wrong HTTP request method.
      security:
      - apiKey: []
    post:
      operationId: createComponent
      tags:
      - Components
      summary: Create a component
      description: Create a new email component from an LMX body.
      x-mint:
        href: /api-reference/create-component
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateComponentBody'
      responses:
        '201':
          description: Component created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentResponse'
        '400':
          description: Invalid request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentFailureResponse'
        '401':
          description: Invalid API key or content API not enabled for this team.
        '405':
          description: Wrong HTTP request method.
        '413':
          description: LMX body exceeds the size limit.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentFailureResponse'
        '422':
          description: Invalid LMX.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentFailureResponse'
      security:
      - apiKey: []
components:
  schemas:
    ComponentValidationFailureResponse:
      type: object
      properties:
        message:
          type: string
        invalidTags:
          type: array
          description: The dynamic variables that the change would push into an email that cannot use them. Present only when the update was rejected for that reason.
          items:
            type: string
      required:
      - message
      examples:
      - message: Component uses unsupported contact properties.
        invalidTags:
        - companyName
    Component:
      type: object
      properties:
        id:
          type: string
          examples:
          - clp2o4i6u8y0t5r3e1w7q9s1
        name:
          type: string
          examples:
          - Header
        lmx:
          type: string
          description: The component body serialized as LMX.
          examples:
          - <Paragraph>Welcome to Acme</Paragraph>
      required:
      - id
      - name
      - lmx
      examples:
      - id: clp2o4i6u8y0t5r3e1w7q9s1
        name: Header
        lmx: <Paragraph>Welcome to Acme</Paragraph>
    ComponentFailureResponse:
      type: object
      properties:
        message:
          type: string
      required:
      - message
      examples:
      - message: Component not found.
    CreateComponentBody:
      type: object
      properties:
        name:
          type: string
          description: The component name.
        lmx:
          type: string
          description: The component body as an LMX string.
      required:
      - name
      - lmx
      examples:
      - name: Header
        lmx: <Paragraph>Welcome to Acme</Paragraph>
    Pagination:
      type: object
      properties:
        totalResults:
          type: number
          examples:
          - 2
        returnedResults:
          type: number
          examples:
          - 2
        perPage:
          type: number
          examples:
          - 20
        totalPages:
          type: number
          examples:
          - 1
        nextCursor:
          type:
          - string
          - 'null'
          examples:
          - null
        nextPage:
          type:
          - string
          - 'null'
          examples:
          - null
      required:
      - totalResults
      - returnedResults
      - perPage
      - totalPages
      - nextCursor
      - nextPage
      examples:
      - totalResults: 2
        returnedResults: 2
        perPage: 20
        totalPages: 1
        nextCursor: null
        nextPage: null
    UpdateComponentResponse:
      allOf:
      - $ref: '#/components/schemas/ComponentResponse'
      - type: object
        properties:
          affectedEmailCount:
            type: number
            description: The number of emails using this component that were updated by the body change. `0` when only the name changed.
        required:
        - affectedEmailCount
      examples:
      - id: clp2o4i6u8y0t5r3e1w7q9s1
        name: Header
        lmx: <Paragraph>Welcome to Acme</Paragraph>
        affectedEmailCount: 3
    ListComponentsResponse:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        data:
          type: array
          items:
            $ref: '#/components/schemas/Component'
      required:
      - pagination
      - data
      examples:
      - pagination:
          totalResults: 2
          returnedResults: 2
          perPage: 20
          totalPages: 1
          nextCursor: null
          nextPage: null
        data:
        - id: clp2o4i6u8y0t5r3e1w7q9s1
          name: Header
          lmx: <Paragraph>Welcome to Acme</Paragraph>
    ComponentResponse:
      type: object
      properties:
        id:
          type: string
          description: The ID of the component.
        name:
          type: string
          description: The name of the component.
        lmx:
          type: string
          description: The component body serialized as LMX.
      required:
      - id
      - name
      - lmx
      examples:
      - id: clp2o4i6u8y0t5r3e1w7q9s1
        name: Header
        lmx: <Paragraph>Welcome to Acme</Paragraph>
    UpdateComponentBody:
      type: object
      description: At least one of `name` or `lmx` must be provided.
      properties:
        name:
          type: string
        lmx:
          type: string
          description: The component body as an LMX string.
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer