Skip to content
BudSense Partner API - staging

Get Partner Configuration

GET
/v1/partner
curl --request GET \
  --url https://example.com/v1/partner

Retrieves the your partner configuration, including a list of companies and respective locations you have access to.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”
Media typeapplication/json
object
allowedCompanies
required
Array<object>
object
allowedFields
required
object
badges
required
boolean
displayNameOverrides
required
boolean
labels
required
boolean
id
required
string
locations
required
Array<object>
object
id
required
string
name
required
string
providerId
required
string
name
required
string
provider
required
string
providerId
required
string
enabled
required
boolean
partnerId
required
string
partnerName
required
string
webhook
required
object
enabled
required
boolean
url
required
string
Examplegenerated
{
  "allowedCompanies": [
    {
      "allowedFields": {
        "badges": true,
        "displayNameOverrides": true,
        "labels": true
      },
      "id": "example",
      "locations": [
        {
          "id": "example",
          "name": "example",
          "providerId": "example"
        }
      ],
      "name": "example",
      "provider": "example",
      "providerId": "example"
    }
  ],
  "enabled": true,
  "partnerId": "example",
  "partnerName": "example",
  "webhook": {
    "enabled": true,
    "url": "example"
  }
}

Headers

Section titled “ Headers ”
Access-Control-Allow-Origin
string
default: *
Example
*

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

401

Section titled “ 401 ”
Media typeapplication/json
object
body
required
code
required
integer
message
required
string
suggestion
required
string
title
required
string
Examplegenerated
{
  "body": "example",
  "code": 1,
  "message": "example",
  "suggestion": "example",
  "title": "example"
}

Headers

Section titled “ Headers ”
Access-Control-Allow-Origin
string
default: *
Example
*

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

500

Section titled “ 500 ”
Media typeapplication/json
object
body
required
code
required
integer
message
required
string
suggestion
required
string
title
required
string
Examplegenerated
{
  "body": "example",
  "code": 1,
  "message": "example",
  "suggestion": "example",
  "title": "example"
}

Headers

Section titled “ Headers ”
Access-Control-Allow-Origin
string
default: *
Example
*

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link