Use these endpoints to retrieve your Apollo workspace's users, inspect an authenticated user's profile, and find linked sending mailboxes. You can also retrieve credit usage and balances, and utilize user and mailbox IDs to assign work or configure outreach.
Key concepts
| Users and contacts | Users are team members who use your Apollo workspace. Contacts are people saved for prospecting and outreach. Use user IDs to assign owners or tasks, and contact IDs to identify the people your team works with. |
| Workspace users and the current profile | Get a list of users retrieves team members and their IDs. Get current user profile retrieves the profile associated with your authenticated request. Set include_credit_usage to true to also retrieve user and team credit usage and remaining balances. |
| Users and sending mailboxes | Linked mailboxes send your team's outreach emails. A user ID identifies a team member; an email account ID identifies a linked mailbox. Use the mailbox ID when choosing where sequence emails should send from. |
Choose an endpoint
| I want to . . . | Use this |
|---|---|
| Retrieve team members and their user IDs | Get a list of users |
| Retrieve the authenticated user's profile, with optional credit usage and balances | Get current user profile |
| Retrieve linked sending mailboxes and their IDs | Get a list of email accounts |
Example workflows
Assign accounts to a team member
Find the intended owner and assign a group of saved accounts to them.
- Call get a list of users and retain the
idof the intended owner. - Call search for accounts and retain the
idof each account you want to assign. - Pass the user ID as
owner_idand the account IDs inaccount_ids[]to update account owner for multiple accounts.
The same user ID can identify an owner when creating or updating accounts and deals, or an assignee when creating tasks. Use the parameter specified by the endpoint.
Learn more: Use the get a list of users and update account owner for multiple accounts references to dig in to the workflow.
Choose a sending mailbox for sequence contacts
Select the linked mailbox that will send emails to contacts you're enrolling in a sequence.
- Call get a list of email accounts and retain the
idof the intended sending mailbox. - Retrieve the target sequence ID with search for sequences and the saved contact IDs with search for contacts.
- Call add contacts to a sequence with the mailbox ID as
send_email_from_email_account_id, the sequence ID as bothsequence_idandemailer_campaign_id, and the contact IDs incontact_ids[].
Use the email account ID for the sending mailbox, rather than the owner's user ID.
Learn more: Use the get a list of email accounts and add contacts to a sequence references to explore sending mailbox selection.