List components

Retrieve a paginated list of email components.

GET /v1/components

List components

cURL

curl --request GET \
  --url https://app.loops.so/api/v1/components \
  --header 'Authorization: Bearer <token>'

Response

{
  "success": true,
  "pagination": {
    "totalResults": 1,
    "returnedResults": 1,
    "perPage": 20,
    "totalPages": 1,
    "nextCursor": null,
    "nextPage": null
  },
  "data": [
    {
      "componentId": "cmpn_01hxyz",
      "name": "Hero header",
      "lmx": "<Section><Heading>Welcome</Heading></Section>"
    }
  ]
}

Content API endpoints are currently in an open alpha and are subject to change.

Request

Query parameters

perPage · string · default: 20

How many results to return in each request. Must be between 10 and 50.

cursor · string

A cursor to return a specific page of results. Cursors can be found from the pagination.nextCursor value in each response.

Response

Success

success · boolean · required

pagination · object

Show metadata

totalResults · number

Total results found.

returnedResults · number

The number of results returned in this response.

perPage · number

The maximum number of results requested.

totalPages · number

Total number of pages.

nextCursor · nullable string

The next cursor (for retrieving the next page of results using the cursor parameter), or null if there are no further pages.

nextPage · nullable string

The URL of the next page of results, or null if there are no further pages.

data · array · required

Hide component

componentId · string · required

name · string · required

lmx · string · required

Error

A 400 Bad Request is returned if perPage is invalid.

If the API key is invalid (or content API is not enabled for your team), a 401 Unauthorized is returned.

success · boolean · required

message · string · required

Response

{
  "success": true,
  "pagination": {
    "totalResults": 1,
    "returnedResults": 1,
    "perPage": 20,
    "totalPages": 1,
    "nextCursor": null,
    "nextPage": null
  },
  "data": [
    {
      "componentId": "cmpn_01hxyz",
      "name": "Hero header",
      "lmx": "<Section><Heading>Welcome</Heading></Section>"
    }
  ]
}