v1

latestOpenAPI 3.0.22026-07-24800528.1 KB

Partnerships

Retrieve a partnership

Retrieves the details of an existing partnership.

get/v2/partnerships/{unique_identifier}

Path parameters

unique_identifierstring required

Unique identifier of partnership. Can be partner_key, internal partnership_key or email.

Response

Retrieves the details of an existing partnership.

messagestring required

statusinteger required

Example response

{
  "data": {
    "created_at": 1574181282399,
    "key": "co_a80cb515fe",
    "updated_at": 1574181282399,
    "claimed_at": 1614000000,
    "email": "johnsmith@gmail.com",
    "fields": [
      {
        "field_key": "field_fjkdlrh9i32nfew",
        "name": "Company Address"
      }
    ],
    "first_name": "John",
    "last_name": "Smith",
    "manager_email": "alicebaz@gmail.com",
    "manager_name": "Alice Baz",
    "partner_key": "gstest",
    "group": {
      "created_at": 1574181282399,
      "key": "co_a80cb515fe",
      "updated_at": 1574181282399,
      "name": "Resellers",
      "slug": "resellers"
    },
    "tier": {
      "key": "tag_a80cb515fe",
      "name": "Tier 1"
    },
    "parent_partnership_key": "part_1234567890"
  }
}