Get One List Field

Fetch the complete configuration of a specific field from a list using its list UID and field ID. Response includes tag, label, visibility, and type metadata.

🧾 Get One List Field

Retrieve detailed information about a specific field within a subscriber list.

🔹 HTTP Request

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

🔸 URL Segments

Segment
Required
Description

LIST-UNIQUE-ID

Yes

Unique identifier of the list.

FIELD-ID

Yes

Unique identifier of the list field.

🔐 Authorization Header

Include your customer API key:

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

💻 PHP Example

// GET ONE ITEM
$response = $endpoint->getField('LIST-UNIQUE-ID', 'FIELD-ID');

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

📦 Sample JSON Response

{
  "status": "success",
  "data": {
    "record": {
      "field_id": "11",
      "tag": "FNAME",
      "label": "First name",
      "required": "no",
      "help_text": null,
      "visibility": "visible",
      "sort_order": "1",
      "type": {
        "name": "Text",
        "identifier": "text",
        "description": "Text" 
      }
    }
  }
}

Last updated