v1

latestOpenAPI 3.0.02026-07-175652103.9 KB
address book

Get Shared Profiles

This function is an API endpoint that retrieves the shared profiles from an address book. It is tagged with "address book" for OpenAPI documentation.

Parameters

  • none

Returns

If successful, this function returns a Json<AbSharedProfilesResponse> object containing the shared profiles in the address book. <br> rule: 1: read, 2: write, 3: full control <br> If the address book does not exist or the user is not authorized to access it, this function returns a status::Unauthorized error. <br>

Errors

This function will return an error if the system is in maintenance mode, or if the address book does not exist or the user is not authorized to access it.

Example

{"data":[{"guid":"018fab24-0ae5-731c-be23-88aa4518ea26","name":"shared profile","owner":"admin","rule":3}],"total":2}

post/api/ab/shared/profiles

Response

errorstring nullable
totalinteger required