Get Company

Description

This service retrieves the full profile information for the currently logged-in company.


Request

Restrictions

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

Endpoint

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

Parameters

Parameter
Location
Description

touchpoint

Query / Header

The identifier for the touchpoint. Use Thalamus-Touchpoint for the header.

token

Query / Header

The authentication token for the API session. Use Thalamus-Token for the header.

activity

Query / Header

Optional. The activity to be used. Use Thalamus-Activity for the header.

Full URL Example

https://<server-url>/api/v4/company?touchpoint=test&token=...

Request Body

This request does not have a body.


Response

✅ Successful Response: 200 OK

The full profile information for the authenticated company is returned in a company object. This object contains the company's profile data, communication opt-in settings, and any partner associations.

JSON

{
  "company": {
    "profile": {
      "phone": {
        "number": "47964444",
        "areaCode": "11",
        "type": "cellphone",
        "intCode": "54"
      },
      "email": "[email protected]",
      "address": {
        "countryId": 1,
        "street2": "",
        "street1": "Catulo Castillo 5420",
        "postalCode": "4203",
        "stateId": 2,
        "type": "home",
        "city": "Buenos Aires"
      },
      "name": "Jhon",
      "systemId": "836",
      "fiscalId": "793"
    },
    "optIns": [],
    "ownerPartnerPrincipal": "12345678"
  }
}

❌ Unsuccessful Response: 401 Unauthorized

Returned if the request is made without a valid, authenticated session token.

Last updated

Was this helpful?