159 lines
4.1 KiB
Markdown
159 lines
4.1 KiB
Markdown
---
|
|
name: profiles-routes
|
|
description: Handle 12 OpenAPI operation(s) under /api/profiles for the profiles route group.
|
|
---
|
|
|
|
# profiles API Routes
|
|
|
|
Handle 12 OpenAPI operation(s) under /api/profiles for the profiles route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### get_profiles
|
|
|
|
- Operation ID: `get_profiles`
|
|
- Route: `GET /api/profiles`
|
|
- Mode: READ
|
|
- Summary: Get Profiles
|
|
- Parameters:
|
|
- `additional-fields[profile]` in `query`
|
|
- `fields[conversation]` in `query`
|
|
- `fields[profile]` in `query`
|
|
- `fields[push-token]` in `query`
|
|
- `filter` in `query`
|
|
- `include` in `query`
|
|
- `page[cursor]` in `query`
|
|
- `page[size]` in `query`
|
|
- `sort` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### create_profile
|
|
|
|
- Operation ID: `create_profile`
|
|
- Route: `POST /api/profiles`
|
|
- Mode: WRITE
|
|
- Summary: Create Profile
|
|
- Parameters:
|
|
- `additional-fields[profile]` in `query`
|
|
- `fields[profile]` in `query`
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_profile
|
|
|
|
- Operation ID: `get_profile`
|
|
- Route: `GET /api/profiles/{id}`
|
|
- Mode: READ
|
|
- Summary: Get Profile
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `additional-fields[profile]` in `query`
|
|
- `fields[conversation]` in `query`
|
|
- `fields[list]` in `query`
|
|
- `fields[profile]` in `query`
|
|
- `fields[push-token]` in `query`
|
|
- `fields[segment]` in `query`
|
|
- `include` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### update_profile
|
|
|
|
- Operation ID: `update_profile`
|
|
- Route: `PATCH /api/profiles/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Update Profile
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `additional-fields[profile]` in `query`
|
|
- `fields[profile]` in `query`
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_push_tokens_for_profile
|
|
|
|
- Operation ID: `get_push_tokens_for_profile`
|
|
- Route: `GET /api/profiles/{id}/push-tokens`
|
|
- Mode: READ
|
|
- Summary: Get Push Tokens for Profile
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[push-token]` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### get_push_token_ids_for_profile
|
|
|
|
- Operation ID: `get_push_token_ids_for_profile`
|
|
- Route: `GET /api/profiles/{id}/relationships/push-tokens`
|
|
- Mode: READ
|
|
- Summary: Get Push Token IDs for Profile
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `revision` in `header` required
|
|
|
|
### get_lists_for_profile
|
|
|
|
- Operation ID: `get_lists_for_profile`
|
|
- Route: `GET /api/profiles/{id}/lists`
|
|
- Mode: READ
|
|
- Summary: Get Lists for Profile
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[list]` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### get_list_ids_for_profile
|
|
|
|
- Operation ID: `get_list_ids_for_profile`
|
|
- Route: `GET /api/profiles/{id}/relationships/lists`
|
|
- Mode: READ
|
|
- Summary: Get List IDs for Profile
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `revision` in `header` required
|
|
|
|
### get_segments_for_profile
|
|
|
|
- Operation ID: `get_segments_for_profile`
|
|
- Route: `GET /api/profiles/{id}/segments`
|
|
- Mode: READ
|
|
- Summary: Get Segments for Profile
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[segment]` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### get_segment_ids_for_profile
|
|
|
|
- Operation ID: `get_segment_ids_for_profile`
|
|
- Route: `GET /api/profiles/{id}/relationships/segments`
|
|
- Mode: READ
|
|
- Summary: Get Segment IDs for Profile
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `revision` in `header` required
|
|
|
|
### get_conversation_for_profile
|
|
|
|
- Operation ID: `get_conversation_for_profile`
|
|
- Route: `GET /api/profiles/{id}/conversation`
|
|
- Mode: READ
|
|
- Summary: Get Conversation for Profile
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[conversation]` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### get_conversation_id_for_profile
|
|
|
|
- Operation ID: `get_conversation_id_for_profile`
|
|
- Route: `GET /api/profiles/{id}/relationships/conversation`
|
|
- Mode: READ
|
|
- Summary: Get Conversation ID for Profile
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `revision` in `header` required
|