v1

latestOpenAPI 3.0.12026-07-245752052.0 MB

brands

find one brand

Find one brand by its unique identifier.

get/api/serviceorganizations/brands/{identifier}

Path parameters

identifierstring uuid required

brand unique identifier

Query parameters

fromLangstring

Locale-style string indicating from which language the backend should translate relevant string values - works in conjunction with toLang

toLangstring

Locale-style string indicating the backend should translate relevant string values to the specified language - works in conjunction with fromLang

Response

One brand document found. Wrapped in a JsonAPI root response with document as data.

Example response

{
  "data": {
    "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
    "createdAt": "2021-05-05T01:02:03.924Z",
    "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
    "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
    "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
    "lastUpdatedByAudience": "employer",
    "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
    "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
    "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
    "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
    "name": "Bojangles",
    "logoUrl": "file.png",
    "websiteUrl": "https://www.bojangles.com/",
    "colors": {
      "primary": "#1260fd",
      "secondary": "#1260fd"
    },
    "welcomeContent": {
      "message": "Welcome to the Bojangles team! Please take a moment to watch the video below."
    },
    "helpContent": {
      "message": "You can get in contact with a manager at manager@fountain.com"
    },
    "onboardingContent": {
      "message": "You have a few tasks remaining. Please complete them as soon as possible!"
    },
    "originSystem": "hire"
  },
  "meta": {
    "timestamp": "2021-05-05T09:47:58.924Z",
    "verb": "GET",
    "path": "/api/structure/resources/5949cf7c-fec6-4b31-947c-3aceabff58c5",
    "jti": "%cQN3RIGp",
    "rid": "$2d2zkHZ5",
    "count": 1,
    "status": "200",
    "duration": 17,
    "size": 1234
  }
}