Reads one community (UC-CM-38); works while the module is disabled.

GET

/api/workspace/community-memberships/communities/{communityId}

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://example.com/api/workspace/community-memberships/communities/example"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/community-memberships/communities/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/workspace/community-memberships/communities/example \
  --header 'Authorization: Bearer <token>'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

communityId

required

string

Community identifier.

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Responses

200

application/json

object

Data

object

Data

HTTP view of one community (UC-CM-38).

object

Community identifier.

string

nullable

DisplayName

Display name, unique in the workspace.

string

nullable

Description

Description, or null when there is none.

string

nullable

TimeZoneId

Canonical IANA timezone of the community’s periods, for example Europe/Warsaw.

string

nullable

IsEnabled

Whether the community accepts new memberships and renewals.

boolean

RowVersion

Version of the stored community; a change sends it back (UC-CM-36).

string format: uuid

Permissions

Community Memberships permissions the caller holds in the scope of a response: the Workspace for a list, one community for that community. The client offers an action only when its permission is granted; the server still checks every command.

object

Granted

Granted manifest permission keys, for example community.create, in manifest order.

Array<string>

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

404

Not Found

application/json

object

Data

object

Data

HTTP view of one community (UC-CM-38).

object

Community identifier.

string

nullable

DisplayName

Display name, unique in the workspace.

string

nullable

Description

Description, or null when there is none.

string

nullable

TimeZoneId

Canonical IANA timezone of the community’s periods, for example Europe/Warsaw.

string

nullable

IsEnabled

Whether the community accepts new memberships and renewals.

boolean

RowVersion

Version of the stored community; a change sends it back (UC-CM-36).

string format: uuid

Permissions

object

Granted

Granted manifest permission keys, for example community.create, in manifest order.

Array<string>

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}