# Search for existing sessions

Gets all sessions optionally filtered by request parameters

Endpoint: GET /v1/sessions
Version: 1.0
Security: keycloakAuthTest, keycloakAuthLive

## Query parameters:

  - `SubjectEmail` (string)
    Email address of the data subject used to filter sessions.

  - `SubjectFullName` (string)
    Full name of the data subject used to filter sessions.

  - `CountryCode` (string)
    ISO 3166-1 alpha-3 code representing the country related to the sessions.

  - `CreatedFromUtc` (string)
    Start date (UTC) for filtering sessions by creation date.

  - `CreatedToUtc` (string)
    End date (UTC) for filtering sessions by creation date.

  - `CustomerProgressStatus` (string)
    Specifies the progress status of a customer in a process.
    Enum: "DELIVERY_FAILED", "WAITING_FOR_CUSTOMER", "COMPLETED_BY_CUSTOMER", "EXPIRED"

  - `CreatedByName` (string)
    Name of the person who created the session.

  - `OrganizationalUnitName` (string)
    Name of the organizational unit responsible for the session.

  - `Skip` (integer)
    Number of records to skip when retrieving paginated results.

  - `Take` (integer)
    Number of records to retrieve in the paginated result.

## Response 200 fields (application/json):

  - `sessions` (array,null)
    List of sessions matching the query parameters.

  - `sessions.id` (string, required)
    Unique Session identifier. Used in subsequent requests to fetch Session related data.

  - `sessions.createdAtUtc` (string, required)
    Session creation time in UTC.

  - `sessions.createdByName` (string,null)
    Agent name who created the Session.

  - `sessions.organizationalUnitName` (string,null)
    Organizational unit name of the agent who created the Session.

  - `sessions.subjectEmail` (string,null, required)
    Data Subject email. This is used to contact the Data Subject for getting Consents

  - `sessions.subjectFullName` (string,null)
    Data Subject full name. Field will stay empty until subject has completed the identification step.

  - `sessions.customerInputDeadlineUtc` (string,null)
    Deadline by which the customer is expected to provide input. If Data Subject hasn't provided the input by that time, new Session should be created.

  - `sessions.customerProgressStatus` (string, required)
    Current Session status.
    Enum: "DELIVERY_FAILED", "WAITING_FOR_CUSTOMER", "COMPLETED_BY_CUSTOMER", "EXPIRED"

  - `sessions.queryParameters` (array,null, required)
    Session input elements

  - `sessions.queryParameters.countryCode` (string,null, required)
    ISO 3166-1 alpha-3 code representing the country for which the customer is requesting information about the Data Subject.

  - `sessions.queryParameters.dataPackages` (array,null)
    List of data packages requested for the specified country.
    Enum: "CREDIT_HISTORY", "SCORE", "BANK_ACCOUNT_CATEGORIZATION", "IDENTIFICATION"

  - `paging` (object,null)
    Paging details for the sessions response.

  - `paging.totalCount` (integer)
    Total number of items available.

  - `paging.skip` (integer,null)
    Number of items to skip before starting to return results.

  - `paging.take` (integer,null)
    Number of items to return in the current page from the skipped result.

## Response 400 fields (application/json):

  - `type` (string,null)

  - `title` (string,null)

  - `status` (integer,null)

  - `detail` (string,null)

  - `instance` (string,null)

  - `errors` (object,null)


## Response 401 fields

## Response 403 fields

## Response 404 fields

## Response 500 fields