Get Billing Contacts

Endpoint to get all the billing contacts.

GET /public/v1/billing-service/billing-contacts

Try it

Get Billing Contacts

cURL

curl --request GET \
  --url https://api.topsort.com/public/v1/billing-service/billing-contacts \
  --header 'Authorization: Bearer <token>'

200

{
  "hasMore": true,
  "billingContacts": [
    {
      "id": "<string>",
      "brandName": "<string>",
      "invoiceTo": "<string>",
      "advertiserName": "<string>"
    }
  ],
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="
}

Authorizations

Authorization · string · header · required

A valid API key generated in Topsort's UI.

Query Parameters

external_vendor_id · string

The External ID of the Vendor to retrieve.

Minimum string length: 1

limit · integer · default: 50

The maximum number of items to return per page.

Required range: 1 <= x <= 100

next_page · string

Pagination cursor as provided in an earlier response. If provided will fetch the next page of results.

Response

200

application/json

Successful Response

hasMore · boolean · required

Flag that indicates whether more results are available. true indicates there is a next page of results. false indicates this response contains the last page of results.

billingContacts · PublicBillingContact · object[] · required

List of billing contacts for the vendor.

Show child attributes

billingContacts. id · string · required

The ID of the billing contact.

billingContacts. brandName · string · required

The name of the brand this agency is advertising for.

billingContacts. invoiceTo · string · required

The name of the company that is responsible for the invoice.

billingContacts. advertiserName · string · required

The name of the agency/advertiser.

nextPage · string | null

Pagination cursor. Provide this value as a next_page query parameter in a new request to retrieve the next page of results.

Minimum string length: 1

Example:

"SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="