# Get Guest Users

This API endpoint enables fetching a collection of guest users. By providing the desired email as parameter, the API response narrows down the results to the specified guest user.


Endpoint: GET /api/v1/guest-users
Version: 1.0.0
Security: x-api-key

## Query parameters:

  - `filter[email]` (string)
    Specifies the email of a guest user. Valid values are strings. Must be used in conjunction with filter[name].
    Example: "jane.doe@floqast.com"

  - `page[size]` (integer)
    The number of items to return. If not specified, the API will return a default of 30,000 items, which is the maximum value.
    Example: 12000

  - `page[cursor]` (string)
    Pagination cursor that indicates the starting position for the next set of items
    Example: "5e94d5b63f557b001420bbe3"

## Response 200 fields (application/json):

  - `data` (array)
    Array of guest users

  - `data.id` (string)
    Id of guest user
    Example: "5e94d5b63f557b001420bbe3"

  - `data.firstName` (string)
    First name of guest user
    Example: "Jane"

  - `data.lastName` (string)
    Last name of guest user
    Example: "Doe"

  - `data.email` (string)
    Email of guest user
    Example: "jane.doe@floqast.com"

  - `data.tlcId` (string)
    TLC ID of guest user
    Example: "65a05e75d3ebfe001934c515"

  - `links` (object)

  - `links.self` (string)
    Link to self

  - `links.next` (string)
    Pagination link pointing to the next page

## Response 400 fields (application/json):

  - `message` (string)
    Reason for the errors related to incorrect query keys or values that are out of bound
    Example: "filter[month] is required"

  - `name` (string)
    BadRequest
    Example: "BadRequest"

  - `status` (integer)
    The HTTP status code.
    Example: 400

## Response 401 fields (application/json):

  - `message` (string)
    Reason for the error such as incorrect service access, malformed, expired or deactivated token.
    Example: "Invalid token"

  - `name` (string)
    Unauthorized
    Example: "Unauthorized"

  - `status` (integer)
    The HTTP status code.
    Example: 401