Skip to main content
GET
/
partnerCampaign
/
sharedByMe
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const partnerCampaignListSharedByMeResponse of client.messaging10dlc.partnerCampaigns.listSharedByMe()) {
  console.log(partnerCampaignListSharedByMeResponse.brandId);
}
{
  "page": 123,
  "records": [
    {
      "brandId": "<string>",
      "campaignId": "<string>",
      "usecase": "<string>",
      "createDate": "<string>",
      "status": "<string>"
    }
  ],
  "totalRecords": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1

The 1-indexed page number to get. The default value is 1.

recordsPerPage
integer
default:10

The amount of records per page, limited to between 1 and 500 inclusive. The default value is 10.

Response

Successful Response

page
integer
records
SharedCampaign · object[]
totalRecords
integer