Vendors

List a vendor's custom fields

Returns every custom field defined for vendors, each with this vendor's value where one has been set. Fields with no value still appear. Requires the vendors:read permission.

GET

https://services.magicdoor.com/maintenance/company-portal/vendors/{vendorId}/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

vendorIdstringrequired

The vendor to act on. A Snowflake id, sent as a decimal string.

example: 1826110384726355968

Response

200 · The company's vendor custom fields, with this vendor's values.

customFieldsobject[]required

One entry per custom field defined for vendors.

401 · The request carried no valid access token.

403 · The token is not a property manager token, or it lacks the `vendors:read` permission.

404 · No such vendor, or it belongs to another company.

Request

curl --request GET \
  --url 'https://services.magicdoor.com/maintenance/company-portal/vendors/1826110384726355968/custom-fields' \
  --header 'Authorization: Bearer <token>'

Response

{
  "customFields": [
    {
      "id": "1825110384726355968",
      "name": "Contractor licence",
      "description": "State licence number.",
      "public": false,
      "filterable": true,
      "listable": true,
      "order": 1,
      "options": {
        "required": false
      },
      "value": {
        "customFieldId": "1825110384726355968",
        "entityType": "Vendor",
        "entityId": "1826110384726355968",
        "stringValue": "C-36 941822",
        "created": "2026-03-11T10:02:44",
        "updated": "2026-06-02T15:31:09",
        "referenceFiles": []
      }
    },
    {
      "id": "1825110384726355969",
      "name": "W-9 on file",
      "public": false,
      "filterable": false,
      "listable": false,
      "order": 2,
      "options": {
        "required": false
      }
    }
  ]
}