Provider

View as Markdown

GetGET /api/2.0/marketplace-provider/providers/{id}ListGET /api/2.0/marketplace-provider/providersCreatePOST /api/2.0/marketplace-provider/providerUpdatePUT /api/2.0/marketplace-provider/providers/{id}DeleteDELETE /api/2.0/marketplace-provider/providers/{id}

ProviderInfo object

idstringPublic Preview

namestringPublic Preview

descriptionstringPublic Preview

icon_file_pathstringPublic Preview

business_contact_emailstringPublic Preview

support_contact_emailstringPublic Preview

is_featuredbooleanPublic Preview

is_featured is accessible by consumers only

published_bystringPublic Preview

published_by is only applicable to data aggregators (e.g. Crux)

company_website_linkstringPublic Preview

icon_file_idstringPublic Preview

term_of_service_linkstringPublic Preview

privacy_policy_linkstringPublic Preview

dark_mode_icon_file_idstringPublic Preview

dark_mode_icon_file_pathstringPublic Preview

View as Markdown

The ProviderInfo object

{
  "id": "string",
  "name": "string",
  "description": "string",
  "icon_file_path": "string",
  "business_contact_email": "string",
  "support_contact_email": "string",
  "is_featured": true,
  "published_by": "string",
  "company_website_link": "string",
  "icon_file_id": "string",
  "term_of_service_link": "string",
  "privacy_policy_link": "string",
  "dark_mode_icon_file_id": "string",
  "dark_mode_icon_file_path": "string"
}

Get Public Preview

GET /api/2.0/marketplace-provider/providers/{id}

Get provider profile

API scopes: marketplace

Parameters

idstringpath

Response

providerobject

Show child attributesHide child attributes

idstring

namestring

descriptionstring

icon_file_pathstring

business_contact_emailstring

support_contact_emailstring

is_featuredboolean

is_featured is accessible by consumers only

published_bystring

published_by is only applicable to data aggregators (e.g. Crux)

company_website_linkstring

icon_file_idstring

term_of_service_linkstring

privacy_policy_linkstring

dark_mode_icon_file_idstring

dark_mode_icon_file_pathstring

View as Markdown

Response

{
  "provider": {
    "id": "string",
    "name": "string",
    "description": "string",
    "icon_file_path": "string",
    "business_contact_email": "string",
    "support_contact_email": "string",
    "is_featured": true,
    "published_by": "string",
    "company_website_link": "string",
    "icon_file_id": "string",
    "term_of_service_link": "string",
    "privacy_policy_link": "string",
    "dark_mode_icon_file_id": "string",
    "dark_mode_icon_file_path": "string"
  }
}

List Public Preview

GET /api/2.0/marketplace-provider/providers

List provider profiles for account.

API scopes: marketplace

Parameters

page_tokenstringquery

page_sizeint32query

Response

Returns a list of ProviderInfo objects.

View as Markdown

Response

{
  "providers": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "icon_file_path": "string",
      "business_contact_email": "string",
      "support_contact_email": "string",
      "is_featured": true,
      "published_by": "string",
      "company_website_link": "string",
      "icon_file_id": "string",
      "term_of_service_link": "string",
      "privacy_policy_link": "string",
      "dark_mode_icon_file_id": "string",
      "dark_mode_icon_file_path": "string"
    }
  ],
  "next_page_token": "string"
}

Create Public Preview

POST /api/2.0/marketplace-provider/provider

Create a provider

API scopes: marketplace

Request body

providerobject

Show child attributesHide child attributes

idstring

namestring

descriptionstring

icon_file_pathstring

business_contact_emailstring

support_contact_emailstring

is_featuredboolean

is_featured is accessible by consumers only

published_bystring

published_by is only applicable to data aggregators (e.g. Crux)

company_website_linkstring

icon_file_idstring

term_of_service_linkstring

privacy_policy_linkstring

dark_mode_icon_file_idstring

dark_mode_icon_file_pathstring

Response

idstring

View as Markdown

Request

{
  "provider": {
    "id": "string",
    "name": "string",
    "description": "string",
    "icon_file_path": "string",
    "business_contact_email": "string",
    "support_contact_email": "string",
    "is_featured": true,
    "published_by": "string",
    "company_website_link": "string",
    "icon_file_id": "string",
    "term_of_service_link": "string",
    "privacy_policy_link": "string",
    "dark_mode_icon_file_id": "string",
    "dark_mode_icon_file_path": "string"
  }
}

Response

{
  "id": "string"
}

Update Public Preview

PUT /api/2.0/marketplace-provider/providers/{id}

Update provider profile

API scopes: marketplace

Parameters

idstringpath

Request body

providerobject

Show child attributesHide child attributes

idstring

namestring

descriptionstring

icon_file_pathstring

business_contact_emailstring

support_contact_emailstring

is_featuredboolean

is_featured is accessible by consumers only

published_bystring

published_by is only applicable to data aggregators (e.g. Crux)

company_website_linkstring

icon_file_idstring

term_of_service_linkstring

privacy_policy_linkstring

dark_mode_icon_file_idstring

dark_mode_icon_file_pathstring

Response

providerobject

Show child attributesHide child attributes

idstring

namestring

descriptionstring

icon_file_pathstring

business_contact_emailstring

support_contact_emailstring

is_featuredboolean

is_featured is accessible by consumers only

published_bystring

published_by is only applicable to data aggregators (e.g. Crux)

company_website_linkstring

icon_file_idstring

term_of_service_linkstring

privacy_policy_linkstring

dark_mode_icon_file_idstring

dark_mode_icon_file_pathstring

View as Markdown

Request

{
  "provider": {
    "id": "string",
    "name": "string",
    "description": "string",
    "icon_file_path": "string",
    "business_contact_email": "string",
    "support_contact_email": "string",
    "is_featured": true,
    "published_by": "string",
    "company_website_link": "string",
    "icon_file_id": "string",
    "term_of_service_link": "string",
    "privacy_policy_link": "string",
    "dark_mode_icon_file_id": "string",
    "dark_mode_icon_file_path": "string"
  }
}

Response

{
  "provider": {
    "id": "string",
    "name": "string",
    "description": "string",
    "icon_file_path": "string",
    "business_contact_email": "string",
    "support_contact_email": "string",
    "is_featured": true,
    "published_by": "string",
    "company_website_link": "string",
    "icon_file_id": "string",
    "term_of_service_link": "string",
    "privacy_policy_link": "string",
    "dark_mode_icon_file_id": "string",
    "dark_mode_icon_file_path": "string"
  }
}

Delete Public Preview

DELETE /api/2.0/marketplace-provider/providers/{id}

Delete provider

API scopes: marketplace

Parameters

idstringpath

View as Markdown

Response

{}