Skip to main content
GET
https://api-staging.withbenji.com
/
partnerships
/
{id}
Get Partnership
curl --request GET \
  --url https://api-staging.withbenji.com/partnerships/{id} \
  --header 'x-api-key: <api-key>'
{
  "partnership": {
    "uuid_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "img": "<string>",
    "merchant_id": 123,
    "related_partner_id": 123,
    "partner_id": 123,
    "is_active": 123,
    "is_deleted": 123,
    "owner_id": 123,
    "total_rewards_earned": 123,
    "total_rewards_redeemed": 123,
    "num_of_transactions": 123,
    "is_demo": 123,
    "created_date": "<string>",
    "campaigns": [
      {}
    ]
  }
}
The x-api-key header value to be used on this API is your partner API key, which can be generated through the dashboard.
id
string
required
Unique identifier of the partnership to retrieve (UUID)

Response

partnership
object
required
The partnership object containing all partnership details including its configuration, associated campaigns, and performance metrics.
This endpoint retrieves detailed information about a specific partnership, including all associated campaigns and performance metrics.