Skip to content

Latest commit

 

History

History
164 lines (90 loc) · 4.69 KB

File metadata and controls

164 lines (90 loc) · 4.69 KB

\ProfilesApi

All URIs are relative to https://zernio.com/api

Method HTTP request Description
create_profile POST /v1/profiles Create profile
delete_profile DELETE /v1/profiles/{profileId} Delete profile
get_profile GET /v1/profiles/{profileId} Get profile
list_profiles GET /v1/profiles List profiles
update_profile PUT /v1/profiles/{profileId} Update profile

create_profile

models::ProfileCreateResponse create_profile(create_profile_request) Create profile

Creates a new profile with a name, optional description, and color.

Parameters

Name Type Description Required Notes
create_profile_request CreateProfileRequest [required]

Return type

models::ProfileCreateResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_profile

models::DeleteAccountGroup200Response delete_profile(profile_id) Delete profile

Permanently deletes a profile by ID.

Parameters

Name Type Description Required Notes
profile_id String [required]

Return type

models::DeleteAccountGroup200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_profile

models::GetProfile200Response get_profile(profile_id) Get profile

Returns a single profile by ID, including its name, color, and default status.

Parameters

Name Type Description Required Notes
profile_id String [required]

Return type

models::GetProfile200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_profiles

models::ProfilesListResponse list_profiles(include_over_limit) List profiles

Returns profiles sorted by creation date. Use includeOverLimit=true to include profiles that exceed the plan limit.

Parameters

Name Type Description Required Notes
include_over_limit Option<bool> When true, includes over-limit profiles (marked with isOverLimit: true). [default to false]

Return type

models::ProfilesListResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_profile

models::UpdateProfile200Response update_profile(profile_id, update_profile_request) Update profile

Updates a profile's name, description, color, or default status.

Parameters

Name Type Description Required Notes
profile_id String [required]
update_profile_request UpdateProfileRequest [required]

Return type

models::UpdateProfile200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]