v1

latestOpenAPI 3.0.12026-07-14155.6 KB
Business Unit

Get Business Units for a user

Get Business Units identified by userId. The userId refers to the user’s ID.

get/business-units/v3/business-units/user/{userId}

Path parameters

userIdstring required

Identifier of user to retrieve.

Query parameters

propertiesstring[]

The names of properties to optionally include in the response body. The only valid value is logoMetadata.

namestring[]

The names of Business Units to retrieve. If empty or not provided, then all associated Business Units will be returned.

Response

successful operation

Example response

{
  "results": [
    {
      "id": "101",
      "logoMetadata": {
        "logoAltText": "logo sample text",
        "logoUrl": "examplelogourl.com",
        "resizedUrl": "sillystring"
      },
      "name": "sample business unit name"
    }
  ]
}
All 1 operations