List pixels

GET/pixels/list

Returns a list of pixels.

Request

curl --request GET \
  --url 'https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/pixels/list?filter%5BownerId%5D=FILTER_OWNER_ID' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-api-secret: YOUR_API_SECRET'

const response = await fetch('https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/pixels/list?filter%5BownerId%5D=FILTER_OWNER_ID', {
  method: 'GET',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'x-api-secret': 'YOUR_API_SECRET',
  },
});

const data = await response.json();
console.log(data);

import requests

url = "https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/pixels/list?filter%5BownerId%5D=FILTER_OWNER_ID"
headers = {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
}

response = requests.get(url, headers=headers)
print(response.json())

Response

{
  "statusCode": 200,
  "data": {
    "pixels": {
      "docs": [
        {
          "id": "6650f1a2b3c4d5e6f7a8b9c1",
          "createdAt": "2026-01-15T12:00:00.000Z",
          "platform": "meta",
          "status": "active",
          "code": "123456789012345",
          "name": "Meta pixel"
        }
      ],
      "limit": 20,
      "currentPage": 1,
      "hasNext": false,
      "nextPage": null,
      "totalDocs": 1,
      "totalPages": 1
    }
  }
}

{
  "message": "Invalid param: []",
  "error": "Bad Request",
  "statusCode": 400,
  "errorCode": "string"
}

Generated from the schema

{
  "message": "Unauthorized",
  "error": "Unauthorized",
  "statusCode": 401
}

Generated from the schema

{
  "message": "Forbidden resource",
  "error": "Forbidden",
  "statusCode": 403
}

Generated from the schema

{
  "statusCode": 500,
  "message": "Internal Server Error"
}

Generated from the schema

Headers

x-api-keystringrequired
Api key provided on integrations tab in Easyflow platform.
x-api-secretstringrequired
Api Secret provided on integrations tab in Easyflow platform.

Query parameters

pageinteger
Page number. Defaults to 1.

Default:1
limitinteger
Number of items per page. Defaults to 20.

Default:20
filter[ownerId]stringrequired
filter[externalReferenceId]string
filter[code]string
filter[platform]string
Possible values:googlemetatiktokgtm
filter[events][]array of strings
Returns pixels that track at least one of these events. Repeat the parameter to send more than one value.

Possible values:checkout-initializedpurchase-completedpurchase-failedpurchase-btn-clickedpix-selectedpix-generatedpix-expiredpix-copiedcredit-card-form-initcredit-card-selectedcredit-card-form-completedbank-slip-selectedbank-slip-form-completedaddress-form-completeddelivery-address-completedcoupon-addedcoupon-box-clickedcoupon-form-initcoupon-form-completedcoupon-apply-faileduser-form-inituser-form-completedpre-checkout-form-initpre-checkout-form-completed

Responses

200Returns a list of pixels.

Returns a list of pixels.

Content typeapplication/jsonobject

statusCodeinteger
Example:200
dataobject
Show child attributesHide child attributes
- pixelsobject
  Show child attributesHide child attributes
  docsarray of objects
  Show child attributesHide child attributes
  idstring
  createdAtstring
  platformstring
  Platform of the pixel. A pixel created by Easyflow can bring a value outside this list, so accept unknown values.
  
  Possible values:googlemetatiktokgtm
  statusstring
  Possible values:activeinactive
  codestring
  namestring
  limitinteger
  currentPageinteger
  hasNextboolean
  nextPageintegernullable
  totalDocsinteger
  totalPagesinteger

400If the provided parameter is invalid, the API will return the following error response:

If the provided parameter is invalid, the API will return the following error response:

Content typeapplication/jsonobject

messagestring
Invalid param: []

Example:Invalid param: []
errorstring
Bad Request

Example:Bad Request
statusCodeinteger
400

Example:400
errorCodestring
Code that identifies the error. Present only on some errors.

401If the request is unauthorized, the API will return the following error response:

If the request is unauthorized, the API will return the following error response:

Content typeapplication/jsonobject

messagestring
Invalid field

Example:Unauthorized
errorstring
Unauthorized

Example:Unauthorized
statusCodeinteger
401

Example:401

403If the request is forbidden, the API will return the following error response:

If the request is forbidden, the API will return the following error response:

Content typeapplication/jsonobject

messagestring
Forbidden resource

Example:Forbidden resource
errorstring
Forbidden

Example:Forbidden
statusCodeinteger
403

Example:403

500If an unexpected condition occurs and the server cannot process the request, the API will return the following error response. This response has no error field.

If an unexpected condition occurs and the server cannot process the request, the API will return the following error response. This response has no error field.

Content typeapplication/jsonobject

statusCodeinteger
HTTP status code.

Example:500
messagestring
Explanation of the error.

Example:Internal Server Error