Documentation / API / account_team_members
account_team_members
POSThttps://api.oppalerts.com/v1/account/team_members
The account’s team: each person with permissions in the account or an invitation, with a plain-language description of what they can see and change.
What it does
The tool lists the account’s team: each person with permissions in the account or an invitation, with a plain-language description of what they can see and change. It takes no parameters.
This tool only reads data. You can invite, change, or remove a person only on the Team page of the website. As a security precaution, a person must grant the permissions.
The account owner, an account editor, and an account viewer see every member. A campaign editor and a campaign viewer see only their own row.
The response has one field, members. Each member has these fields:
email: the email address of the person.name: the name of the person. The example shows an empty name for an invited person.state:activeorinvitedin the example.permissions: what the person can see and change, in plain words, for example "edit 1 campaign (Boutique Hotels)".account_permissions: the same permissions as a value:editor(see and change every campaign),viewer(see every campaign), ornone.campaign_permissions: whenaccount_permissionsisnone, each campaign that the person can see, with itscampaignid and itspermissions,editororviewer. Empty whenaccount_permissionsiseditororviewer.invited_at: the time of the invitation, as ISO 8601 text in UTC.accepted_at: the time when the person accepted, as ISO 8601 text in UTC. Empty for an invitation that has not been accepted.
Authentication
Send a token in the Authorization: Bearer header. Authentication and Limits explains the tokens.
Parameters
This tool has no parameters. Send an empty object.
Strict Rules
- This tool accepts no fields. Any field you send is refused. The answer is HTTP 400 with the error code
bad_param. The error names the field: "<field> is not a field of this tool." - An error about the format of a call, such as a refused field, names the field. Its message ends with one sentence: "Read the documentation at https://oppalerts.com/docs for the correct format." Every other error has only its own sentence.
Example
Request
curl -X POST https://api.oppalerts.com/v1/account/team_members \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'
Response
The full sample answer.
{
"members": [
{
"email": "sam@example.com",
"name": "Sam Example",
"state": "active",
"permissions": "edit 1 campaign (Boutique Hotels)",
"account_permissions": "none",
"campaign_permissions": [
{
"campaign": 124,
"permissions": "editor"
}
],
"invited_at": "2026-11-10T22:30:30Z",
"accepted_at": "2026-11-10T22:41:07Z"
},
{
"email": "lee@example.com",
"name": "",
"state": "invited",
"permissions": "be an account viewer: see every campaign",
"account_permissions": "viewer",
"campaign_permissions": [],
"invited_at": "2026-11-11T09:15:00Z",
"accepted_at": ""
}
]
}
Errors
bad_param(HTTP 400): the request has a field. This tool accepts no fields, and the error names the field you sent.db_error(HTTP 500): the data could not be read. The sentence says which data. Try again in a few minutes.daily_limit(HTTP 429): the account has used all its calls for this tool today. account_calls_left shows when the count resets.
This tool has its own daily count. A call through the API or MCP uses one call from this count. A web app page reading the same data does not count. It is not an index search, so it does not use the shared count of the news_ and prospects_ tools, and the error one_at_a_time does not apply to it.
Same tool in MCP
The MCP tool is account_team_members. Read the MCP page.