Profiles

Create Profile

Creates a new profile.

Method: client.profiles.create(): CreateProfileResponse

Endpoint: POST /api/profile

Response: CreateProfileResponse

Example:

profile = client.profiles.create()
print(profile.id)

Get Profile

Get details of an existing profile.

Method: client.profiles.get(id: str): ProfileResponse

Endpoint: GET /api/profile/{id}

Parameters:

  • id: string - Profile ID

Response: ProfileResponse

Example:

profile = client.profiles.get("36946080-9b81-4288-81d5-b15f2191f222")
print(profile.id)

Delete Profile

Delete an existing profile.

Method: client.profiles.delete(id: str): BasicResponse

Endpoint: DELETE /api/profile/{id}

Parameters:

  • id: string - Profile ID

Response: BasicResponse

Example:

response = client.profiles.delete("36946080-9b81-4288-81d5-b15f2191f222")
print(response)

Types

CreateProfileResponse

class CreateProfileResponse(BaseModel):
    id: str

ProfileResponse

class ProfileResponse(BaseModel):
    id: str
    team_id: str = Field(alias="teamId")
    created_at: datetime = Field(alias="createdAt")
    updated_at: datetime = Field(alias="updatedAt")

Last updated

Logo

© 2025 S2 Labs, Inc. All rights reserved.