GET residentapi/collections/{collection}/collectionitems

Get all collection items in a collection.

Request Information

URI Parameters

Name	Description	Type	Additional information
collection	(Required)Allowed values are: countries, states, prefixes, canadianprovinces	string	Required

Body Parameters

None.

Response Information

Resource Description

A list of collection items, if collection value is invalid, a resource not found error code will be returned

ListWrapperOfCollectionItem

Name	Description	Type	Additional information
Total		integer	None.
Elements		Collection of CollectionItem	None.

Response Formats

application/json, text/json

Sample:

{
  "total": 1,
  "elements": [
    {
      "collectionItemId": 1,
      "collectionId": 2,
      "displayName": "sample string 3",
      "value1": "sample string 4",
      "value2": "sample string 5",
      "sortOrder": 1,
      "active": true,
      "createdBy": 1,
      "createdOn": "2025-12-24T09:13:04.6457191-05:00",
      "lastmodifiedBy": 1,
      "lastmodifiedOn": "2025-12-24T09:13:04.6457191-05:00"
    },
    {
      "collectionItemId": 1,
      "collectionId": 2,
      "displayName": "sample string 3",
      "value1": "sample string 4",
      "value2": "sample string 5",
      "sortOrder": 1,
      "active": true,
      "createdBy": 1,
      "createdOn": "2025-12-24T09:13:04.6457191-05:00",
      "lastmodifiedBy": 1,
      "lastmodifiedOn": "2025-12-24T09:13:04.6457191-05:00"
    }
  ]
}