Skip to main content
The Instruments API allows you to retrieve the list of available instruments and update member instrument proficiencies for worship team coordination.

​
Authentication

All instrument endpoints require authentication via JWT token.
Pass the JWT token in the Authorization header as Bearer YOUR_TOKEN

​
List Instruments

Retrieve all available instruments in the system. 
GET /api/instruments

​
Response

​
success
boolean
Whether the request was successful
​
instruments
array
Array of instrument objects

​
Example

cURL
curl -X GET "https://your-domain.com/api/instruments" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"
Response
{
  "success": true,
  "instruments": [
    {
      "id": 1,
      "name": "Guitar",
      "category": "Strings"
    },
    {
      "id": 2,
      "name": "Piano",
      "category": "Keys"
    },
    {
      "id": 3,
      "name": "Drums",
      "category": "Percussion"
    },
    {
      "id": 4,
      "name": "Bass",
      "category": "Strings"
    },
    {
      "id": 5,
      "name": "Lead Vocals",
      "category": "Vocals"
    },
    {
      "id": 6,
      "name": "Background Vocals",
      "category": "Vocals"
    }
  ]
}

​
Update My Instruments

Update the list of instruments that the authenticated user can play. 
POST /api/instruments/mine

​
Request Body

​
instruments
array
required
Array of instrument IDs that the user can play

​
Response

​
success
boolean
Whether the instruments were updated successfully
​
message
string
Confirmation message (“Instrumentos actualizados” or error message)

​
Example

cURL
curl -X POST "https://your-domain.com/api/instruments/mine" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "instruments": [1, 2, 5]
  }'
Response
{
  "success": true,
  "message": "Instrumentos actualizados"
}

​
Common Use Cases

​
Worship Team Member Profile

When a member joins the worship team, they can specify which instruments they play:
  1. Call GET /api/instruments to retrieve all available instruments
  2. Present the list to the user for selection
  3. Call POST /api/instruments/mine with the selected instrument IDs

​
Assigning Musicians to Services

When creating a setlist or meeting assignment:
  1. Query members who have specific instrument proficiencies
  2. Assign appropriate roles (guitarist, pianist, vocalist, etc.)
  3. The instrument assignments are stored and can be referenced when scheduling

​
Error Responses

StatusErrorDescription
401UnauthorizedInvalid or missing JWT token
400Invalid instrumentsThe instruments array is invalid or empty

People API

Manage team members and their profiles

Calendar API

Schedule worship services with instrument assignments

Teams API

Organize worship teams and roles

Build docs developers (and LLMs) love

Get started for freeTalk to us