v1
latestOpenAPI 3.0.22026-07-24800528.1 KBLinks
List all links
Allow vendor to fetch all links for a partnership
get/v2/links/partnership/{identifier}
Path parameters
identifierstring required
Either user email, partnership_key, or partner_key. Will be used to pull partnership using company auth
Query parameters
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
Allow vendor to fetch all links for a partnership
Example response
{
"data": {
"items": [
{
"created_at": 1574181282399,
"key": "co_a80cb515fe",
"updated_at": 1574181282399,
"dest": "https://partnerstack.com",
"member_email": "ash.ketchum@email.com",
"member_name": "Ash Ketchum",
"name": "Company Created Link",
"url": "https://companyname.grsm.io/slug"
}
]
}
}