# Get user's pinned groups

Retrieve all groups pinned by the current user, ordered by pin number

Endpoint: GET /api/v1/groups/pinned
Version: 1.0
Security: header

## Query parameters:

  - `lastId` (string,null)
    Get older records (records with IDs less than this value) Alias maxId/max_id
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `limit` (integer,null)

  - `offset` (integer,null)

  - `sortBy` (string,null)

  - `sortOrder` (string,null)

  - `untilId` (string,null)
    Get newer records (records with IDs greater than this value) Alias minId/min_id
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

## Response 200 fields (application/json):

  - `userId` (string, required)
    ID of the user who pinned the group
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `groupId` (string, required)
    ID of the pinned group
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `pin` (integer, required)
    Pin order number (positive integer for sorting)

  - `createdAt` (string, required)
    When the group was pinned
    Example: "2022-03-10T12:15:50"

  - `updatedAt` (string, required)
    When the pin was last updated
    Example: "2022-03-10T12:15:50"

## Response 401 fields (application/json):

  - `errorCode` (string, required)
    Error code

  - `message` (string, required)
    Error message

  - `docUrl` (string)
    Link to documentation

## Response 403 fields (application/json):

  - `errorCode` (string, required)
    Error code

  - `message` (string, required)
    Error message

  - `docUrl` (string)
    Link to documentation