v1

latestOpenAPI 3.0.22026-07-24800528.1 KB

Partnerships

List all partnerships

Returns a list of partnerships you manage or are owned by you. The partnerships are returned sorted by creation date by default, with the most recent partnerships appearing first.

get/v2/partnerships

Query parameters

order_by'-created_at' | 'created_at' | '-updated_at' | 'updated_at'

The field in which the results are ordered by. A - prefix denotes that the results are in descending order.

has_sub_id'true' | 'false' | 'null'

Whether the company is using sub IDs. Can be true, false, or null.

include_offersboolean

Include offers in the response.

include_archivedboolean

Include archived partnerships in the response.

limitinteger

A limit on the number of items to be returned. Limits can range between 1 and 250, and the default is 10.

starting_afterstring

A cursor for use in pagination, starting_after takes in an item key and the subsequent call will return the following items in the list. This is mutually exclusive with ending_before.

ending_beforestring

A cursor for use in pagination, ending_before takes in an item key and the subsequent call will return the prior items in the list. This is mutually exclusive with starting_after.

Response

Returns a list of partnerships you manage or are owned by you. The partnerships are returned sorted by creation date by default, with the most recent partnerships appearing first.

messagestring required

statusinteger required

Example response

{
  "data": {
    "items": [
      {
        "created_at": 1574181282399,
        "key": "co_a80cb515fe",
        "updated_at": 1574181282399,
        "company": {
          "key": "co_UD9407hi0jFiFe",
          "name": "Nice Company",
          "id": 12345
        },
        "status": "active",
        "link": {
          "destination": "https://partnerstack.com",
          "key": "link_787j5aOLRR76yi",
          "stack_key": "stck_787j5aOLRR76yi",
          "url": "https://companyname.grsm.io/slug"
        }
      }
    ]
  }
}