Site icon RocketCOMS Developer Center

List Brand Entity Types

List Brand Entity Types

Retrieve a list of brand entity types as defined by The Campaign Registry (TCR). A brand entity type represents the type of business for a brand (e.g. private, public, sole proprietor).

Endpoint

GET /v1/collections/entity-types

Authorization Header

Authorization: Bearer <access_token>
or
Authorization: Basic <encodedString>
where <encodedString> is your <api-key>:<api-secret> string encoded using Base64 encoding

Request Body

None

Returns

Returns an array of brand entity types. The following fields are returned for each brand entity type.

id

string (UUID)

Unique ID for the brand entity type.

alias

string

Alias name for the brand entity type. Provide this alias as the entityType when creating a brand.

displayName

string

Display name for the brand entity type.

SAMPLE RESPONSE

				
					{
  "status": "0000",
  "result": [
    {
      "id": "aa69114a-0234-4b35-9bda-04f86051d31a",
      "alias": "PUBLIC_PROFIT",
      "displayName": "PUBLIC PROFIT"
    },
    {...},
    {...}
  ]
}
				
			
Exit mobile version