GET /api/v3/place/udf

Retrieves user-defined field values for all places, paginated

GetPlacesUdfsV3 Permissions: BuildingsAndOrganizations (View)
Use this endpoint to get UDF values across all places in bulk. Supports pagination and place filtering. For UDF values on a single place, use GET /place/{placeId}/udf instead.
Paginated endpoint — This API returns paginated results. Use the pageNumber and pageSize query parameters to control which page of results is returned. The response includes pagination metadata in the response headers. See the Pagination guide for details.

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type.

Query Parameters

Name Description Type Required
filter Optional filter criteria to narrow results by place attributes string (string) Optional
pageSize The number of elements to return in a page integer (int32) Optional
pageNumber The current page number integer (int32) Optional

Filters

Filter Description Type Operators
city City String equals not equals one of like not like not one of
hasWatticsLink Linked to a Wattics site Boolean equals
linkedToPM Linked To PM Boolean equals
parentId Integer equals not equals less than between one of greater than less than equal greater than equal not one of
placeAreaSize Area Size Integer equals not equals less than between one of greater than less than equal greater than equal not one of
placeCode Place Code String equals not equals one of like not like not one of
placeEntityTypeID Integer equals not equals less than between one of greater than less than equal greater than equal not one of
placeEntityTypeInfo Place Entity Type Name String equals not equals one of like not like not one of
placeGroupCode Place Group Code String equals
placeGroupId Integer equals
placeGroupInfo Place Group Name String equals
placeId Integer equals not equals less than between one of greater than less than equal greater than equal not one of
placeInfo Place Name String equals not equals one of like not like not one of
placeTypeCode Place Type Code String equals not equals one of like not like not one of
placeTypeId Integer equals not equals less than between one of greater than less than equal greater than equal not one of
placeTypeInfo Place Type Name String equals not equals one of like not like not one of
postalCode Postal Code String equals not equals one of like not like not one of
primaryUseCode Primary Use Code String equals not equals one of like not like not one of
primaryUseId Integer equals not equals less than between one of greater than less than equal greater than equal not one of
primaryUseInfo Primary Use Name String equals not equals one of like not like not one of
state State/Province String equals not equals one of like not like not one of
structure Structure Boolean equals
topmostPlaceCode Topmost Place Code String equals
topmostPlaceId Integer equals
topmostPlaceInfo Topmost Place Name String equals

Response Headers

This endpoint returns pagination metadata in the response headers.

Header Type Description
PageNumber integer The current page number (1-based).
PageSize integer The maximum number of items per page.
TotalNumberOfRecords integer The total number of records matching the query across all pages.
TotalPages integer The total number of pages. Increment pageNumber until it equals this value to retrieve all results.

See the Pagination guide for iteration examples and best practices.

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

Array of:

PlaceUDFResponse
Property Description Type
placeCode The place code string
placeId The place identifier integer (int32)
placeInfo The place info string
udfs An array of user-defined fields (UDFs) UDFFieldChild[]
UDFFieldChild properties
Property Description Type
dataType DataTypeResponse
DataTypeResponse properties
Property Description Type
dataTypeCode The data type code/short name Required (defined) string
dataTypeId The unique identifier for the data type (e.g., 1=boolean, 2=integer, 3=string, 4=double, 6=date, 12=select list, 13=URL) Required (defined) integer (int32)
dataTypeInfo The data type display name/description Required (defined) string
description A description of what this UDF field is used for Required (defined) string
displayOrder The sort order for displaying this field relative to other UDF fields Required (defined) integer (int32)
important When true, this UDF field is flagged as important and may be highlighted in the UI Required (defined) boolean
name The display name of the UDF field Required (defined) string
udfId The unique identifier for this UDF field definition Required (defined) integer (int32)
udfSelectValues For select-list type UDFs, the available options that can be chosen as values Required (defined) UDFSelectValueEntityResponse[]
UDFSelectValueEntityResponse properties
Property Description Type
displayOrder The sort order for displaying this option in the select list Required (defined) integer (int32)
udfSelectValueId The unique identifier of this select option. Use this value (not the display Value) when setting a select-list UDF. Required (defined) integer (int32)
value The display text for this select option Required (defined) string
value The current value of this UDF field for the entity. Null if no value has been set. Format depends on DataType. Required (defined) string
Example Response application/json 
[
  {    "placeCode": "string",    "placeId": 1,    "placeInfo": "string",    "udfs": [
      {      "dataType": {},      "description": "string",      "displayOrder": 1,      "important": false,      "name": "string",      "udfId": 1,      "udfSelectValues": [],      "value": "string"
    }
    ]
  }
]