Skip to content

Retrieve the partner profile

GET
/api/v1/partnership/profile/
curl --request GET \
--url https://public.api.barestho.com/api/v1/partnership/profile/ \
--header 'Authorization: Basic <credentials>'

Returns the profile information of the currently authenticated partner. This may include contact details, branding settings, and configuration options specific to your integration.

The partner profile data as a list of profile objects.

Media type application/json

Represents a partner profile. It contains information shown to restaurants in their partners list.

object
uuid

Unique partner UUID used for authentication.

string
name

Partner’s display name. This value is shown to restaurants.

string
description

Object containing localized partner descriptions (e.g. { fr: "Partenaire Barestho", nl: "Partner van Barestho" }). This value is shown to restaurants.

object
fr

French translation.

string
nl

Dutch translation.

string
en

English translation.

string
de

German translation.

string
website_url

Url to the partner website. This value is shown to restaurants.

string format: url
nullable
Example generated
{
"name": "example",
"description": {
"fr": "example",
"nl": "example",
"en": "example",
"de": "example"
},
"website_url": "example"
}