All pages
Powered by GitBook
1 of 1

Loading...

List vendor profiles

get

Streaming read mode (MPT-Streaming: true) reads the whole filtered, sorted result set as a stream. Two obligations are mandatory for a correct read:

  • Verify completeness — compare the objects received with MPT-Item-Count. A mid-stream failure aborts the connection without completing the message, so a truncated body is the only failure signal.

  • Check $meta.deleted before ingesting — a record deleted, or moved out of scope, after the stream started arrives as an ID-only stub. Ingesting one as data overwrites a stored record. Soft-deleted records are ordinary records.

Header parameters
MPT-StreamingbooleanOptional

Stream the full result set instead of a page. Membership fixes at stream start, each record is emitted once, and MPT-Item-Count gives the exact count. Accept: application/jsonl for line-delimited output. A positive limit caps the stream, -1 or absent reads all; offset skips that many records of the requested order, so limit and offset together read one window. Each window is its own snapshot — consecutive windows are not a resumable export.

Responses
200

OK

Streamed and paged responses both answer 200. Only a streamed one carries the MPT-Streaming and MPT-Item-Count headers listed below.

application/jsonl: one object per line, no envelope, so the schema describes one line. A line is a record or an ID-only deleted stub (StreamedDeletedRecord) — check $meta.deleted before ingesting. Blank lines are keep-alives.

MPT-StreamingbooleanOptional

Streamed responses only, where it is true. Absent on a paged response.

MPT-Item-Countinteger · int64Optional

Streamed responses only. Absent on a paged response. The exact object count — compare it with the number received.

offsetinteger · int32Optional
limitinteger · int32Optional
totalinteger · int32 · nullableOptional
omittedstring[]Optional
idstringOptional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
descriptionstring · nullableOptional

Descriptive text that provides details about the vendor.

featuredboolean · nullableOptional

Indicates whether the vendor profile is marked as featured.

websitestring · nullableOptional

The vendor's official website URL.

linkedInstring · nullableOptional

URL of the vendor's LinkedIn profile.

facebookstring · nullableOptional

URL of the vendor's Facebook page.

youTubestring · nullableOptional

URL of the vendor's YouTube channel.

xProfilestring · nullableOptional

URL of the vendor's X (formerly Twitter) profile.

idstringOptional
namestringOptional
revisioninteger · int32Optional
statusstring · enumOptionalPossible values:
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
descriptionstring · nullableOptional

Descriptive text that provides details about the vendor.

featuredboolean · nullableOptional

Indicates whether the vendor profile is marked as featured.

websitestring · nullableOptional

The vendor's official website URL.

linkedInstring · nullableOptional

URL of the vendor's LinkedIn profile.

facebookstring · nullableOptional

URL of the vendor's Facebook page.

youTubestring · nullableOptional

URL of the vendor's YouTube channel.

xProfilestring · nullableOptional

URL of the vendor's X (formerly Twitter) profile.

idstringOptional
namestringOptional
revisioninteger · int32Optional
statusstring · enumOptionalPossible values:
productProfilesobject · ProductProfileRef[] · nullableOptional
⤷Circular reference to object · ProductProfileRef[]
idstringOptional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
pyraTenantIdstring · uuid · nullableOptional
externalIdstring · nullableOptional
externalNamestring · nullableOptional
addressLine1string · nullableOptional
addressLine2string · nullableOptional
postCodestring · nullableOptional
citystring · nullableOptional
statestring · nullableOptional
countrystring · nullableOptional
technicalSupportEmailstring · nullableOptional
websitestring · nullableOptional
descriptionstring · nullableOptional
idstringOptional
namestringOptional
revisioninteger · int32Optional
descriptionstring · nullableOptional
logostring · nullableOptional
isDefaultbooleanOptional
clientbooleanOptional
partnerbooleanOptional
defaultLanguageCodestring · nullableOptional
operationsstring · nullableOptional

The operations (Navision) publisher code for the vendor.

productHubany · nullableOptional

Product Hub publisher fields, stored verbatim as a JSON document.

statusstring · enumOptional

Current publication status of the vendor profile.

Possible values:
operationsstring · nullableOptional

The operations (Navision) identifier of the product profile.

statusstring · enumOptional

Current publication status of the product profile.

Possible values:
idstringOptional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
pyraTenantIdstring · uuid · nullableOptional
externalIdstring · nullableOptional
externalNamestring · nullableOptional
addressLine1string · nullableOptional
addressLine2string · nullableOptional
postCodestring · nullableOptional
citystring · nullableOptional
statestring · nullableOptional
countrystring · nullableOptional
technicalSupportEmailstring · nullableOptional
websitestring · nullableOptional
descriptionstring · nullableOptional
idstringOptional
namestringOptional
revisioninteger · int32Optional
descriptionstring · nullableOptional
logostring · nullableOptional
isDefaultbooleanOptional
clientbooleanOptional
partnerbooleanOptional
defaultLanguageCodestring · nullableOptional
operationsstring · nullableOptional

The operations (Navision) publisher code for the vendor.

productHubany · nullableOptional

Product Hub publisher fields, stored verbatim as a JSON document.

statusstring · enumOptional

Current publication status of the vendor profile.

Possible values:
400

Invalid RQL, or invalid paging. limit must be positive (caps the stream) or -1 / absent (reads all); offset must be a non-negative integer.

No content

406

No acceptable media type. application/jsonl without the MPT-Streaming header lands here.

No content

413

The result set exceeds the configured stream key cap. Nothing is written to the body.

No content

501

This resource's query service provides no streaming capability.

No content

get/public/v1/public-catalog/vendor-profiles
GET /public/v1/public-catalog/vendor-profiles HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
  "$meta": {
    "pagination": {
      "offset": 1,
      "limit": 1,
      "total": 1
    },
    "omitted": [
      "text"
    ]
  },
  "data": [
    {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-01-01T00:00:00.000Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-01-01T00:00:00.000Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "published": {
          "at": "2026-01-01T00:00:00.000Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "unpublished": {
          "at": "2026-01-01T00:00:00.000Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1,
      "description": "text",
      "featured": true,
      "website": "text",
      "linkedIn": "text",
      "facebook": "text",
      "youTube": "text",
      "xProfile": "text",
      "categories": [
        {
          "id": "text",
          "name": "text",
          "revision": 1,
          "status": "Draft"
        }
      ],
      "productProfiles": [
        {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1,
          "vendorProfile": "[Circular Reference]",
          "externalIds": {
            "operations": "text"
          },
          "status": "Draft"
        }
      ],
      "vendor": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "updated": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "icon": "text",
        "revision": 1,
        "type": "Client",
        "status": "Active",
        "externalIds": {
          "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "externalId": "text",
        "externalName": "text",
        "address": {
          "addressLine1": "text",
          "addressLine2": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "technicalSupportEmail": "text",
        "website": "text",
        "description": "text",
        "groups": [
          {
            "id": "text",
            "name": "text",
            "revision": 1,
            "description": "text",
            "logo": "text",
            "isDefault": true
          }
        ],
        "eligibility": {
          "client": true,
          "partner": true
        },
        "defaultLanguageCode": "text"
      },
      "externalIds": {
        "operations": "text"
      },
      "attributes": {
        "productHub": null
      },
      "status": "Draft"
    }
  ]
}
A retry is a new snapshot: discard the failed attempt rather than appending to it.

Client timeouts. Set no total-request deadline — a stream lasts as long as its result set takes. Size the two limits that remain: allow at least 60s to the first byte, since nothing is on the wire while the key snapshot runs, and more than 30s between bytes, since idle gaps carry only keep-alive whitespace. One scalar timeout applied to connect and read alike trips on both.