API Documentation
Member API
Reward API
Partnerships
Webhooks
Get Partnership
curl --request GET \
--url https://api-staging.withbenji.com/partnerships/{id} \
--header 'x-api-key: <api-key>'{
"code": "ok",
"data": {
"partnership": {
"uuid_id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Test Partnership",
"description": "A partnership between merchant and loyalty partner",
"img": "https://example.com/partnership-logo.png",
"merchant_id": 1,
"related_partner_id": null,
"partner_id": 3,
"is_active": 1,
"is_deleted": 0,
"owner_id": 5,
"total_rewards_earned": 15000,
"total_rewards_redeemed": 3200,
"num_of_transactions": 142,
"is_demo": 0,
"created_date": "2024-11-20T00:30:57.256493+00:00",
"campaigns": null
}
}
}
Partnerships
Get Partnership
Get a single partnership by ID
GET
/
partnerships
/
{id}
Get Partnership
curl --request GET \
--url https://api-staging.withbenji.com/partnerships/{id} \
--header 'x-api-key: <api-key>'{
"code": "ok",
"data": {
"partnership": {
"uuid_id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Test Partnership",
"description": "A partnership between merchant and loyalty partner",
"img": "https://example.com/partnership-logo.png",
"merchant_id": 1,
"related_partner_id": null,
"partner_id": 3,
"is_active": 1,
"is_deleted": 0,
"owner_id": 5,
"total_rewards_earned": 15000,
"total_rewards_redeemed": 3200,
"num_of_transactions": 142,
"is_demo": 0,
"created_date": "2024-11-20T00:30:57.256493+00:00",
"campaigns": null
}
}
}
The
x-api-key header value to be used on this API is your partner API key, which can be generated through the dashboard.Unique identifier of the partnership to retrieve (UUID)
Response
The partnership object containing all partnership details including its configuration, associated campaigns, and performance metrics.
Hide properties
Hide properties
The UUID identifier of the partnership. This is an alternative identifier that can be used in API operations.
The name of the partnership that is displayed to users and administrators. Identifies the business relationship between a merchant and partner.
A detailed description of the partnership explaining its purpose, benefits, and terms. May be null if no description is provided.
The URL to the partnership logo or image that is displayed in marketing materials and the user interface. May be null if no image is provided.
The unique identifier of the merchant in this partnership. Merchants are businesses where users can earn or redeem rewards.
The unique identifier of the related partner in this partnership. May be null if no related partner is specified.
The unique identifier of the partner in this partnership. Partners are loyalty program providers who offer rewards to users.
Indicates whether this partnership is currently active and available to users. Values: 1=active, 0=inactive. Inactive partnerships do not generate rewards.
Indicates whether this partnership has been marked as deleted. Values: 1=deleted, 0=not deleted. Deleted partnerships are not shown in standard API responses.
The unique identifier of the user who created or owns this partnership. Used for attribution and permission management.
The total amount of rewards that users have earned through this partnership so far, in the smallest currency unit (e.g., cents). May be null if no rewards have been earned yet.
The total amount of rewards that users have redeemed through this partnership so far, in the smallest currency unit (e.g., cents). May be null if no rewards have been redeemed yet.
The total number of transactions that have occurred within this partnership. Used for analytics and reporting. May be null if no transactions have occurred yet.
Indicates whether this partnership is for demonstration purposes only. Values: 1=demo, 0=real. Demo partnerships are not included in production reports.
The date and time when this partnership was created, in ISO 8601 format. Used for auditing and sorting.
The list of campaigns associated with this partnership. Each campaign defines specific reward structures and eligibility criteria. May be null if no campaigns exist for this partnership yet.
{
"code": "ok",
"data": {
"partnership": {
"uuid_id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Test Partnership",
"description": "A partnership between merchant and loyalty partner",
"img": "https://example.com/partnership-logo.png",
"merchant_id": 1,
"related_partner_id": null,
"partner_id": 3,
"is_active": 1,
"is_deleted": 0,
"owner_id": 5,
"total_rewards_earned": 15000,
"total_rewards_redeemed": 3200,
"num_of_transactions": 142,
"is_demo": 0,
"created_date": "2024-11-20T00:30:57.256493+00:00",
"campaigns": null
}
}
}
This endpoint retrieves detailed information about a specific partnership, including all associated campaigns and performance metrics.
Was this page helpful?
⌘I
Assistant
Responses are generated using AI and may contain mistakes.