Tenants

List tenant custom fields

Returns every custom field the company has defined for tenants, each with the value set on this tenant where there is one. Fields with no value are still listed, so the response doubles as the form to fill in.

GET

https://api.portal.magicdoor.com/company-app/tenants/{tenantId}/custom-fields

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Path parameters

tenantIdstringrequired

The tenant whose custom fields you are working with. A Snowflake id, sent as a decimal string.

example: 1830472847398404096

Response

200 · Every custom field defined for tenants, with this tenant's values.

customFieldsobject[]

Every custom field defined for this record type, whether or not a value has been set.

401 · The access token is missing, expired, or does not belong to a property manager.

Request

curl --request GET \
  --url 'https://api.portal.magicdoor.com/company-app/tenants/1830472847398404096/custom-fields' \
  --header 'Authorization: Bearer <token>'

Response

{
  "customFields": [
    {
      "id": "1830472847398404200",
      "name": "Preferred contact time",
      "description": "When this person prefers to be called.",
      "public": false,
      "filterable": true,
      "listable": true,
      "order": 1,
      "options": {
        "type": "string",
        "required": false,
        "componentType": "select",
        "multiple": false,
        "values": [
          "Morning",
          "Afternoon",
          "Evening"
        ],
        "rejectUnknown": true
      },
      "value": {
        "customFieldId": "1830472847398404200",
        "entityType": "tenant",
        "entityId": "1830472847398404096",
        "stringValue": "Morning",
        "created": "2026-06-01T09:00:00",
        "updated": "2026-08-01T11:30:00"
      }
    },
    {
      "id": "1830472847398404201",
      "name": "Signed authorisation form",
      "public": false,
      "filterable": false,
      "listable": false,
      "order": 2,
      "options": {
        "type": "reference",
        "required": false,
        "componentType": "file",
        "referenceEntityType": "file",
        "multiple": true
      }
    }
  ]
}