List friends

Returns the authenticated user’s accepted friends.

GET

/v1/friends

const url = 'https://api.shiftsync.app/v1/friends';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Authorizations

oauth2
friends:read

Responses

200

The caller’s friends

application/json

object

items

required

Array<object>

object

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

avatarUrls

object

small

required

string format: uri

medium

required

string format: uri

large

required

string format: uri

acceptedAt

required

string format: date-time

Example

{
  "items": [
    {
      "id": 0,
      "emailAddress": "user@example.com",
      "firstName": "string",
      "lastName": "string",
      "avatarUrls": {
        "small": "https://example.com",
        "medium": "https://example.com",
        "large": "https://example.com"
      },
      "acceptedAt": "2026-01-01T09:00:00.000Z"
    }
  ]
}