Skip to main content

OAuth 2.0 Scopes

OAuth 2.0 scopes give control over what endpoints an individual user can access. For more information, visit OAuth Scopes.

OAuth Clients and Scopes​

If you already have OAuth Clients in use that you created without scopes, these clients will continue to work but they will not be editable. The older clients will either have no scopes or have a default scope assigned.

When creating a new client, you must choose at least one scope from the dropdown. It's a good security practice to create clients with least privilege. This means only assigning the scopes that particular client requires to do its job.

The scope manage:all allows access to all API endpoints with both read and write permission. While this scope is always available to you, we strongly recommend you create clients with limited permissions, and be careful about how those clients are managed.

Set Scopes For Tokens​

Bearer token requests do not automatically inherit the scopes assigned to the client. Be sure to set them explicitly in your request for a token.

The table below categorizes API groups and their corresponding endpoints, detailing the specific scopes required for user access. Each API group is named and followed by its various endpoints.

For overarching access to all endpoints within a specific API group, a master scope is designated. For instance, the Contact Frequency API group lists manage:contact_frequency_rule as its master scope. Assigning this scope provides a user with unrestricted access to all Contact Frequency endpoints.

VerbPathScope
Audit-Exportsmanage:activity_logs
POST/audit-exportsread:activity_logs
GET/audit-exports/{exportId}read:activity_logs
GET/audit-exports/{exportId}/files/{fileId}read:activity_logs
GET/audit-eventsread:activity_logs
Auditsmanage:activity_logs
GET/logs/activitytypesread:activity_logs
GET/logsread:activity_logs
Automations File Servicewrite:automations
GET/automations/{automationId}/fileswrite:automations
Bulk Entity Importmanage:contact_transactions
POST/directories/{directoryId}/importswrite:contact_transactions
Conjoint Collaborationsmanage:conjointmaxdiff
POST/conjoint-maxdiff/{projectId}/permissions/collaborationsread:conjointmaxdiff write:conjointmaxdiff
Contact Frequencymanage:contact_frequency_rules
GET/directories/{directoryId}/frequencyrulesread:contact_frequency_rules
GET/directories/{directoryId}/frequencyrules/{ruleId}read:contact_frequency_rules
POST/directories/{directoryId}/frequencyruleswrite:contact_frequency_rules
PUT/directories/{directoryId}/frequencyrules/{ruleId}write:contact_frequency_rules
DELETE/directories/{directoryId}/frequencyrules/{ruleId}write:contact_frequency_rules
Contact Importsmanage:contact_transactions
POST/directories/{directoryId}/mailinglists/{mailingListId}/transactioncontactswrite:contact_transactions
GET/directories/{directoryId}/mailinglists/{mailingListId}/transactioncontacts/{importId}write:contact_transactions
GET/directories/{directoryId}/mailinglists/{mailingListId}/transactioncontacts/{importId}/summarywrite:contact_transactions
GET/directories/{directoryId}/imports/api-import/jobs/{importId}/reportwrite:contact_transactions
Contact Transactionsmanage:contact_transactions
GET/directories/{directoryId}/contacts/{contactId}/transactionsread:contact_transactions
POST/directories/{directoryId}/transactionswrite:contact_transactions
GET/directories/{directoryId}/transactions/{transactionId}read:contact_transactions
POST/directories/{directoryId}/transactions/{transactionId}write:contact_transactions
PUT/directories/{directoryId}/transactions/{transactionId}write:contact_transactions
DELETE/directories/{directoryId}/transactions/{transactionId}write:contact_transactions
POST/directories/{directoryId}/transactions/{transactionId}/enrichmentswrite:contact_transactions
Contactsmanage:directory_contacts
GET/directories/{directoryId}/contactsread:directory_contacts
POST/directories/{directoryId}/contactswrite:directory_contacts
GET/directories/{directoryId}/contacts/{contactId}read:directory_contacts
PUT/directories/{directoryId}/contacts/{contactId}write:directory_contacts
DELETE/directories/{directoryId}/contacts/{contactId}write:directory_contacts
POST/directories/{directoryId}/contacts/searchread:directory_contacts
GET/directories/{directoryId}/contacts/{contactId}/historyread:directory_contacts
POST/directories/{directoryId}/export-contactsread:directory_contacts
GET/directories/{directoryId}/export-contacts/{progressId}/statusread:directory_contacts
GET/directories/{directoryId}/export-contacts/{fileId}/fileread:directory_contacts
Directoriesmanage:directories
GET/directoriesread:directories
Distributionsmanage:distributions
GET/distributionsread:distributions
POST/distributionswrite:distributions
GET/distributions/{distributionId}read:distributions
DELETE/distributions/{distributionId}write:distributions
POST/distributions/{distributionId}/reminderswrite:distributions
POST/distributions/{distributionId}/thankyouswrite:distributions
GET/distributions/{distributionId}/linksread:distributions
GET/distributions/{distributionId}/historyread:distributions
Divisionsmanage:divisions
POST/divisionswrite:divisions
GET/divisions/{divisionId}read:divisions
PUT/divisions/{divisionId}write:divisions
Embedded Insightswrite:embedded_dashboards
POST/embedded-insights/dashboards/:idwrite:embedded_dashboards
POST/embedded-insights/dashboards/:id/widgets/:idwrite:embedded_dashboards
Event Subscriptionsmanage:subscriptions
GET/eventsubscriptionsread:subscriptions
POST/eventsubscriptionswrite:subscriptions
GET/eventsubscriptions/{subscriptionId}read:subscriptions
EX APIsmanage:participants
POST/successfactors/projects/{projectId}/evaluatorswrite:participants
GET/employee-directories/{directoryId}/participants/{participantId}read:participants
GET/employee-directories/{directoryId}/participantsread:participants
POST/employee-directories/{directoryId}/participantsread:participants
POST/employee-directories/{directoryId}/import-participantswrite:participants
GET/employee-directories/{directoryId}/import-participants/{jobId}write:participants
GET/employee-directories/{directoryId}/import-participants/results/{resultId}write:participants
POST/employee-directories/{directoryId}/delete-participantswrite:participants
GET/employee-directories/{directoryId}/delete-participants/{jobId}write:participants
GET/employee-directories/{directoryId}/delete-participants/results/{resultId}read:participants
GET/employee-directories/{directoryId}/export-participantsread:participants
POST/employee-directories/{directoryId}/export-participantsread:participants
GET/employee-directories/{directoryId}/export-participants/{jobId}read:participants
GET/employee-directories/{directoryId}/export-participants/results/{resultId}/fileread:participants
GET/ex-projects/{projectId}/participants/{participantId}read:participants
GET/ex-projects/{projectId}/participantsread:participants
POST/ex-projects/{projectId}/participantsread:participants
POST/ex-projects/{projectId}/import-participantswrite:participants
GET/ex-projects/{projectId}/import-participants/{jobId}write:participants
GET/ex-projects/{projectId}/import-participants/results/{resultId}write:participants
POST/ex-projects/{projectId}/import-subjectswrite:participants
GET/ex-projects/{projectId}/import-subjects/{jobId}read:participants
GET/ex-projects/{projectId}/import-subjects/results/{resultId}read:participants
POST/ex-projects/{projectId}/import-evaluatorswrite:participants
GET/ex-projects/{projectId}/import-evaluators/{jobId}read:participants
GET/ex-projects/{projectId}/import-evaluators/results/{resultId}read:participants
POST/ex-projects/{projectId}/copy-participantswrite:participants
GET/ex-projects/{projectId}/copy-participants/{jobId}write:participants
GET/ex-projects/{projectId}/copy-participants/results/{resultId}write:participants
POST/ex-projects/{projectId}/copy-subjectswrite:participants
GET/ex-projects/{projectId}/copy-subjects/{jobId}read:participants
GET/ex-projects/{projectId}/copy-subjects/results/{resultId}read:participants
POST/ex-projects/{projectId}/copy-evaluatorswrite:participants
GET/ex-projects/{projectId}/copy-evaluators/{jobId}read:participants
GET/ex-projects/{projectId}/copy-evaluators/results/{resultId}read:participants
POST/ex-projects/{projectId}/delete-participantswrite:participants
GET/ex-projects/{projectId}/delete-participants/{jobId}write:participants
GET/ex-projects/{projectId}/delete-participants/results/{resultId}write:participants
POST/ex-projects/{projectId}/export-nominationsread:participants
GET/ex-projects/{projectId}/export-nominations/{jobId}read:participants
GET/ex-projects/{projectId}/export-nominations/results/{resultId}/fileread:participants
POST/ex-projects/{projectId}/export-participantsread:participants
GET/ex-projects/{projectId}/export-participants/{jobId}read:participants
GET/ex-projects/{projectId}/export-participants/results/{resultId}/fileread:participants
Groupsmanage:groups
GET/groupsread:groups
POST/groupswrite:groups
GET/groups/{groupId}read:groups
PUT/groups/{groupId}write:groups
DELETE/groups/{groupId}write:groups
GET/groups/{groupId}/membersread:groups
POST/groups/{groupId}/memberswrite:groups
DELETE/groups/{groupId}/members/{userId}write:groups
Imported Data Projectsmanage:imported_data_projects
POST/imported-data-projectswrite:imported_data_projects
GET/imported-data-projects/{idpSourceId}read:imported_data_projects
POST/imported-data-projects/{idpSourceId}write:imported_data_projects
POST/imported-data-projects/{idpSourceId}/exportsread:imported_data_projects
GET/imported-data-projects/{idpSourceId}/exports/{jobId}read:imported_data_projects
GET/imported-data-projects/{idpSourceId}/exports/{fileId}/fileread:imported_data_projects
POST/imported-data-projects/{idpSourceId}/recordwrite:imported_data_projects
POST/imported-data-projects/{idpSourceId}/recordswrite:imported_data_projects
GET/imported-data-projects/{idpSourceId}/records/{uniqueField}read:imported_data_projects
DELETE/imported-data-projects/{idpSourceId}/records/{uniqueField}write:imported_data_projects
PUT/imported-data-projects/{idpSourceId}/records/{uniqueField}write:imported_data_projects
Legacy Survey Response Import/Export APImanage:survey_responses
POST/responseexportsread:survey_responses
GET/responseexports/{responseExportId}read:survey_responses
GET/responseexports/{responseExportId}/fileread:survey_responses
POST/responseimportswrite:survey_responses
GET/responseimports/{responseImportId}write:survey_responses
Librariesmanage:libraries
GET/libraries/{libraryId}/survey/blocksread:libraries
GET/librariesread:libraries
GET/libraries/{libraryId}/survey/questionsread:libraries
GET/libraries/{libraryId}/survey/surveysread:libraries
GET/libraries/{libraryId}/messagesread:libraries
POST/libraries/{libraryId}/messageswrite:libraries
GET/libraries/{libraryId}/messages/{messageId}read:libraries
PUT/libraries/{libraryId}/messages/{messageId}write:libraries`
DELETE/libraries/{libraryId}/messages/{messageId}write:libraries
POST/libraries/{libraryId}/graphicswrite:libraries
DELETE/libraries/{libraryId}/graphics/{graphicId}write:libraries
Mailing List Contactsmanage:mailing_list_contacts
POST/directories/{directoryId}/mailinglists/{mailingListId}/contactswrite:mailing_list_contacts
GET/directories/{directoryId}/mailinglists/{mailingListId}/contactsread:mailing_list_contacts
GET/directories/{directoryId}/mailinglists/{mailingListId}/bouncedContactsread:mailing_list_contacts
GET/directories/{directoryId}/mailinglists/{mailingListId}/optedOutContactsread:mailing_list_contacts
GET/directories/{directoryId}/mailinglists/{mailingListId}/contacts/{contactId}read:mailing_list_contacts
PUT/directories/{directoryId}/mailinglists/{mailingListId}/contacts/{contactId}write:mailing_list_contacts
DELETE/directories/{directoryId}/mailinglists/{mailingListId}/contacts/{contactId}write:mailing_list_contacts
GET/directories/{directoryId}/mailinglists/{mailingListId}/contacts/{contactId}/historyread:mailing_list_contacts
Mailing Listsmanage:mailing_lists
GET/directories/{directoryId}/mailinglistsread:mailing_lists
POST/directories/{directoryId}/mailinglistswrite:mailing_lists
GET/directories/{directoryId}/mailinglists/{mailingListId}read:mailing_lists
PUT/directories/{directoryId}/mailinglists/{mailingListId}write:mailing_lists
DELETE/directories/{directoryId}/mailinglists/{mailingListId}write:mailing_lists
OAuth Tokensmanage:users
GET/oauthtokens/{tokenType}
POST/oauthtokens/{tokenType}/delete
Organizationsmanage:organizations
GET/organizations/{id}read:organizations
Qualtrics Survey APImanage:surveys
POST/survey-definitionswrite:surveys
GET/survey-definitions/{surveyId}read:surveys
DELETE/survey-definitions/{surveyId}write:surveys
GET/survey-definitions/{surveyId}/metadataread:surveys
PUT/survey-definitions/{surveyId}/metadatawrite:surveys
GET/survey-definitions/{surveyId}/blocks/{blockId}read:surveys
POST/survey-definitions/{surveyId}/blockswrite:surveys
PUT/survey-definitions/{surveyId}/blocks/{blockId}write:surveys
DELETE/survey-definitions/{surveyId}/blocks/{blockId}write:surveys
GET/survey-definitions/{surveyId}/questionsread:surveys
POST/survey-definitions/{surveyId}/questionswrite:surveys
GET/survey-definitions/{surveyId}/questions/{questionId}read:surveys
PUT/survey-definitions/{surveyId}/questions/{questionId}write:surveys
DELETE/survey-definitions/{surveyId}/questions/{questionId}write:surveys
GET/survey-definitions/{surveyId}/flowread:surveys
PUT/survey-definitions/{surveyId}/flowwrite:surveys
PUT/survey-definitions/{surveyId}/flow/{flowId}write:surveys
GET/survey-definitions/{surveyId}/optionsread:surveys
PUT/survey-definitions/{surveyId}/optionswrite:surveys
GET/survey-definitions/{surveyId}/versionsread:surveys
POST/survey-definitions/{surveyId}/versionswrite:surveys
GET/survey-definitions/{surveyId}/versions/{versionId}read:surveys
GET/survey-definitions/{surveyId}/quotaswrite:surveys
POST/survey-definitions/{surveyId}/quotaswrite:surveys
GET/survey-definitions/{surveyId}/quotas/{quotaId}read:surveys
PUT/survey-definitions/{surveyId}/quotas/{quotaId}write:surveys
DELETE/survey-definitions/{surveyId}/quotas/{quotaId}write:surveys
GET/survey-definitions/{surveyId}/quotagroupsread:surveys
POST/survey-definitions/{surveyId}/quotagroupswrite:surveys
GET/survey-definitions/{surveyId}/quotagroups/{quotaGroupId}read:surveys
PUT/survey-definitions/{surveyId}/quotagroups/{quotagroupId}write:surveys
DELETE/survey-definitions/{surveyId}/quotagroups/{quotagroupId}write:surveys
GET/surveys/{surveyId}/languagesread:surveys
PUT/surveys/{surveyId}/languageswrite:surveys
GET/surveys/{surveyId}/translations/{languageCode}read:surveys
PUT/surveys/{surveyId}/translations/{languageCode}write:surveys
Research Core Contactsmanage:mailing_lists
GET/mailinglists/{mailingListId}read:mailing_lists
PUT/mailinglists/{mailingListId}write:mailing_lists
DELETE/mailinglists/{mailingListId}write:mailing_lists
GET/mailinglistsread:mailing_lists
POST/mailinglistswrite:mailing_lists
GET/mailinglists/{mailingListId}/contactsread:mailing_list_contacts
POST/mailinglists/{mailingListId}/contactswrite:mailing_list_contacts
GET/mailinglists/{mailingListId}/contacts/{contactId}read:mailing_list_contacts
PUT/mailinglists/{mailingListId}/contacts/{contactId}write:mailing_list_contacts
DELETE/mailinglists/{mailingListId}/contacts/{contactId}write:mailing_list_contacts
POST/mailinglists/{mailingListId}/contactimportswrite:mailing_list_contacts
GET/mailinglists/{mailingListId}/contactimports/{importId}write:mailing_list_contacts
GET/mailinglists/{mailingListId}/contactimports/{importId}/summarywrite:mailing_list_contacts
GET/mailinglists/{mailingListId}/samplesread:samples
GET/mailinglists/{mailingListId}/samples/{sampleId}read:samples
Right to Erasuremanage:erasure_requests
POST/op-erase-personal-datamanage:erasure_requests
GET/op-erase-personal-datamanage:erasure_requests
GET/op-erase-personal-data/{requestId}manage:erasure_requests
Sample Definitionsmanage:samples
GET/directories/{directoryId}/samples/definitionsread:samples
POST/directories/{directoryId}/samples/definitionswrite:samples
GET/directories/{directoryId}/samples/definitions/{sampleDefinitionId}read:samples
PUT/directories/{directoryId}/samples/definitions/{sampleDefinitionId}write:samples
DELETE/directories/{directoryId}/samples/definitions/{sampleDefinitionId}write:samples
Samplesread:samples
GET/directories/{directoryId}/samplesread:samples
POST/directories/{directoryId}/sampleswrite:samples
GET/directories/{directoryId}/samples/{sampleId}read:samples
PUT/directories/{directoryId}/samples/{sampleId}write:samples
DELETE/directories/{directoryId}/samples/{sampleId}write:samples
GET/directories/{directoryId}/samples/{sampleId}/contactsread:samples
GET/directories/{directoryId}/samples/progress/{progressId}write:samples
Segment Contactsmanage:directory_contacts
GET/directories/{directoryId}/segments/{segmentId}/contactsread:directory_contacts
GET/directories/{directoryId}/segments/{segmentId}/contacts/{contactId}read:directory_contacts
Segmentsmanage:directory_segments
GET/directories/{directoryId}/segmentsread:directory_segments
POST/directories/{directoryId}/segmentswrite:directory_segments
POST/directories/{directoryId}/export-contact-segment-membershipsread:directory_segments
GET/directories/{directoryId}/export-contact-segment-memberships/{exportProgressId}read:directory_segments
GET/directories/{directoryId}/export-contact-segment-memberships/{fileId}/fileread:directory_segments
GET/directories/{directoryId}/segments/{segmentId}read:directory_segments
PUT/directories/{directoryId}/segments/{segmentId}write:directory_segments
DELETE/directories/{directoryId}/segments/{segmentId}write:directory_segments
POST/directories/{directoryId}/segments/{segmentId}/refresh-jobswrite:directory_segments
GET/directories/{directoryId}/segments/{segmentId}/refresh-jobs/{progressId}read:directory_segments
SMS Distributionsmanage:distributions
POST/distributions/smswrite:distributions
GET/distributions/smsread:distributions
GET/distributions/sms/{distributionId}read:distributions
DELETE/distributions/sms/{distributionId}write:distributions
Survey Responses: Batch Update and Delete Responsesmanage:survey_responses
POST/surveys/{surveyId}/update-responseswrite:survey_responses
GET/surveys/{surveyId}/update-responses/{progressId}write:survey_responses
POST/surveys/{surveyId}/delete-responseswrite:survey_responses
GET/surveys/{surveyId}/delete-responses/{progressId}write:survey_responses
Survey Responses: Single Survey Responsesmanage:survey_responses
POST/surveys/{surveyId}/responseswrite:survey_responses
GET/surveys/{surveyId}/responses/{responseId}read:survey_responses
DELETE/surveys/{surveyId}/responses/{responseId}write:survey_responses
GET/surveys/{surveyId}/responses/{responseId}/uploaded-files/{fileId}read:survey_responses
DELETE/surveys/{surveyId}/responses/{responseId}/uploaded-files/{fileId}write:survey_responses
PUT/responses/{responseId}write:survey_responses
GET/surveys/{surveyId}/response-schemaread:survey_responses
Survey Responses: Surveys Response Import/Export APImanage:survey_responses
POST/surveys/{surveyId}/export-responsesread:survey_responses
GET/surveys/{surveyId}/export-responses/{exportProgressId}read:survey_responses
GET/surveys/{surveyId}/export-responses/{fileId}/fileread:survey_responses
GET/surveys/{surveyId}/filtersread:survey_responses
POST/surveys/{surveyId}/import-responseswrite:survey_responses
GET/surveys/{surveyId}/import-responses/{importProgressId}write:survey_responses
Survey Taking APIsmanage:survey_sessions
POST/surveys/{surveyId}/sessionswrite:survey_sessions
GET/surveys/{surveyId}/sessions/{sessionId}read:survey_sessions
POST/surveys/{surveyId}/sessions/{sessionId}write:survey_sessions
DELETE/surveys/{surveyId}/sessions/{sessionId}write:survey_sessions
Survey CRUD APImanage:surveys
GET/surveys/{surveyId}read:surveys
PUT/surveys/{surveyId}write:surveys
DELETE/surveys/{surveyId}write:surveys
GET/surveysread:surveys
POST/surveyswrite:surveys
POST/surveys/{surveyId}/permissions/collaborationswrite:surveys
POST/surveys/{surveyId}/embeddeddatafieldswrite:surveys
GET/surveys/:surveyId/quotasread:surveys
Ticketing APImanage:tickets
GET/ticketsread:tickets
GET/tickets/{ticketKey}read:tickets
POST/tickets/searchread:tickets
GET/tickets/{ticketKey}/eventsread:tickets
GET/tickets/statusesread:tickets
GET/tickets/{ticketKey}/rootCausesread:tickets
DELETE/tickets/{ticketKey}write:tickets
PUT/tickets/{ticketKey}write:tickets
PUT/tickets/statuseswrite:tickets
PUT/tickets/{ticketKey}/ticketAdditionalDatawrite:tickets
POST/ticket-exportswrite:tickets
GET/ticket-exports/{exportId}/statusread:tickets
GET/ticket-exports/{fileId}/fileread:tickets
Transaction Batchesmanage:contact_transactions
GET/directories/{directoryId}/transactionbatchesread:contact_transactions
POST/directories/{directoryId}/transactionbatcheswrite:contact_transactions
GET/directories/{directoryId}/transactionbatches/{batchId}/transactionsread:contact_transactions
POST/directories/{directoryId}/transactionbatches/{batchId}/transactionswrite:contact_transactions
DELETE/directories/{directoryId}/transactionbatches/{batchId}/transactions/{transactionId}write:contact_transactions
GET/directories/{directoryId}/transactionbatches/{batchId}read:contact_transactions
DELETE/directories/{directoryId}/transactionbatches/{batchId}write:contact_transactions
Usersmanage:users
GET/usersread:users
POST/userswrite:users
GET/users/{userId}read:users
DELETE/users/{userId}write:users
PUT/users/{userId}write:users
GET/whoamiread:users
WhatsApp Distributionsmanage:distributions
POST/distributions/whatsappwrite:distributions
GET/distributions/whatsappread:distributions
GET/distributions/whatsapp/{whatsAppDistributionId}read:distributions
DELETE/distributions/whatsapp/{whatsAppDistributionId}write:distributions