ReachScore Docs
API Reference

Team

Manage team members, roles, and invitations. Control who has access to your organization's deliverability data.

Team Roles

ownerFull access including billing, team management, and ownership transfer
adminFull access except billing and ownership transfer
memberCreate and view tests, domains, monitors; no team management
viewerRead-only access to tests and reports

Members

Returns all members of your organization.

Response

objectstring

Always 'list'

dataarray

Array of team member objects

has_moreboolean

Example Request

curl https://api.reachscore.co/v1/team/members \
  -H "Authorization: Bearer rk_live_xxx"

Example Response

{
  "object": "list",
  "data": [
    {
      "id": "mem_9eO4rS8tVxY0",
      "object": "team_member",
      "email": "admin@yourcompany.com",
      "name": "Admin User",
      "role": "owner",
      "joined_at": "2026-01-15T10:00:00Z"
    },
    {
      "id": "mem_0fP5sT9uWyZ1",
      "object": "team_member",
      "email": "developer@yourcompany.com",
      "name": "Developer",
      "role": "member",
      "joined_at": "2026-02-01T14:30:00Z"
    }
  ],
  "has_more": false
}

Invitations

Send an invitation to join the team. The invitee will receive an email with a link to accept.

Request Bodyrequired

emailstring<email>required

Email address to invite

rolestring

Role to assign when they join (default: member)

adminmemberviewer

Response

idstring

Invitation ID (inv_xxx)

objectstring

Always 'team_invitation'

emailstring<email>
rolestring
expires_atstring<date-time>
created_atstring<date-time>

Example Request

curl -X POST https://api.reachscore.co/v1/team/invitations \
  -H "Authorization: Bearer rk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "newmember@yourcompany.com",
    "role": "member"
  }'

Example Response

{
  "id": "inv_1gQ6uU0vXzA2",
  "object": "team_invitation",
  "email": "newmember@yourcompany.com",
  "role": "member",
  "expires_at": "2026-03-18T10:30:00Z",
  "created_at": "2026-03-11T10:30:00Z"
}

Ownership Transfer

Transfer ownership of the team to another member. Only the current owner can perform this action. This is irreversible.

Request Bodyrequired

new_owner_idstringrequired

Member ID of the new owner

Example Request

curl -X POST https://api.reachscore.co/v1/team/transfer-ownership \
  -H "Authorization: Bearer rk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"new_owner_id": "mem_0fP5sT9uWyZ1"}'

Example Response

{
  "success": true,
  "message": "Ownership transferred successfully",
  "new_owner": {
    "id": "mem_0fP5sT9uWyZ1",
    "email": "developer@yourcompany.com",
    "role": "owner"
  }
}
Previous: ReportsNext: API Keys