Skip to content
Ads API •References / partnerships / Get partnerships for a business

Get partnerships for a business

Retrieve all partnerships associated with a business

Request

  • business_id
    string [uuid]
    Required

    A unique identifier for a Business.

    Example: ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a

Response

Partnerships retrieved successfully

Response containing partnerships for a business

  • Required

    List of partnerships

    A partnership between two entities

    • id
      string [uuid]
      Required

      A unique identifier for the entity.

      Example: "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"
    • partnership_status
      string
      Required

      status level for the partnership

      Allowed values: "PENDING", "ACTIVE", "SUSPENDED", "TERMINATED"Example: "READ_WRITE"
    • version
      string
      Required

      Version of the partnership

      Example: "1.0"

Response sample

{  "partnerships": [    {      "id": "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a",      "partnership_status": "READ_WRITE",      "version": "1.0"    }  ]}