Skip to content

Business profiles

These routes read the profiles the business that connected your app manages: the business itself, and its active brand locations (a brand’s shops, clinics or salons — see Brands and locations). The brands it is a location of, its partners and the brands it carries are other businesses’ profiles and are not listed.

  • A token from the authorization-code grant. A client-credentials token answers 403 0010010000406.
  • The business must keep a valid payment card on file; without one, 403 0010010000407.
  • Scope profile:read, declared by your app and granted by the business on the consent page — see Business resources.
GET /api/profile/v1/profiles?kind=PLACE&page=1&pageSize=20
GET /api/profile/v1/profiles/{id}

kind (any case): PERSON, ORGANIZATION or PLACE. The business comes first, then its locations by country, city and handle. A location hidden from the public brand page is still listed: this is the business’s own view. Any other profile id answers 404.

{
"id": "4c1f8e2a-7b3d-4a96-8e05-1d9c6b2f7a30",
"handle": "mrgroomer.vancouver",
"kind": "PLACE",
"purpose": "BUSINESS",
"displayName": "Mr Groomer Vancouver",
"avatarUrl": "https://gateway.unitedpetclub.com/e/profile/4c1f8e2a-7b3d-4a96-8e05-1d9c6b2f7a30/avatar",
"avatarPath": "/e/profile/4c1f8e2a-7b3d-4a96-8e05-1d9c6b2f7a30/avatar",
"relation": "BRAND_LOCATION",
"createdAt": "2025-04-11T16:02:09Z",
"verifiedTier": "BUSINESS"
}
FieldMeaning
relationSELF for the business, BRAND_LOCATION for one of its locations.
displayNameThe profile’s name, else its handle.
avatarUrlThe avatar (else the logo) as an absolute URL. It redirects to the picture, or answers 404 when there is none or it is private. null when the profile has no avatar or logo.
avatarPathThe same as a path on the United Pet Club origin.
verifiedTierThe verified badge the profile shows: NONE, PERSON (“Verified”), OWNER (“Verified Owner”) or BUSINESS (“Verified Business”). The badge is a paid yearly plan; it reads NONE once the plan ends. Treat any other value as NONE.
StatusplatformResponseCodeCause
4000010010000400page or pageSize out of range.
400Profile_Identity_VL_Request_RJA malformed request.
404Profile_Identity_GT_Missing_FLNot the business or one of its locations.

Everything else follows Errors.