GuidesAPI Reference
API Reference
SupportPartnerStack Login

POST - Trigger a base records export

post
https://api.partnerstack.com/api/v2/exports/base_records

Queues a base records export on behalf of the teammate identified by member_email. When omitted under OAuth2 with an actor token, the authenticated user's email is used. The export will be sent to that member's email address. The export is filtered to the base record types that the member can access; if none of the requested export_types are accessible a 403 is returned.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string | null

Optional filter (YYYY-MM-DD) to limit end date of exported records

export_options
array of strings | null
Defaults to partners,partner_members,customers,transactions,rewards,leads,deals,applications,training

Optional list of export types to include. When omitted, every export type the member has access to is included.

export_options
group_keys
array of strings | null
Defaults to all

Optional filter to limit exported report data to user selected groups. If not provided, all groups will be included.

group_keys
boolean | null
Defaults to true

Whether archived partners should be included in the export

string | null

The email of the company member that the export is being triggered on behalf of. When omitted, the authenticated OAuth user's email is used. The user must have an active membership in your PartnerStack company; permissions, feature access, and group access are evaluated against that membership.

string | null

Optional filter (YYYY-MM-DD) to limit starting date of exported records

string | null

IANA timezone identifier used to bucket start_date / end_date

integer | null

The end user's timezone offset in minutes, used for accurate datetime rendering in emails

string | null

The webhook target URL to send the export to

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?