Navigate...
Project
View your project details. Verify your API key works and inspect the project context.
Overview
Your Multisender project is the central workspace that holds all distributions, recipient lists, and members. Use getInfo() as a health check to verify your API key is valid and inspect the project context.The API key you pass to the Multisender client authenticates every SDK request. Generate and manage keys in the Multisender dashboard.
Use getInfo() as a health check — if it returns successfully, your API key and base URL are configured correctly.
Key Concepts
Project
Your organizational workspace. Contains all distributions, lists, API keys, and members. Each project has a unique name, slug, and description. Projects are created automatically when you register.
API Key
A credential that authenticates SDK requests. Pass it to the Multisender client constructor — the SDK handles the rest. Format: ms_ followed by a hex string. Each key has a name, permission scopes, and status. Generate and manage keys in the Multisender dashboard — the secret is shown only once at creation.
Scopes
Permission levels assigned to an API key. Control what operations the key can perform (e.g. read, write). Manage scopes in the Multisender dashboard.
Member roles
Project members have roles with a hierarchy: OWNER > ADMIN > MANAGER > VIEWER. Visible via getInfo() in the memberships array. Role management is done through the dashboard, not the SDK.
Quick Start
Methods
sdk.project.getInfo()
Retrieve full project information including name and members. Use this as a health check — if it returns successfully, your API key and base URL are configured correctly. The response includes the memberships array with project members and their roles.
Use getInfo() as a health check — if it returns successfully, your API key and base URL are configured correctly. This is the first method to call when setting up a new integration.
Parameters
No parameters
Returns
Project
Full project object with members
Errors
The request is not authorized
You do not have permission to access this resource
Generated Code