Skip to main content
GET
Get Tenant Source by RoyaltySource ID
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

Required Permissions

  • sources:read

Important: ID Parameter

The id parameter represents the RoyaltySource ID, not the TenantSource association ID. This endpoint finds the tenant’s source association WHERE RoyaltySourceId = id AND TenantId = authenticated_tenant. Since the composite key is (TenantId, RoyaltySourceId), this uniquely identifies the association.

Business Rules

  • Returns only the authenticated tenant’s association
  • Only shows active sources (isActive=true in RoyaltySource)
Authorization:
  • Required role: user or higher

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Path Parameters

id
string
required

RoyaltySource ID (not TenantSource ID)

Example:

"src-1"

Response

Tenant source details

Association between a tenant and a royalty source. Note: The composite key is (TenantId, RoyaltySourceId).

TenantId
integer

Tenant ID (automatically set from authenticated user)

Example:

1

RoyaltySourceId
string

Royalty source ID

Example:

"src-1"

isActive
boolean
default:true

Whether this source association is active for the tenant

Example:

true

settings
object

Tenant-specific settings for this source

Example:
replacements
object

Tenant-specific field replacements/mappings

Example:
fileCount
integer
default:0

Number of files processed for this tenant-source association

Example:

42

lastProcessedAt
string<date-time> | null

Timestamp of the most recently processed file

Example:

"2026-03-04T14:30:00.000Z"

lastProcessedFileId
string<uuid> | null

ID of the most recently processed file

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

settingsUpdatedAt
string<date-time> | null

When tenant-specific settings were last modified

settingsUpdatedBy
string | null

TenantUserId who last updated the settings

royaltySource
object