Skip to main content

List Profiles

Endpoint​

GET /v1/profile

Description​

This endpoint retrieves a list of profiles associated with the user.

Path Parameters​

  • name (string, optional): Filter profiles by name. Supports partial matching with case-insensitive search.
  • page (int, optional, default=1): The page number to retrieve.
  • size (int, optional, default=10): The number of profiles to retrieve per page.
  • status (string, optional): Filter profiles by status.

Responses​

Success Response​

  • Code: 200 OK
  • Content:
{
    "id": "prs_1234567890abcdef",
    "object": "profiles",
    "total": 1,
    "profiles": [
        {
            "name": "Sample profile",
            "userId": "user_1234567890abcdef",
            "status": "Active",
            "created": "2024-07-08T06:54:31.016Z",
            "idInternal": "internal_1234567890abcdef",
            "files": [
                {
                    "id": "file_1234567890abcdef"
                }
            ]
        },
        //so on
    ]
}