Search Sender Profiles

Search sender profiles by name.

Searches through the authenticated user’s profiles for those matching the search query. Search is case-insensitive and matches partial names.

Args: query: Search query string current_user: Authenticated user information settings: Application settings limit: Maximum number of profiles to return (default: 20)

Returns: List of matching sender profiles

GET /api/v1/sender-profiles/search

Search Sender Profiles

cURL

curl --request GET \
  --url https://api.example.com/api/v1/sender-profiles/search/ \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "user_id": "<string>",
    "profile_name": "<string>",
    "sender_data": {
      "data": {}
    },
    "id": "<string>",
    "description": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "usage_count": 0,
    "is_default": false
  }
]

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

query · string · required

limit · integer · default: 20

Response

200

application/json

Successful Response

user_id · string · required

User ID who owns this profile

profile_name · string · required

User-friendly name for this profile (e.g., 'Sales Team Profile', 'Personal Brand')

Required string length: 1 - 100

sender_data · DynamicSenderData · object · required

The actual sender data with arbitrary fields

Show child attributes

id · string | null

Unique profile identifier

description · string | null

Optional description of when/how to use this profile

Maximum string length: 500

created_at · string<date-time> | null

Profile creation timestamp

updated_at · string<date-time> | null

Last update timestamp

usage_count · integer · default: 0

Number of times this profile has been used

is_default · boolean · default: false

Whether this is the default profile