OpenAPI Specification
openapi: 3.0.0
info:
title: Thrive Global Partner audio experiences auth API
description: 'API for accessing Thrive Global content and features. All content endpoints require a Bearer token obtained via the authentication endpoint.
Response envelopes follow the pattern `{ message, valid, data }` where `data` contains the response payload. Collection endpoints nest items at a resource-specific path (e.g. `data.data.reset.thrive.get.items`).'
version: 1.7.0
contact:
name: Thrive Global
url: https://thriveglobal.com/contact/sales
servers:
- url: https://partners-api.thriveglobal.com
description: Production server
- url: https://partners-api-stag.thriveglobal.com
description: Staging server
tags:
- name: auth
description: Partner authentication
paths:
/v1/auth:
post:
operationId: authenticatePartner
tags:
- auth
summary: Authenticate and obtain a bearer token
description: Exchange your API key for a JWT bearer token. Optionally provide a userId.
security:
- ApiKeyAuth: []
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
userId:
type: string
description: User identifier. Defaults to SmokeTestUser if omitted.
example: thrive:developerPortalTest:1709740800
responses:
'200':
description: Authentication successful
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
logMeWith:
type: object
properties:
partner:
type: object
properties:
token:
type: string
description: JWT bearer token (valid for 12 hours)
'400':
description: Missing API key
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Invalid API key or authentication failure
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Company validation failure
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
ErrorResponse:
type: object
required:
- message
- valid
properties:
message:
type: string
valid:
type: boolean
example: false
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT