API V2 Route: Custom Profile Field Assignments

Last updated: October 5, 2026

General Details:

Endpoint	`/api/v2/profile-field-assignments`
Headers	`Authorization: <JWT>`
HTTP Methods	`GET` and `POST`

GET Details:

Request Body Format	`N/A`
Response Body Format	`JSON`
Required Scopes	`PROFILE_FIELD_ASSIGNMENTS_GET`

Supported Request Filters:

These filters should be query parts in the URL string and follow the standard pattern of <baseUrl>?<key>=<filter>&...

Field Name	Filter Type	Notes
`profileId`	string	A string representing the Profile Id
profileFieldId	string	A string representing the Profile Field Id

GET API Response:

Field Name	Data Type	Notes
profile	ProfileThin
profileField	ProfileFieldThin
values	string[]	The values assigned

Example GET Collection Response:

{
    "entities": [
        {
            "profile": {
                "id": "14",
                "name": "Rudolph Ryan",
                "sisId": "78xxn"
            },
            "profileField": {
                "id": "2",
                "name": "Gender Identity",
                "type": "RADIO"
            },
            "values": [
                "Male"
            ]
        },
        {
            "profile": {
                "id": "14",
                "name": "Rudolph Ryan",
                "sisId": "78xxn"
            },
            "profileField": {
                "id": "3",
                "name": "Pronouns",
                "type": "LINE"
            },
            "values": [
                "willa2"
            ]
        }
    ],
    "metaData": {
        "agentId": "ab5f95b2-303a-403b-85fd-ab1d0cd8093c",
        "rateLimits": {
            "tenant": {
                "limit": 50,
                "remaining": 49,
                "reset": 1759760332000
            },
            "agent": {
                "limit": 10,
                "remaining": 9,
                "reset": 1759760332000
            }
        },
        "pagination": {
            "offset": 0,
            "limit": 2
        }
    }
}

POST Details:

Request Body Format	`JSON`
Response Body Format	`JSON`
Required Scopes	`PROFILE_FIELD_ASSIGNMENTS_POST`

POST API Request Body:

Housing.Cloud supports batch creation, as such every POST payload should contain an array of objects with the following structure:

Field Name	Data Type	Notes
profileId	string
profileFieldId	string
values	string[]	The updated values

Example POST Collection Request:

[
    {
        "profileId": "14",
        "profileFieldId": "3",
        "values": [
            "testing123"
        ]
    },
    {
        "profileId": "15",
        "profileFieldId": "3",
        "values": [
            "testing123"
        ]
    }
]

Example POST Collection Response:

{
    "details": {
        "numTotal": 2,
        "numSuccess": 2,
        "numErrors": 0,
        "errors": null
    },
    "metaData": {
        "agentId": "ab5f95b2-303a-403b-85fd-ab1d0cd8093c",
        "rateLimits": {
            "tenant": {
                "limit": 50,
                "remaining": 49,
                "reset": 1759760777000
            },
            "agent": {
                "limit": 10,
                "remaining": 9,
                "reset": 1759760777000
            }
        }
    }
}