Skip to main content
API docs by Redocly

Stream Partner API (1.0)

Download OpenAPI specification:Download

The Enterprise API for all Stream Partners.

Tokens

getPartnerTokens

Authorizations:
bearer
query Parameters
org_id
required
string

Responses

Response samples

Content type
application/json
[
  • { }
]

createPartnerToken

Authorizations:
bearer
Request Body schema: application/json
org_id
required
string
token_name
required
string
scopes
required
Array of strings
Items Enum: "user" "onboarding" "legacy_onboarding" "sso" "billing"

Responses

Request samples

Content type
application/json
{
  • "org_id": "string",
  • "token_name": "string",
  • "scopes": [
    ]
}

Response samples

Content type
application/json
{ }

renamePartnerToken

Authorizations:
bearer
path Parameters
token_id
required
string
Request Body schema: application/json
token_name
required
string

Responses

Request samples

Content type
application/json
{
  • "token_name": "string"
}

Response samples

Content type
application/json
{ }

deletePartnerToken

Authorizations:
bearer
path Parameters
token_id
required
string

Responses

OAuth

token

Request Body schema: application/json
grant_type
required
string
Enum: "client_credentials" "refresh_token"

The type of grant you are requesting, must be "client_credentials" or "refresh_token"

client_id
required
string

The API Key given by the application

client_secret
required
string

The API Token given by the application

exp
number

The expiration time of the assertion, specified as seconds since 00:00:00 UTC, January 1, 1970. This value has a maximum of 1 hour after the issued time.

scopes
Array of strings
Items Enum: "user" "onboarding" "legacy_onboarding" "sso" "billing"

The list of the permissions that the application requests.

refresh_token
string

The refresh token only when grant_type is set to "refresh_token"

Responses

Request samples

Content type
application/json
{
  • "grant_type": "client_credentials",
  • "client_id": "string",
  • "client_secret": "string",
  • "exp": 0,
  • "scopes": [
    ],
  • "refresh_token": "string"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "token_type": "bearer",
  • "refresh_token": "string",
  • "expires_in": 0,
  • "refresh_token_expires_in": 0,
  • "scopes": [
    ]
}

White Label - SSO

generateSSOSession

Authorizations:
bearer
query Parameters
partner_id
string
Request Body schema: application/json
email
required
string
full_name
required
string
phone_number
required
string
role
string
Enum: "owner" "admin" "manager" "team_member" "custom"
provider_org_id
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "full_name": "string",
  • "phone_number": "string",
  • "role": "owner",
  • "provider_org_id": "string"
}

Response samples

Content type
application/json
{
  • "sso_login_token": "string"
}

Onboarding - Integrations

Initialize OAuth integration flow

Initializes OAuth flow and returns an entry_url to begin authorization.

Authorizations:
bearer
Request Body schema: application/json
org_id
required
string
source
required
string
type
required
string
Enum: "pos" "dsp"
return_url
required
string

Responses

Request samples

Content type
application/json
{
  • "org_id": "string",
  • "source": "string",
  • "type": "pos",
  • "return_url": "string"
}

Response samples

Content type
application/json
{
  • "onboarding": {
    }
}

Get OAuth integration status

Retrieves current status and details of an onboarding integration.

Authorizations:
bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "org_id": "string",
  • "merchant_id": "string",
  • "type": "pos",
  • "status": "pending",
  • "partner_id": "string",
  • "partner_org_id": "string",
  • "source": "string",
  • "entry_url": "string",
  • "return_url": "string",
  • "integration_id": "string"
}

Complete OAuth integration

Exchanges OAuth code from redirect URL and activates the integration.

Authorizations:
bearer
path Parameters
id
required
string
Request Body schema: application/json
code
required
string

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "org_id": "string",
  • "merchant_id": "string",
  • "type": "pos",
  • "status": "pending",
  • "partner_id": "string",
  • "partner_org_id": "string",
  • "source": "string",
  • "entry_url": "string",
  • "return_url": "string",
  • "integration_id": "string"
}

Revoke OAuth integration

Revokes OAuth access and deprovisions the active integration.

Authorizations:
bearer
path Parameters
id
required
string

Responses

Onboarding - Locations

List onboarding locations

Retrieves locations associated with an onboarding integration

Authorizations:
bearer
query Parameters
onboarding_id
required
string

Responses

Response samples

Content type
application/json
{
  • "locations": [
    ]
}

Ingest POS locations

Imports location data from the point-of-sale system

Authorizations:
bearer
Request Body schema: application/json
onboarding_id
required
string
required
Array of objects (IngestOnboardingLocation)

Responses

Request samples

Content type
application/json
{
  • "onboarding_id": "string",
  • "locations": [
    ]
}

Response samples

Content type
application/json
{
  • "locations": [
    ]
}

Bind DSP locations

Associates DSP locations with POS locations

Authorizations:
bearer
Request Body schema: application/json
onboarding_id
required
string
required
Array of objects (BindOnboardingLocation)

Responses

Request samples

Content type
application/json
{
  • "onboarding_id": "string",
  • "locations": [
    ]
}

Response samples

Content type
application/json
{
  • "locations": [
    ]
}

Onboarding - Org

Create organization

Creates a new organization in the partner whitelabel

Authorizations:
bearer
Request Body schema: application/json
name
required
string
provider_id
required
string
required
object (CreateUserOrgUser)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "provider_id": "string",
  • "user": {
    }
}

Response samples

Content type
application/json
{
  • "org_id": "string",
  • "user_id": "string"
}

List organization locations

Returns POS or DSP locations for an organization

Authorizations:
bearer
path Parameters
id
required
string
query Parameters
location_id
string

Responses

Response samples

Content type
application/json
{
  • "locations": [
    ]
}

getBillingReports

query Parameters
partner_id
string

Responses

Response samples

Content type
application/json
{ }

getRawReportData

query Parameters
file_name
required
string
partner_id
required
string

Responses

Response samples

Content type
application/json
{
  • "reportMonth": "string",
  • "partnerId": "string",
  • "locations": [
    ],
  • "metrics": {
    }
}

getBillingReportInvoice

query Parameters
file_name
required
string
partner_id
required
string

Responses

Response samples

Content type
application/json
"string"