Skip to content
ShiftSync Developers

List groups

Returns the authenticated user’s friend groups and their members.

GET
/v1/groups
curl --request GET \
  --url https://api.shiftsync.app/v1/groups \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The caller’s friend groups

Media typeapplication/json
object
items
required
Array<object>
object
id
required
integer
>= -9007199254740991 <= 9007199254740991
name
required
string
description
string
users
required
Array<object>
object
id
required
integer
>= -9007199254740991 <= 9007199254740991
emailAddress
required
string format: email
/^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/
firstName
required
string
lastName
string
verified
required
boolean
isFacebookAuth
boolean
isGoogleAuth
boolean
isMicrosoftAuth
boolean
hasPassword
boolean
userPlan
required
string
Allowed values: free premium
firstDayOfWeek
required
string
timezone
required
string
nullable
avatarUrls
object
small
required
string format: uri
medium
required
string format: uri
large
required
string format: uri
markedForDeletion
required
boolean
deletionScheduledFor
string
Example
{
  "items": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "users": [
        {
          "id": 0,
          "emailAddress": "user@example.com",
          "firstName": "string",
          "lastName": "string",
          "verified": true,
          "isFacebookAuth": true,
          "isGoogleAuth": true,
          "isMicrosoftAuth": true,
          "hasPassword": true,
          "userPlan": "free",
          "firstDayOfWeek": "string",
          "timezone": "string",
          "avatarUrls": {
            "small": "https://example.com",
            "medium": "https://example.com",
            "large": "https://example.com"
          },
          "markedForDeletion": true,
          "deletionScheduledFor": "string"
        }
      ]
    }
  ]
}