groups.get

Retrieve a single LinkedIn group's full detail: its name, description, member count, membership status, and admin contact.

Prerequisites

A Curviate API key, passed as apiKey when you construct the client. Quickstart shows how to create one.
A connected LinkedIn account. This resource is account-scoped: the account_id is injected automatically by the account-scoped accessor, so you pass it once to curviate.account(...) and every call below inherits it. Quickstart covers connecting one, and accounts.list returns the account_id of each account already connected.

Signature

get(group: string): Promise<Group>

Example

import { Curviate } from "@curviate/sdk";
 
const curviate = new Curviate({
  apiKey: "cvt_live_...",
  baseUrl: "https://api.curviate.com",
});
 
const result = await curviate.account("acc_YOUR_ACCOUNT_ID").groups.get("YOUR_GROUP");
console.log(result.id);

Parameters

Name	Type	Required	Description
`group`	`string`	Yes	The group to look up: a numeric group id (e.g. 9123014) or its full group URL; the id is extracted from either form.

Returns

Resolves to Group. Top-level fields: object, id, entity_urn, name, member_count, description, type, public_visibility, direct_join_enabled, is_member, membership_status, url, admin, post_approval_enabled, invitation_level, sample_past_members, observed_at, source, withdrawn, withdrawn_at, safety_warning.

Error codes

Code	What it means, and what to do
`UNAUTHORIZED`	The API key is missing, malformed, or revoked. Check the key you passed to the client.
`INVALID_REQUEST`	A parameter failed validation. The message names the offending field; fix the request rather than retrying it.
`RATE_LIMIT_ACCOUNT`	This account's own quota is exhausted. Wait for the window in the `Retry-After` header, then retry.
`RATE_LIMIT_TENANT`	The tenant-wide quota is exhausted across all accounts. Slow the whole workload, not just this call.
`PLATFORM_RATE_LIMIT`	LinkedIn is throttling this account. Back off well beyond the hinted delay; sustained pressure risks the account.
`PLATFORM_ERROR`	An upstream failure, usually transient: retry once with backoff before treating it as a real error. Check the response first, though. When it carries `retry_likely_to_succeed: false` and `retry_hint: {kind: "never"}`, retrying cannot help and backing off only delays the real answer.
`ACCOUNT_NOT_FOUND`	No connected account with that id belongs to this tenant. List your accounts to get a current id.
`INTERNAL`	An unexpected server error. Retry once; if it persists, it is ours, not yours.
`NO_ACTIVE_SEAT`	The targeted account is not on an active seat. Buy or attach a seat in Billing, then retry.
`RESOURCE_NOT_FOUND`	The id in the path does not exist, or is not visible to this account. Re-read it from the list endpoint that produced it.

Every code above is a stable CurviateError.code you can branch on. The full list, the response envelope, and retry semantics are in the Error codes reference.

Next steps

groups.list: List the LinkedIn groups a member belongs to, each enriched to full group detail.
groups.members: List a group's members, cursor-paginated, each carrying its profile URL, name, and headline.
SDK Quick Start: installation, the client, account scoping, and pagination.