Get Field

Retrieve a single custom field from your workspace. The field path parameter accepts the field UUID. The nullable description provides human-authored context about how the field should be interpreted and used.

GET
/v1/fields/:field

Retrieve a single field by UUID

Path parameters

fieldstring Required

Field UUID

Request
Get Field
curl "https://api.leadpush.io/v1/fields/:field" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}"
Response Example
{
  "data": {
    "uuid": "<field_uuid>",
    "name": "company_name",
    "description": "The legal or commonly used name of the customer's company.",
    "type": "text",
    "format": {
      "text": "url",
      "pattern": null,
      "iso_format": null
    },
    "created_at": "2021-01-01T00:00:00.000Z"
  }
}