Get landing pages by type

get

https://example.com/organization/v1/landing-pages/{landingPageType}

Will return all the landing pages for a given landing page type. Landing pages with a null value in the organizationId field are considered as global landing pages. Those with a value in the organizationId field are overrides for that specific organization.

Path Parameters:

Parameter	Type	Mandatory	Description	Example
landingPageType	string	true	The type of the landing page. Could be one of the following: [ACCEPT_INVITATION, FORGOT_PASSWORD]	ACCEPT_INVITATION

This API requires LANDING_PAGE_GET_LANDING_PAGES permission(s).

Responses

Parameter	Type	Description	Example
type	string	Values:ACCEPT_INVITATION,FORGOT_PASSWORD
pages	array
pages[index]	array
pages[index].userType	string	The type of the user. Can be one of the following: [patient, caregiver, organization-user]	patient
pages[index].organizationId	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
pages[index].url	string	The landing page URL	https://example.com/auth/invitation
pages[index].landingPageType	string	Values:ACCEPT_INVITATION,FORGOT_PASSWORD

400Bad Request

401Code : TOKEN_NOT_VALID, Details: []

403Code : ACCESS_DENIED, Details: []

500Code : INTERNAL_SERVER_ERROR, Details: []

504Code : GATEWAY_TIMEOUT, Details: []