---
title: "Parse a client URL to extract parameters and route info. Roles: public."
method: GET
path: "/api/client-routes/match"
tags: ["Client Routes"]
---

# Parse a client URL to extract parameters and route info. Roles: public.

`GET /api/client-routes/match`

## Request

- Base URL: `https://api.mobilecoach.org` (the document declares no server; this is the origin it was published from)
- URL: `https://api.mobilecoach.org/api/client-routes/match`
- Auth: none declared

## Query parameters

- `appKey` string
- `url` string

## Response `200`

OK

- ClientRouteMatchResponse
  - `success` boolean
  - `error` string
  - `match` ClientRouteMatch
    - `route` 'CHAT_GROUP_MESSAGE' | 'CHAT_MEMBER_MESSAGE' | 'GROUP_EVENT_ICS' | 'PAGE_PLAYLIST_CONTENT' | 'PAGE_PLAYLIST' | 'PAGE_CONTENT' | 'PAGE' | 'CONTENT' | 'ACTIVITY' | 'COURSE' | 'MEMBER_RESOURCE' | 'MEMBER_RESOURCES' | 'PROGRAM' | 'MEMBERSHIP_PROGRAMS' | 'PASSES' | 'CHALLENGE' | 'MY_CERTS' | 'MY_CHALLENGES' | 'MY_COURSES' | 'MY_PLAYLISTS' | 'MY_WHITEBOARDS' | 'MEMBER_DIRECTORY' | 'BANNED_USERS' | 'EVENTS' | 'EVENTS_POS'
    - `params` ClientRouteParams
      - `membershipId` integer
      - `pageId` integer
      - `contentId` integer
      - `eventId` integer
      - `playlistId` integer
      - `programId` integer
      - `memberId` integer
      - `isPrivatePage` boolean
      - `isPrivateMembership` boolean
      - `privatePage` boolean
      - `privateMembership` boolean
    - `isMatch` boolean

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `500`: Internal server error

## Changes

- **2026-09-18** `36f72442f0a1`: 2 warning
  - added the new `MEMBER_RESOURCE` enum value to the `match/route` response property for the response status `200`
  - added the new `MEMBER_RESOURCES` enum value to the `match/route` response property for the response status `200`
- **2026-09-02** `870f28ba2607`: 5 info
  - added the optional property `error/errorId` to the response with the `400` status
  - added the optional property `error/errorId` to the response with the `401` status
  - added the optional property `error/errorId` to the response with the `403` status
  - added the optional property `error/errorId` to the response with the `404` status
  - …1 more

[Operation history](https://skmtc.dev/mobilecoach/apis/mobilecoach-api/changes/api/client-routes/match/get.md)

---

[API](https://skmtc.dev/mobilecoach/apis/mobilecoach-api.md) - [All operations](https://skmtc.dev/mobilecoach/apis/mobilecoach-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mobilecoach/apis/mobilecoach-api/revisions/df463b248fcb?raw)