Skip to main content
GET
Get a consumer

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-api-version
string
default:2.0.0
required

Path Parameters

consumer_id
string
required

Unique ID of the consumer that you have registered when the user was onboarded.

Required string length: 2 - 100

Response

Successful Response

id
string
required

Unique identifier for a consumer on your system, alphanumeric string with optional dashes or underscores

Pattern: ^[a-zA-Z0-9_-]+$
Example:

"consumer-12345"

onboarding_at
string<date-time>
required

When the consumer was onboarded on the Paylead platform.

perks
PerksEnrollmentOut · object | null
slc
SlcEnrollmentOut · object | null