---
title: "Get Shared Profiles"
method: POST
path: "/api/ab/shared/profiles"
tags: ["address book"]
---

# Get Shared Profiles

`POST /api/ab/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}

## Response `200`

- AbSharedProfilesResponse
  - `error` string, nullable
  - `total` integer, required
  - `data` AbProfile[], required
    - `guid` string, required
    - `name` string, required
    - `owner` string, required
    - `note` string, nullable
    - `rule` integer, required

## Other responses

- `401`

---

[API](https://skmtc.dev/nesaku/apis/sctgdesk-api-server.md) · [All operations](https://skmtc.dev/nesaku/apis/sctgdesk-api-server/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nesaku/sctgdesk-api-server/revisions/b1c0e7a4434f/schema)