Relay SMS Platform
Relay SMS API

Workspace

Endpoint

Workspace settings and members

Get workspace settings

GET
https://api.relay.works
/v1/workspace

Get workspace settings › Responses

Workspace settings

  • idstring · uuid
  • namestring
  • default_phone_numberstring | null
  • plan_typestring · enum
    Enum values:
    free
    starter
    growth
    scale
    enterprise
  • created_atstring · date-time

Update workspace settings

PUT
https://api.relay.works
/v1/workspace

Update workspace settings › Request Body

  • namestring
  • default_phone_numberstring

Update workspace settings › Responses

Updated workspace

  • idstring · uuid
  • namestring
  • default_phone_numberstring | null
  • plan_typestring · enum
    Enum values:
    free
    starter
    growth
    scale
    enterprise
  • created_atstring · date-time

List workspace members

GET
https://api.relay.works
/v1/workspace/members

Returns all members of the authenticated workspace, including their email addresses. Accessible to any API key scoped to the workspace (all roles). Email addresses are returned in full, consistent with standard team-tool behavior — all workspace members can see each other's contact information.

List workspace members › Responses

Workspace member list

  • user_idstring · uuid
  • emailstring · email

    Member email returned in full to workspace members. All workspace members can see each other's email addresses, consistent with standard team-tool behavior.

  • namestring
  • rolestring · enum
    Enum values:
    owner
    admin
    member
  • joined_atstring · date-time
User