Skip to main content
GET
Read a rating program profile and current access

Authorizations

Authorization
string
header
required

Effective API key. Send Authorization: Bearer sk-eai-...

Path Parameters

id
string
required
Pattern: ^[a-z0-9][a-z0-9._-]{0,127}$

Response

Profile, documentation and current access.

name
string
required
Required string length: 1 - 300
description
string | null
required
Maximum string length: 4000
productId
string | null
required
state
string | null
required
Pattern: ^[A-Z]{2}$
carrierId
string | null
required
documentation
string | null
required
Maximum string length: 100000
id
string
required
Pattern: ^[a-z0-9][a-z0-9._-]{0,127}$
productName
string | null
required
carrierName
string | null
required
access
object
required
subscription
object
required
createdAt
string<date-time>
required
createdBy
string
required
updatedAt
string<date-time>
required
updatedBy
string
required