Get All List Fields

Retrieve all subscriber fields (default and custom) for a specific list using its unique ID. Fields include metadata such as tag, label, type, visibility, and order.

🧾 Get All List Fields

Retrieve all the custom and default fields defined in a specific subscriber list.

🔹 HTTP Request

GET API-URL/lists/LIST-UNIQUE-ID/fields

🔸 URL Segments

Segment	Required	Description
LIST-UNIQUE-ID	Yes	Unique identifier of the list.

🔸 Query Parameters

Parameter	Default	Description
page	1	Current page number to retrieve.
per_page	10	Number of items to return per page.

🔐 Authorization Header

Include your customer API key:

X-API-KEY: your-api-key-here

💻 PHP Example

// GET ALL ITEMS
$response = $endpoint->getFields('LIST-UNIQUE-ID');

// DISPLAY RESPONSE
echo '<pre>';
print_r($response->body);
echo '</pre>';

📦 Sample JSON Response

{
  "status": "success",
  "data": {
    "records": [
      {
        "field_id": "11",
        "tag": "EMAIL",
        "label": "Email",
        "required": "yes",
        "help_text": null,
        "visibility": "visible",
        "sort_order": "0",
        "type": {
          "name": "Text",
          "identifier": "text",
          "description": "Text"
        }
      },
      {
        "field_id": "12",
        "tag": "FNAME",
        "label": "First name",
        "required": "no",
        "help_text": null,
        "visibility": "visible",
        "sort_order": "1",
        "type": {
          "name": "Text",
          "identifier": "text",
          "description": "Text"
        }
      },
      {
        "field_id": "13",
        "tag": "LNAME",
        "label": "Last name",
        "required": "no",
        "help_text": null,
        "visibility": "visible",
        "sort_order": "2",
        "type": {
          "name": "Text",
          "identifier": "text",
          "description": "Text"
        }
      }
    ]
  }
}

---