Teams

Overview

Teams are organizational units within an organization that help organize users, interviews, candidates, and other resources. You can create teams, list teams, get team details, and update team branding settings.

Create Teams

Create one or more teams in bulk. Optionally add users to teams during creation. Endpoint: POST /qsi/gather/teams

cURL
JavaScript
Python

curl -X POST https://api.prod.qualifi.hr/qsi/gather/teams \
  -H "x-api-key: ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "teams": [
      {
        "name": "Engineering Team",
        "displayName": "Engineering",
        "description": "Engineering and development team"
      }
    ]
  }'

const response = await fetch('https://api.prod.qualifi.hr/qsi/gather/teams', {
  method: 'POST',
  headers: {
    'x-api-key': apiKey,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    teams: [
      {
        name: 'Engineering Team',
        displayName: 'Engineering',
        description: 'Engineering and development team'
      }
    ]
  })
});
const teams = await response.json();

response = requests.post(
    'https://api.prod.qualifi.hr/qsi/gather/teams',
    headers={
        'x-api-key': api_key,
        'Content-Type': 'application/json'
    },
    json={
        'teams': [
            {
                'name': 'Engineering Team',
                'displayName': 'Engineering',
                'description': 'Engineering and development team'
            }
        ]
    }
)
teams = response.json()

{
  "teams": [
    {
      "name": "Engineering Team",
      "displayName": "Engineering",
      "description": "Engineering and development team",
      "userIds": ["user-uuid-1", "user-uuid-2"]
    },
    {
      "name": "Sales Team",
      "displayName": "Sales",
      "description": "Sales and business development team"
    }
  ]
}

{
  "data": {
    "teams": [
      {
        "id": "team-uuid-1",
        "name": "Engineering Team",
        "displayName": "Engineering",
        "description": "Engineering and development team",
        "organizationId": "org-uuid",
        "createdAt": "2024-01-01T00:00:00Z",
        "updatedAt": "2024-01-01T00:00:00Z"
      },
      {
        "id": "team-uuid-2",
        "name": "Sales Team",
        "displayName": "Sales",
        "description": "Sales and business development team",
        "organizationId": "org-uuid",
        "createdAt": "2024-01-01T00:00:00Z",
        "updatedAt": "2024-01-01T00:00:00Z"
      }
    ]
  },
  "meta": {
    "requestId": "uuid",
    "timestamp": "2024-01-01T00:00:00Z"
  }
}

List Teams

Retrieve a list of teams in your organization. Optionally filter by userId to get only teams that a specific user belongs to. Endpoint: GET /qsi/gather/teams

string

Filter teams to only those the user belongs to

cURL
JavaScript
Python

curl -X GET "https://api.prod.qualifi.hr/qsi/gather/teams?userId=user-uuid" \
  -H "x-api-key: ${API_KEY}"

const params = new URLSearchParams({
  userId: 'user-uuid'
});

const response = await fetch(
  `https://api.prod.qualifi.hr/qsi/gather/teams?${params}`,
  {
    headers: {
      'x-api-key': apiKey
    }
  }
);
const teams = await response.json();

params = {
    'userId': 'user-uuid'
}
response = requests.get(
    'https://api.prod.qualifi.hr/qsi/gather/teams',
    headers={'x-api-key': api_key},
    params=params
)
teams = response.json()

{
  "data": {
    "teams": [
      {
        "id": "team-uuid-1",
        "name": "Engineering Team",
        "displayName": "Engineering",
        "description": "Engineering and development team",
        "logoUrl": "https://example.com/logo.png",
        "accentColor": "482eeb",
        "buttonColor": "ffffff",
        "backgroundImage": "https://example.com/background.jpg",
        "organizationId": "org-uuid",
        "createdAt": "2024-01-01T00:00:00Z",
        "updatedAt": "2024-01-01T00:00:00Z",
        "archivedAt": null
      },
      {
        "id": "team-uuid-2",
        "name": "Sales Team",
        "displayName": "Sales",
        "description": null,
        "logoUrl": null,
        "accentColor": null,
        "buttonColor": null,
        "backgroundImage": null,
        "organizationId": "org-uuid",
        "createdAt": "2024-01-01T00:00:00Z",
        "updatedAt": "2024-01-01T00:00:00Z",
        "archivedAt": null
      }
    ]
  },
  "meta": {
    "requestId": "uuid",
    "timestamp": "2024-01-01T00:00:00Z"
  }
}

Get Team

Retrieve a single team by its ID. The team must belong to your organization. Endpoint: GET /qsi/gather/teams/{teamId}

string

required

UUID of the team

cURL
JavaScript
Python

curl -X GET https://api.prod.qualifi.hr/qsi/gather/teams/{teamId} \
  -H "x-api-key: ${API_KEY}"

const response = await fetch(
  `https://api.prod.qualifi.hr/qsi/gather/teams/${teamId}`,
  {
    headers: {
      'x-api-key': apiKey
    }
  }
);
const team = await response.json();

response = requests.get(
    f'https://api.prod.qualifi.hr/qsi/gather/teams/{team_id}',
    headers={'x-api-key': api_key}
)
team = response.json()

{
  "data": {
    "team": {
      "id": "team-uuid",
      "name": "Engineering Team",
      "displayName": "Engineering",
      "description": "Engineering and development team",
      "logoUrl": "https://example.com/logo.png",
      "accentColor": "482eeb",
      "buttonColor": "ffffff",
      "backgroundImage": "https://example.com/background.jpg",
      "organizationId": "org-uuid",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z",
      "archivedAt": null
    }
  },
  "meta": {
    "requestId": "uuid",
    "timestamp": "2024-01-01T00:00:00Z"
  }
}

Update Team Branding

Update branding settings for a team including colors, logo, background image, and display name. Endpoint: PATCH /qsi/gather/teams/{teamId}/branding

string

required

UUID of the team

cURL
JavaScript
Python

curl -X PATCH https://api.prod.qualifi.hr/qsi/gather/teams/{teamId}/branding \
  -H "x-api-key: ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "accentColor": "482eeb",
    "teamButtonColor": "ffffff"
  }'

const response = await fetch(
  `https://api.prod.qualifi.hr/qsi/gather/teams/${teamId}/branding`,
  {
    method: 'PATCH',
    headers: {
      'x-api-key': apiKey,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      accentColor: '482eeb',
      teamButtonColor: 'ffffff'
    })
  }
);
const team = await response.json();

response = requests.patch(
    f'https://api.prod.qualifi.hr/qsi/gather/teams/{team_id}/branding',
    headers={
        'x-api-key': api_key,
        'Content-Type': 'application/json'
    },
    json={
        'accentColor': '482eeb',
        'teamButtonColor': 'ffffff'
    }
)
team = response.json()

{
  "accentColor": "482eeb",
  "teamButtonColor": "ffffff",
  "teamBackgroundImage": "https://example.com/background.jpg",
  "logoUrl": "https://example.com/logo.png",
  "displayName": "Engineering Team",
  "description": "Updated description"
}

{
  "data": {
    "team": {
      "id": "team-uuid",
      "name": "Engineering Team",
      "displayName": "Engineering Team",
      "description": "Updated description",
      "logoUrl": "https://example.com/logo.png",
      "accentColor": "482eeb",
      "teamButtonColor": "ffffff",
      "teamBackgroundImage": "https://example.com/background.jpg",
      "organizationId": "org-uuid",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:30:00Z"
    }
  },
  "meta": {
    "requestId": "uuid",
    "timestamp": "2024-01-01T00:30:00Z"
  }
}

Branding Colors

Team branding colors should be provided as hex codes without the # prefix:

✅ "482eeb" (correct)
❌ "#482eeb" (incorrect)

Users

Learn about creating and managing users

Interviews

Create interviews for your teams

Get Started

API Reference

Guides

Code Examples

Resources

Overview

Create Teams

List Teams

Get Team

Update Team Branding

Branding Colors

Users

Interviews

​Overview

​Create Teams

​List Teams

​Get Team

​Update Team Branding

​Branding Colors

​Related Resources

Users

Interviews

Overview

Create Teams

List Teams

Get Team

Update Team Branding

Branding Colors

Related Resources