Get Physical Location

Description

This service returns all available information for the authenticated physical location. The response includes the validation status for each profile field, indicated by a corresponding fieldCode.valueState property (e.g., email.valueState).

---

Request

Restrictions

This service requires an authenticated user and can only be called after a successful physical location login.

Endpoint

GET https://<server-url>/api/v4/physicallocation

Parameters

Parameter	Location	Description
touchpoint	Query / Header	The identifier for the touchpoint making the request. If sent as a header, the name must be Thalamus-Touchpoint.
token	Query / Header	The authentication token for the API session. If sent as a header, the name must be Thalamus-Token.
activity	Query / Header	Optional. The activity to be used. If sent as a header, the name must be Thalamus-Activity.
mode	Query	Optional. Controls attribute visibility. simple (default) shows configured attributes; expanded shows all possible attributes.
date_format	Query	Optional. Sets the format for date fields. timestamp (default) returns a Unix timestamp; readable returns in yyyy-MM-dd format.
fill_referencers	Query	Optional. on (default) fills the referencers element in the response; off leaves it empty to speed up the response.
Content-Type	Header	Specifies the content type of the request body. Must be application/json.

Full URL Example

https://<server-url>/api/v4/physicallocation?mode=simple&touchpoint=test&token=...
https://<server-url>/api/v4/physicallocation?date_format=readable&touchpoint=test&token=...
https://<server-url>/api/v4/physicallocation?fill_referencers=off&touchpoint=test&token=...

Request Body

This request does not have a body.

---

Response

✅ Successful Response: 200 OK

The full profile information for the physical location is returned in the physical_location object.

JSON

{
  "context": {
    "links": [
      {
        "ref": "home",
        "href": "http://localhost:8080/thalamus/api/v4/people/home"
      }
    ],
    "activities": [
      {
        "code": "EMileage",
        "name": "E Mileage"
      }
    ],
    "simpleProfile": {
      "me": false,
      "urlAvatar": ""
    }
  },
  "physical_location": {
        "links": [],
        "dynamicData": "{}",
        "id": 1,
        "validationStatus": "Unknown",
        "profile": {
            "links": [],
            "partyType": 14,
            "systemId": 12345,
            "name": "123 SRL",
            "name.valueState": "UNKNOWN",
            "systemId.valueState": "UNKNOWN"
        },
        "links": [],
        "optIns": [
            {
                "brandFamilyId": -1,
                "channel": -1,
                "accepted": true
            }
        ],
        "credential": null,
        "referencers": [],
        "ownerPartnerPrincipal": null
    }
}