Which scopes should I pick?
Download MarkdownSelect the fewest permissions your integration actually needs. Settings -> API shows the scopes an owner can choose. A registered system permission is not necessarily a selectable customer credential option, so follow the current
Select the fewest permissions your integration actually needs. Settings -> API shows the scopes an owner can choose. A registered system permission is not necessarily a selectable customer credential option, so follow the current selection screen and API Reference.
For example, leads:read is limited to a named campaign, while account-wide lead reads require leads:read_all. Give each integration or agent its own named credential so one can be revoked without breaking the others.
Related Articles
- What can the CloseMagnet API do?It reads almost everything in your account, and what it writes is deliberately narrow. Its endpoints span 17 domains and the large majority are read-only. The ones that write do one of these things:
- How do I create an API credential?Only the account owner can mint one, and it happens at Settings -> API.
- What is the difference between my account API token and a scoped credential?Your account API token was minted automatically when the account was created. It sits pinned as the first row in Settings -> API with the type "Automatic", carries a fixed set of scopes, can be revealed again at any time, and can
- How do I rotate or revoke a credential?It depends which kind you have, and only the account owner can do either one.