API reference
Team & Connection
Use Test Connection to validate credentials before saving them. Team members are the reps you assign leads and calls to.
Test Connection
GETPOST
/api/make/health/{teamId}Checks that the Team ID and API key match, and returns the team’s name.
- Used by:
- Make: connection test · Zapier: authentication test and connection label
Parameters
teamIdstringrequiredYour Team ID.
Response
2 response fieldsShowHide
successbooleanAlways true on a 200.
team_namestringYour team’s name in Saleso, or null if it has none.
- Accepts
GETorPOST; neither takes a body.
Errors
401Missing API keyorInvalid API key.500Unexpected server error. Theerrorfield carries the message.
curl -X GET "https://try.saleso.io/api/make/health/$SALESO_TEAM_ID" \
-H "x-api-key: $SALESO_API_KEY"{
"success": true,
"team_name": "Levi Logistics Sales"
}Get Team Members
GET
/api/make/team/{teamId}Gets all members of your Saleso team.
- Used by:
- Make: Get Team Members · Zapier: Get Team Members · rep pickers
Parameters
teamIdstringrequiredYour Team ID.
activeboolean· QuerySend
1ortruefor active human reps only (removed users and voice bots left out). By default everyone in the team is returned.
Response
7 response fieldsShowHide
members[].idstringUser ID
members[].first_namestringFirst Name
members[].last_namestringLast Name
members[].emailstringEmail
members[].rolestringThe user’s role, e.g.
SALES_TEAM_MANAGERorSALESPERSON.members[].namestringDisplay name: first and last name, falling back to email.
members[].billing_statusstringSeat status:
active,invited,pausedorremoved; may be null.
- Sorted by first name.
Errors
401The API key is missing, wrong, or belongs to another team (Invalid API key).500Unexpected server error. Theerrorfield carries the message.
curl -X GET "https://try.saleso.io/api/make/team/$SALESO_TEAM_ID" \
-H "x-api-key: $SALESO_API_KEY"{
"members": [
{
"id": "f554b8ba-54c4-43e4-abd9-77c75040fe59",
"first_name": "Noa",
"last_name": "Cohen",
"email": "noa@example.com",
"role": "SALESPERSON",
"name": "Noa Cohen",
"billing_status": "active"
}
]
}