API reference
Supported services
Every service you can request access to with the API, and the roles you can ask for. Your integration gets the same list from GET /services; this page shows it without an API key.
Using these values
When you create a request, use a service ID as the key in requestedServices and one of its role values as accessLevel. Leave accessLevel out for services without roles. The list is the same for every agency.
{
"clientId": "CLIENT_ID",
"requestedServices": {
"Google Ads": { "accessLevel": "ADMIN", "requestedAccountLinks": [{ "internalAccountId": "ACCOUNT_ID" }] },
"Klaviyo Account": { "accessLevel": "Manager", "requestedAccountLinks": [{ "internalAccountId": "ACCOUNT_ID" }] }
}
}Each service has a grant method (grantMethod):
automatic: the client signs in with the platform and AgencyAccess grants the access for them.manual: the client follows guided steps to grant the access themselves. Some of these services ask the client to sign in with the platform first (clientSignInRequired).
Roles marked read-only have readOnly: true. A few services need extra fields on each account link in requestedAccountLinks (accountLinkFields); they are listed with the service.
All services
| Service ID | Platform | Grant method | Client signs in |
|---|---|---|---|
Google Ads | automatic | Yes | |
Google Ads MCC | automatic | Yes | |
Google Analytics | automatic | Yes | |
Google Tag Manager | automatic | Yes | |
Google Merchant Center | automatic | Yes | |
Google Search Console | manual | Yes | |
YouTube Studio | manual | No | |
Google Business Profile | manual | No | |
Looker Studio | manual | No | |
Twitter Ads | manual | No | |
Twitter Delegate Account | manual | No | |
Pinterest Ads | manual | No | |
Amazon Ads | Amazon | automatic | Yes |
Snapchat Ads | Snapchat | automatic | Yes |
Snapchat Business | Snapchat | automatic | Yes |
Shopify Store Collaborator | Shopify | manual | No |
Facebook Pages | Meta | automatic | Yes |
Meta Ads | Meta | manual | Yes |
Facebook Product Catalog | Meta | automatic | Yes |
Meta Pixels | Meta | manual | Yes |
Instagram | Meta | manual | No |
HubSpot Partner | HubSpot | manual | No |
ProfitMetrics Partner | ProfitMetrics | manual | No |
LinkedIn Company Page | manual | No | |
LinkedIn Ads | automatic | Yes | |
Klaviyo Account | Klaviyo | manual | No |
Mailchimp Dashboard | Mailchimp | manual | No |
WordPress Site | WordPress | automatic | Yes |
Lightspeed C-Series | Lightspeed | manual | No |
Microsoft Ads | Microsoft | automatic | Yes |
Microsoft Clarity | Microsoft | manual | No |
Channable Dashboard | Channable | manual | No |
Cookiebot | Cookiebot | manual | No |
Reddit Ads | manual | No | |
Apple Search Ads | Apple | manual | No |
Hotjar Dashboard | Hotjar | manual | No |
ActiveCampaign Account | ActiveCampaign | manual | No |
Wix Site | Wix | manual | No |
Webflow Site | Webflow | manual | No |
Google Ads
Automatic: the client signs in with Google and AgencyAccess grants the access.
| Role | accessLevel | Read-only |
|---|---|---|
| Admin | ADMIN | |
| Standard | STANDARD | |
| Read Only | READ_ONLY | Yes |
| Email Only | EMAIL_ONLY | Yes |
Google Ads MCC
Automatic: the client signs in with Google and AgencyAccess grants the access. Each account link needsgoogleAdsMccAccountId.
No roles: leave out accessLevel.
Google Analytics
Automatic: the client signs in with Google and AgencyAccess grants the access.
| Role | accessLevel | Read-only |
|---|---|---|
| Admin | predefinedRoles/admin | |
| Editor | predefinedRoles/editor | |
| Analyst | predefinedRoles/analyst | |
| Viewer | predefinedRoles/viewer | Yes |
Google Tag Manager
Automatic: the client signs in with Google and AgencyAccess grants the access.
| Role | accessLevel | Read-only |
|---|---|---|
| Admin | admin | |
| User | user | Yes |
Google Merchant Center
Automatic: the client signs in with Google and AgencyAccess grants the access.
| Role | accessLevel | Read-only |
|---|---|---|
| Admin | admin | |
| Order Manager | orderManager | |
| Payments Manager | paymentsManager | |
| Payments Analyst | paymentsAnalyst | |
| Reporting Manager | reportingManager | Yes |
Google Search Console
Manual: the client signs in with Google, then follows guided steps to grant the access.
| Role | accessLevel | Read-only |
|---|---|---|
| Owner | Owner | |
| Full | Full | |
| Restricted | Restricted | Yes |
YouTube Studio
Manual: the client follows guided steps to grant the access in Google.
| Role | accessLevel | Read-only |
|---|---|---|
| Manager | Manager | |
| Editor | Editor | |
| Editor (limited) | Editor (limited) | |
| Subtitle editor | Subtitle editor | |
| Viewer | Viewer | |
| Viewer (limited) | Viewer (limited) |
Google Business Profile
Manual: the client follows guided steps to grant the access in Google.
| Role | accessLevel | Read-only |
|---|---|---|
| Owner | Owner | |
| Manager | Manager | Yes |
Looker Studio
Manual: the client follows guided steps to grant the access in Google.
| Role | accessLevel | Read-only |
|---|---|---|
| Owner | Owner | |
| Editor | Editor | |
| Viewer | Viewer | Yes |
Twitter Ads
Manual: the client follows guided steps to grant the access in Twitter.
| Role | accessLevel | Read-only |
|---|---|---|
| Account administrator | Account administrator | |
| Ad manager | Ad manager | |
| Campaign analyst | Campaign analyst | Yes |
| Organic analyst | Organic analyst | Yes |
| Partner audience manager | Partner audience manager |
Twitter Delegate Account
Manual: the client follows guided steps to grant the access in Twitter.
| Role | accessLevel | Read-only |
|---|---|---|
| Contributor | Contributor | |
| Admin | Admin |
Pinterest Ads
Manual: the client follows guided steps to grant the access in Pinterest.
| Role | accessLevel | Read-only |
|---|---|---|
| Admin | Admin | |
| Analyst | Analyst | |
| Finance | Finance | |
| Audience | Audience | |
| Campaign | Campaign | |
| Catalogues | Catalogues |
Amazon
Amazon Ads
Automatic: the client signs in with Amazon and AgencyAccess grants the access.
No roles: leave out accessLevel.
Snapchat
Snapchat Ads
Automatic: the client signs in with Snapchat and AgencyAccess grants the access.
| Role | accessLevel | Read-only |
|---|---|---|
| Account Admin | ADMIN | |
| Campaign Manager | GENERAL | |
| Data Manager | AUDIENCE | |
| Data Analyst | REPORTS | Yes |
| Creative Manager | CREATIVE |
Snapchat Business
Automatic: the client signs in with Snapchat and AgencyAccess grants the access.
| Role | accessLevel | Read-only |
|---|---|---|
| Organization Admin | ADMIN | |
| Business Admin | BUSINESS_ADMIN | |
| Member | MEMBER | |
| Data Admin | DATA_ADMIN |
Shopify
Shopify Store Collaborator
Manual: the client follows guided steps to grant the access in Shopify.
| Role | accessLevel | Read-only |
|---|---|---|
| Collaborator | Collaborator | Yes |
Meta
Facebook Pages
Automatic: the client signs in with Meta and AgencyAccess grants the access.
| Role | accessLevel | Read-only |
|---|---|---|
| Admin | ['MANAGE', 'CREATE_CONTENT', 'MODERATE', 'ADVERTISE', 'ANALYZE', 'MANAGE_LEADS'] | |
| Editor | ['ADVERTISE', 'MODERATE', 'CREATE_CONTENT', 'ANALYZE'] | |
| Moderator | ['MODERATE', 'ADVERTISE', 'ANALYZE'] | |
| Advertiser | ['ADVERTISE', 'ANALYZE'] | |
| Analyst | ['ANALYZE'] | Yes |
Meta Ads
Manual: the client signs in with Meta, then follows guided steps to grant the access.
| Role | accessLevel | Read-only |
|---|---|---|
| Analyst | ['ANALYZE'] | Yes |
| Advertiser | ['ADVERTISE', 'ANALYZE'] | |
| Full Control | ['MANAGE', 'ADVERTISE', 'ANALYZE'] |
Facebook Product Catalog
Automatic: the client signs in with Meta and AgencyAccess grants the access.
| Role | accessLevel | Read-only |
|---|---|---|
| Admin | ['MANAGE', 'ADVERTISE'] | |
| Advertiser | ['ADVERTISE'] |
Meta Pixels
Manual: the client signs in with Meta, then follows guided steps to grant the access.
| Role | accessLevel | Read-only |
|---|---|---|
| Partial Access | ['ANALYZE'] | |
| Full Control | ['ADVERTISE', 'UPLOAD', 'ANALYZE'] |
Instagram
Manual: the client follows guided steps to grant the access in Meta.
| Role | accessLevel | Read-only |
|---|---|---|
| Admin | ['MANAGE', 'CREATE_CONTENT', 'MODERATE', 'ADVERTISE', 'ANALYZE'] | |
| Content Creator | ['CREATE_CONTENT', 'MODERATE', 'ANALYZE'] | |
| Advertiser | ['ADVERTISE', 'ANALYZE'] | |
| Analyst | ['ANALYZE'] | Yes |
HubSpot
HubSpot Partner
Manual: the client follows guided steps to grant the access in HubSpot.
No roles: leave out accessLevel.
ProfitMetrics
ProfitMetrics Partner
Manual: the client follows guided steps to grant the access in ProfitMetrics.
No roles: leave out accessLevel.
LinkedIn Company Page
Manual: the client follows guided steps to grant the access in LinkedIn.
| Role | accessLevel | Read-only |
|---|---|---|
| Super Admin | Super Admin | |
| Content Admin | Content Admin | |
| Analyst | Analyst |
LinkedIn Ads
Automatic: the client signs in with LinkedIn and AgencyAccess grants the access.
| Role | accessLevel | Read-only |
|---|---|---|
| Account Manager | ACCOUNT_MANAGER | |
| Campaign Manager | CAMPAIGN_MANAGER | |
| Creative Manager | CREATIVE_MANAGER | |
| Viewer | VIEWER | Yes |
Klaviyo
Klaviyo Account
Manual: the client follows guided steps to grant the access in Klaviyo.
| Role | accessLevel | Read-only |
|---|---|---|
| Admin | Admin | |
| Manager | Manager | |
| Analyst | Analyst | |
| Campaign Coordinator | Campaign Coordinator | |
| Content Creator | Content Creator | |
| Support | Support |
Mailchimp
Mailchimp Dashboard
Manual: the client follows guided steps to grant the access in Mailchimp.
| Role | accessLevel | Read-only |
|---|---|---|
| Viewer | Viewer | |
| Author | Author | |
| Manager | Manager | |
| Admin | Admin |
WordPress
WordPress Site
Automatic: the client signs in with WordPress and AgencyAccess grants the access.
| Role | accessLevel | Read-only |
|---|---|---|
| Shop Manager | Shop Manager | |
| Customer | Customer | |
| Subscriber | Subscriber | |
| Contributor | Contributor | |
| Author | Author | |
| Editor | Editor | |
| Administrator | Administrator |
Lightspeed
Lightspeed C-Series
Manual: the client follows guided steps to grant the access in Lightspeed.
| Role | accessLevel | Read-only |
|---|---|---|
| Full Permissions | Full Permissions |
Microsoft
Microsoft Ads
Automatic: the client signs in with Microsoft and AgencyAccess grants the access.
| Role | accessLevel | Read-only |
|---|---|---|
| Super Admin | Super Admin | |
| Standard User | Standard User | |
| Advertiser Campaign Manager | Advertiser Campaign Manager | |
| Viewer | Viewer | |
| API User | API User |
Microsoft Clarity
Manual: the client follows guided steps to grant the access in Microsoft.
| Role | accessLevel | Read-only |
|---|---|---|
| Admin | Admin | |
| Member | Member |
Channable
Channable Dashboard
Manual: the client follows guided steps to grant the access in Channable.
| Role | accessLevel | Read-only |
|---|---|---|
| Owner | Owner | |
| Employee | Employee | |
| Collaborator | Collaborator | |
| Setup-only | Setup-only | |
| Read-only | Read-only |
Cookiebot
Cookiebot
Manual: the client follows guided steps to grant the access in Cookiebot.
| Role | accessLevel | Read-only |
|---|---|---|
| Manager | Manager |
Reddit Ads
Manual: the client follows guided steps to grant the access in Reddit.
| Role | accessLevel | Read-only |
|---|---|---|
| Administrator | Administrator | |
| Creator | Creator | |
| Analyst | Analyst | Yes |
Apple
Apple Search Ads
Manual: the client follows guided steps to grant the access in Apple.
| Role | accessLevel | Read-only |
|---|---|---|
| Account Admin | Account Admin | |
| Campaign Group Manager | Campaign Group Manager | |
| Account Read Only | Account Read Only | Yes |
Hotjar
Hotjar Dashboard
Manual: the client follows guided steps to grant the access in Hotjar.
| Role | accessLevel | Read-only |
|---|---|---|
| Admin | Admin | |
| Read & Write | Read & Write | |
| Read Only | Read Only | Yes |
ActiveCampaign
ActiveCampaign Account
Manual: the client follows guided steps to grant the access in ActiveCampaign.
| Role | accessLevel | Read-only |
|---|---|---|
| Admin | Admin | |
| Manager | Manager | |
| Read Only | Read Only | Yes |
Wix
Wix Site
Manual: the client follows guided steps to grant the access in Wix.
| Role | accessLevel | Read-only |
|---|---|---|
| Co-Owner | Co-Owner | |
| Website Designer | Website Designer | |
| Billing Manager | Billing Manager |
Webflow
Webflow Site
Manual: the client follows guided steps to grant the access in Webflow.
| Role | accessLevel | Read-only |
|---|---|---|
| Admin | Admin | |
| Designer | Designer | |
| Reviewer | Reviewer | Yes |