# List invite links for current user

Endpoint: GET /api/v1/users/invite-links
Version: 1.0
Security: header

## Query parameters:

  - `active` (boolean,null)
    Filter by active state

  - `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):

  - `links` (array, required)

  - `links.code` (string, required)
    Unique invite code

  - `links.ownerUserId` (string, required)
    Owner user id who created the link
    Example: "us_01hxcvk1hjexere4pvtrj0ymqq"

  - `links.expiresAt` (string,null)
    Expiration timestamp (UTC)
    Example: "2022-03-10T16:15:50Z"

  - `links.maxUses` (integer, required)
    Maximum number of uses

  - `links.usedCount` (integer, required)
    Number of uses so far

  - `links.active` (boolean, required)
    Whether link is active (not deactivated)

  - `links.createdAt` (string, required)
    Creation timestamp (UTC)
    Example: "2022-03-10T16:15:50Z"

  - `links.deactivatedAt` (string,null)
    Deactivation timestamp (UTC)
    Example: "2022-03-10T16:15:50Z"

  - `links.accounts` (array, required)
    List of account IDs created using this link
    Example: ["us_01hxcvk1hjexere4pvtrj0ymqq"]

  - `total` (integer)

## Response 401 fields (application/json):

  - `errorCode` (string, required)
    Error code

  - `message` (string, required)
    Error message

  - `docUrl` (string)
    Link to documentation