List all partnerships

get

https://api.partnerstack.com/api/v2/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

min_created

int64

Applies a minimum epoch timestamp (ms) filter to the response created_at.

max_created

int64

Applies a maximum epoch timestamp (ms) filter to the response created_at.

min_updated

int64

Applies a minimum epoch timestamp (ms) filter to the response updated_at.

max_updated

int64

Applies a maximum epoch timestamp (ms) filter to the response updated_at.

group

string

Will filter for partnerships who are in a group with the specified name. Name must have spaces and special characters removed.

order_by

string

enum

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

Allowed:

string

The email of the user with the partnership you're looking for.

approved_status

string

enum

The approved status of a partnership. Approved means the partner is approved to be in your program. Pending means that partner's application is pending. Declined means the partner application was declined.

Allowed:

include_archived

boolean

Include archived partnerships in the response.

limit

integer

1 to 250

Defaults to 10

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

starting_after

string

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_before

string

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.

Responses

200Returns 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.

400Bad Request Error

401Unauthorized Error

403Forbidden Error

404Not Found Error

500Internal Server Error