> For the complete documentation index, see [llms.txt](https://docs.limio.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.limio.com/api/journeys-api/journeys-v2.md). # Journeys V2 Manage customer journeys (v2). Create, retrieve, update, and delete journey definitions that orchestrate multi-step customer flows. ## Get Journeys V2 > Retrieves all the journeysV2 in the Catalog as a paged listing. When no journeys exist, returns 200 with an empty \`items\` array. ```json {"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Journeys V2","description":"Manage customer journeys (v2). Create, retrieve, update, and delete journey definitions that orchestrate multi-step customer flows."}],"servers":[{"url":"https://{tenant}/api","description":"Limio environment API","variables":{"tenant":{"default":"your-environment.prod.limio.com","description":"Your Limio environment hostname, e.g. `acme.prod.limio.com` or `acme-sandbox.prod.limio.com`."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.\n\nObtain a token via the OAuth flow described in [OAuth Bearer Token](https://docs.limio.com/developers/api-documentation/authentication-overview/oauth-bearer-token).\n\nPass the token in the `Authorization` header: `Bearer `"}},"schemas":{"getJourneysV2Response":{"type":"object","properties":{"items":{"type":"array","description":"The published journey group objects","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the journey record"},"record_type":{"type":"string","description":"The type of record"},"status":{"type":"string","description":"The status of the journey record"},"data":{"type":"object","description":"The journey group data","properties":{"starting_point":{"type":"string","description":"The starting point of the journey"},"fallback_tag":{"type":"string","description":"The fallback tag for the journey"},"version_date":{"type":"string","description":"Timestamp of the journey group version"},"journeys":{"type":"array","description":"The list of journeys","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the journey"},"conditions":{"type":"array","description":"The list of conditions for the journey","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the condition"},"type":{"type":"string","description":"The type of the condition","enum":["country","region","city","authentication","segment","subscriptionStatus","subscriptionOfferLabel","cloudfrontDevice","queryString","jwt","cookie"]},"value":{"type":"string","description":"The value of the condition"}}}},"actions":{"type":"array","description":"The list of actions for the journey","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the action"},"type":{"type":"string","description":"The type of the action"},"values":{"type":"array","description":"The list of values for the action","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the value"},"tag":{"type":"string","description":"The tag associated with the value"},"split":{"type":"string","description":"The split percentage for the value"}}}}}}}}}}}}}}},"queryMore":{"type":["string","null"],"description":"Pagination token. Pass it as the `queryMore` query parameter to fetch the next page. Null or absent when there are no more pages."}}}},"responses":{"401ApplicationResponse":{"description":"Unauthorized: the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","description":"The unique identifier of the request"},"code":{"type":"string"},"message":{"type":"string"}}}}}}}},"paths":{"/v2/journey":{"get":{"operationId":"getJourneysV2","summary":"Get Journeys V2","tags":["Journeys V2"],"description":"Retrieves all the journeysV2 in the Catalog as a paged listing. When no journeys exist, returns 200 with an empty `items` array.","parameters":[{"in":"query","name":"queryMore","required":false,"description":"Pagination token from the `queryMore` field of a previous response. Omit to fetch the first page.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getJourneysV2Response"}}}},"401":{"$ref":"#/components/responses/401ApplicationResponse"}}}}}} ``` ## Add Journey V2 > Adds a journey to the catalog. \`GET /api/v2/journey\` lists the journeys that already exist. ```json {"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Journeys V2","description":"Manage customer journeys (v2). Create, retrieve, update, and delete journey definitions that orchestrate multi-step customer flows."}],"servers":[{"url":"https://{tenant}/api","description":"Limio environment API","variables":{"tenant":{"default":"your-environment.prod.limio.com","description":"Your Limio environment hostname, e.g. `acme.prod.limio.com` or `acme-sandbox.prod.limio.com`."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.\n\nObtain a token via the OAuth flow described in [OAuth Bearer Token](https://docs.limio.com/developers/api-documentation/authentication-overview/oauth-bearer-token).\n\nPass the token in the `Authorization` header: `Bearer `"}},"responses":{"401ApplicationResponse":{"description":"Unauthorized: the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","description":"The unique identifier of the request"},"code":{"type":"string"},"message":{"type":"string"}}}}}}}},"paths":{"/v2/journey":{"post":{"operationId":"addJourneyV2","summary":"Add Journey V2","tags":["Journeys V2"],"description":"Adds a journey to the catalog. `GET /api/v2/journey` lists the journeys that already exist.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the journey"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","default":"Journey created successfully"}}}}}},"401":{"$ref":"#/components/responses/401ApplicationResponse"},"409":{"description":"Conflict","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","description":"The unique identifier of the request"},"code":{"type":"string","default":"conflict_found"},"message":{"type":"string","default":"Journey name already exists"}}}}}}}}}}} ``` ## Get Journey V2 by name > Returns one journey. If you do not know the name, \`GET /api/v2/journey\` lists every journey. ```json {"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Journeys V2","description":"Manage customer journeys (v2). Create, retrieve, update, and delete journey definitions that orchestrate multi-step customer flows."}],"servers":[{"url":"https://{tenant}/api","description":"Limio environment API","variables":{"tenant":{"default":"your-environment.prod.limio.com","description":"Your Limio environment hostname, e.g. `acme.prod.limio.com` or `acme-sandbox.prod.limio.com`."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.\n\nObtain a token via the OAuth flow described in [OAuth Bearer Token](https://docs.limio.com/developers/api-documentation/authentication-overview/oauth-bearer-token).\n\nPass the token in the `Authorization` header: `Bearer `"}},"schemas":{"getJourneyByNameV2Response":{"type":"object","properties":{"data":{"type":"object","properties":{"version_date":{"type":"string","format":"date-time","description":"The version timestamp of the journey"},"journeys":{"type":"array","description":"A list of journeys","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the journey"},"conditions":{"type":"array","description":"The list of conditions for the journey","items":{"type":"object"}},"actions":{"type":"array","description":"The list of actions for the journey","items":{"type":"object"}}}}},"starting_point":{"type":"string","description":"The starting point of the journey"}}},"status":{"type":"string","description":"The status of the journey record"},"record_type":{"type":"string","description":"The type of record"},"id":{"type":"string","description":"The unique ID of the journey record"},"service":{"type":"string","description":"The service the journey belongs to"},"created":{"type":"string","format":"date-time","description":"Timestamp when the record was created"},"updated":{"type":"string","format":"date-time","description":"Timestamp when the record was last updated"},"mode":{"type":"string","description":"The environment or mode the journey is in"},"process_hash":{"type":"string","description":"The hash used for processing the journey"},"version":{"type":"string","description":"The version hash of the journey"}}}},"responses":{"401ApplicationResponse":{"description":"Unauthorized: the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","description":"The unique identifier of the request"},"code":{"type":"string"},"message":{"type":"string"}}}}}}}},"paths":{"/v2/journey/{journeyName}":{"get":{"operationId":"getJourneyV2ByName","summary":"Get Journey V2 by name","tags":["Journeys V2"],"description":"Returns one journey. If you do not know the name, `GET /api/v2/journey` lists every journey.","parameters":[{"name":"journeyName","in":"path","required":true,"description":"The name of the journey to retrieve","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getJourneyByNameV2Response"}}}},"401":{"$ref":"#/components/responses/401ApplicationResponse"},"404":{"description":"Journey not found","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","description":"The unique identifier of the request"},"code":{"type":"string","default":"data_not_found"},"message":{"type":"string","default":"Not Found: Journey not found"}}}}}}}}}}} ``` ## Update or Create Journey V2 > Updates an existing Journey V2 with the provided data, identified by the \`journeyName\` path parameter. If no Journey V2 with the specified \`journeyName\` exists, a new one will be created. ```json {"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Journeys V2","description":"Manage customer journeys (v2). Create, retrieve, update, and delete journey definitions that orchestrate multi-step customer flows."}],"servers":[{"url":"https://{tenant}/api","description":"Limio environment API","variables":{"tenant":{"default":"your-environment.prod.limio.com","description":"Your Limio environment hostname, e.g. `acme.prod.limio.com` or `acme-sandbox.prod.limio.com`."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.\n\nObtain a token via the OAuth flow described in [OAuth Bearer Token](https://docs.limio.com/developers/api-documentation/authentication-overview/oauth-bearer-token).\n\nPass the token in the `Authorization` header: `Bearer `"}},"parameters":{"journeyName":{"in":"path","name":"journeyName","required":true,"description":"The unique name of the journey.","schema":{"type":"string"}}},"schemas":{"PutJourneysV2Request":{"type":"object","required":["name","data"],"properties":{"name":{"type":"string","description":"Name of the journey."},"data":{"type":"object","required":["journeys"],"description":"Journey conditions to be added.","properties":{"journeys":{"type":"array","description":"A list of journeys to be updated.","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the journey."},"conditions":{"type":"array","description":"List of conditions to be evaluated for the journey.","items":{"type":"object","properties":{"id":{"type":"string","description":"Condition identifier."},"type":{"type":"string","description":"Condition type, such as \"country\"."},"value":{"type":"array","description":"Condition values.","items":{"type":"string"}}}}},"actions":{"type":"array","description":"List of actions to be executed for the journey.","items":{"type":"object","properties":{"id":{"type":"string","description":"Action identifier."},"type":{"type":"string","description":"Action type, such as \"destination\"."},"values":{"type":"array","description":"List of action values.","items":{"type":"object","properties":{"id":{"type":"string","description":"Action value identifier."},"tag":{"type":"string","description":"Action value tag, such as \"/\"."},"split":{"type":"string","description":"Action value split."}}}}}}}}}},"starting_point":{"type":"string","description":"Optional starting point of the journey."},"fallback_tag":{"type":"string","description":"Optional fallback tag."},"domains":{"type":"array","description":"Optional list of domains related to the journey.","items":{"type":"string"}}}}}},"PutJourneysV2Response":{"type":"object","description":"The newly created version of the journey record. The API stores every update as a new version and returns the full versioned record, not an echo of the request body.","properties":{"id":{"type":"string","description":"The unique ID of the journey record, derived from the journey name."},"record_type":{"type":"string","description":"The type of record."},"service":{"type":"string","description":"The service the journey belongs to."},"status":{"type":"string","description":"The status of the journey record."},"name":{"type":"string","description":"The starting point submitted in the request body, not the journey name from the path."},"data":{"type":"object","description":"The journey data that was stored for this version.","properties":{"id":{"type":"string","description":"The unique ID of the journey record."},"journeys":{"type":"array","description":"The list of journeys that was submitted.","items":{"type":"object"}},"starting_point":{"type":"string","description":"The starting point of the journey."},"fallback_tag":{"type":"string","description":"The fallback tag of the journey."},"domains":{"type":"array","description":"The list of domains related to the journey.","items":{"type":"string"}}}},"mode":{"type":"string","description":"The environment or mode the journey is in."},"created":{"type":"string","format":"date-time","description":"Timestamp when this version was created."},"updated":{"type":"string","format":"date-time","description":"Timestamp when this version was last updated."},"version":{"type":"string","description":"The identifier of this version of the journey."}}}},"responses":{"401ApplicationResponse":{"description":"Unauthorized: the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","description":"The unique identifier of the request"},"code":{"type":"string"},"message":{"type":"string"}}}}}}}},"paths":{"/v2/journey/{journeyName}":{"put":{"operationId":"putJourneysV2","summary":"Update or Create Journey V2","tags":["Journeys V2"],"description":"Updates an existing Journey V2 with the provided data, identified by the `journeyName` path parameter. If no Journey V2 with the specified `journeyName` exists, a new one will be created.","parameters":[{"$ref":"#/components/parameters/journeyName"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutJourneysV2Request"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutJourneysV2Response"}}}},"401":{"$ref":"#/components/responses/401ApplicationResponse"}}}}}} ``` ## Delete JourneyV2 by name > Deletes one journey. If you do not know the name, \`GET /api/v2/journey\` lists every journey. ```json {"openapi":"3.1.0","info":{"title":"Limio Commerce API","version":"1.0.0"},"tags":[{"name":"Journeys V2","description":"Manage customer journeys (v2). Create, retrieve, update, and delete journey definitions that orchestrate multi-step customer flows."}],"servers":[{"url":"https://{tenant}/api","description":"Limio environment API","variables":{"tenant":{"default":"your-environment.prod.limio.com","description":"Your Limio environment hostname, e.g. `acme.prod.limio.com` or `acme-sandbox.prod.limio.com`."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.\n\nObtain a token via the OAuth flow described in [OAuth Bearer Token](https://docs.limio.com/developers/api-documentation/authentication-overview/oauth-bearer-token).\n\nPass the token in the `Authorization` header: `Bearer `"}},"responses":{"401ApplicationResponse":{"description":"Unauthorized: the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","description":"The unique identifier of the request"},"code":{"type":"string"},"message":{"type":"string"}}}}}}}},"paths":{"/v2/journey/{journeyName}":{"delete":{"operationId":"deleteJourneyV2ByName","summary":"Delete JourneyV2 by name","tags":["Journeys V2"],"description":"Deletes one journey. If you do not know the name, `GET /api/v2/journey` lists every journey.","parameters":[{"name":"journeyName","in":"path","required":true,"description":"The name of the journey to delete","schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully deleted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","default":"Journey group deleted successfully"}}}}}},"401":{"$ref":"#/components/responses/401ApplicationResponse"},"404":{"description":"Journey not found","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","description":"The unique identifier of the request"},"code":{"type":"string","default":"data_not_found"},"message":{"type":"string","default":"Not Found: Journey not found"}}}}}}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.limio.com/api/journeys-api/journeys-v2.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.