Lista as sessões de uma jornada de vínculo.

get https://api-sandbox-v2.openkeys.e012950j.sand.fsapps.app/open-keys/itp/api/v2/enrollments/v2/journeys-sessions

Método para listar todas as sessões de uma jornada criadas por uma aplicação. Deve ser passado o id da jornada que deve ser listadas as sessões.

Responses

Response body

object

data

array of objects

data

object

string

required

length between 0 and 36

O id é o identificador único da jornada

createdAt

int32

required

-999999 to 999999

updatedAt

int32

required

-999999 to 999999

journeyId

string

required

length between 0 and 36

Defaults to default

O id é o identificador único da jornada

redirectUrl

uri

length between 0 and 999999

O endereço de redirecionamento para a jornada, após o fluxo da jornada. Precisa ser um dos cadastrados na aplicação.

brandId

string

length between 0 and 36

O id é o identificador único da brand

externalId

string

length between 0 and 36

O id é o identificador único da jornada

tags

string

length between 0 and 999999

Tags que podem ser usadas para classificar a sessão da jornada.

settings

array of objects

Lista de configurações da sessão da jornada

settings

object

key

string

required

					Tipos de chaves usadas para a customização da sessão da jornada.

					- PRIORITIES_BRANDS - Lista de ids dos brands prioritátios
					- JOURNEY_RULES - Regras para execução da jornada.

PRIORITIES_BRANDS JOURNEY_RULES

value

string

required

length between 0 and 999999

Valor da configuração.

paymentInitiationApi

string

required

ENROLLMENTS_V2

applicationClientId

string

required

length between 0 and 999999

O clientId da aplicação.

applicationId

string

required

length between 0 and 36

O ID da aplicação. É um número exclusivo que identifica a aplicação.

tokenId

string

required

length between 0 and 36

O ID do token. É um número exclusivo que identifica o token.

journeySessionUrl

uri

required

length between 0 and 999999

A url da sessão da jornada que deve ser aberta para o usuário.

status

string

required

Status da sessão da jornada.

PENDING CANCELLED EXPIRED AWAITING_AUTHORISATION CONSUMED REJECTED FINISHED

statusHistory

array of objects

Lista com o histórico de Status da sessão da jornada.

statusHistory

object

updatedAt

int32

required

-999999 to 999999

status

string

required

Status da sessão da jornada.

PENDING CANCELLED EXPIRED AWAITING_AUTHORISATION CONSUMED REJECTED FINISHED

journeySessionStageId

string

length between 0 and 36

O id é o identificador único do estágio da sessão da jornada

200Retorno com sucesso da lista paginada.

401O cliente deve se autenticar.

409O status de resposta 409 Conflict indica que a solicitação atual conflitou com o recurso que está no servidor.

422Campos inválidos

500Erro do servidor: 500 a 599.

defaultErro inesperado.