Skip to content

Search for existing sessions

Request

Gets all sessions optionally filtered by request parameters

Security
keycloakAuthLive or keycloakAuthTest
Query
Searchstring

Free-text search over the data subject's full name, e-mail address and the external reference. A session matches when any of them contains the text (case-insensitive; words of a name may have other text between them). At least 3 characters, or the request is rejected. Combined with the other filters, which all have to match too.

SubjectEmailstring

Filter by the email address of the data subject.

SubjectFullNamestring

Filter by the full name of the data subject.

CountryCodestring

Filter by country, as an ISO 3166-1 alpha-3 code.

CreatedFromUtcstring, (date)

Include only sessions created on or after this timestamp (UTC).

CreatedToUtcstring, (date)

Include only sessions created on or before this timestamp (UTC).

CustomerProgressStatusstring(CustomerProgressStatusType)

Progress status of the data subject's input within a session.

Enum ValueDescription
DELIVERY_FAILED

Delivery to the customer failed.

WAITING_FOR_CUSTOMER

Awaiting action or input from the customer.

COMPLETED_BY_CUSTOMER

Customer has completed the required steps.

EXPIRED

The customer's opportunity or session expired.

CreatedByNamestring

Filter by the name of the agent who created the session.

OrganizationalUnitNamestring

Filter by the organizational unit responsible for the session.

ExternalReferencestring

Filter by the free-text reference supplied when the session was created (e.g. subject name, contract number, internal identifier).

CustomerInputCompletedFromUtcstring, (date)

Include only sessions whose customer input was completed on or after this timestamp (UTC).

CustomerInputCompletedToUtcstring, (date)

Include only sessions whose customer input was completed on or before this timestamp (UTC).

Skipinteger, (int32)

Number of records to skip for pagination.

Takeinteger, (int32)

Maximum number of records to return.

curl -i -X GET \
  'https://doc.mifundo.com/_mock/mca/v1/sessions?Search=string&SubjectEmail=string&SubjectFullName=string&CountryCode=string&CreatedFromUtc=2019-08-24&CreatedToUtc=2019-08-24&CustomerProgressStatus=DELIVERY_FAILED&CreatedByName=string&OrganizationalUnitName=string&ExternalReference=string&CustomerInputCompletedFromUtc=2019-08-24&CustomerInputCompletedToUtc=2019-08-24&Skip=0&Take=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
sessionsArray of objects or null(SessionItem)

Sessions matching the query criteria.

pagingnull(Paging)

Pagination details.

Response
{ "sessions": null, "paging": { "totalCount": 0, "skip": null, "take": null } }