Get your business profile
Retrieve the profile of the business you are authenticated as.
Required permissions: business:read.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Headers
X-Penny-As-Business
Act on behalf of another business that has granted you access. Requires the business:act_as permission.
Response
Your business profile.
business_id
Penny's unique identifier for this business.
alias
The business's organization or brand name.
version
A number that increases each time this business's details change. Use it to confirm you are looking at the latest information.
version_time
The date and time this business's details were last changed.
status
The business’s current lifecycle status: ‘onboarding’ (setup in progress), ‘active’, ‘deactivated’ (paused), ‘suspended’ (restricted, typically due to a policy concern), or ‘closed’.
Allowed values:
active
Whether this business is currently active.
closed
Whether this business has been closed.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error