Skip to main content

Retrieve Profile

Get Profile Endpoint

URL​

GET /v1/profile/{id}

Description​

This endpoint retrieves the details of a profile identified by its ID.

Request​

Path Parameters​

  • id (string): The unique identifier of the profile.

Responses​

Success Response​

  • Code: 200 OK
  • Content:
{
    "id": "pr_1234567890abcdef",
    "object": "profile",
    "profile": {
        "name": "Sample profile document",
        "userId": "user_1234567890abcdef",
        "textInfo": [
            {
                "id": "text_1234567890abcdef",
                "text": "Sample text information associated with the profile.",
                "upload_date": "2024-07-08T05:50:11.01Z",
                "type": "comment",
                "vectorized": true
            }
        ],
        "files": [],
        "status": "Active",
        "created": "2024-07-08T05:50:12.4Z",
        "idInternal": "internal_1234567890abcdef"
    }
}