groups.members

List a group's members, cursor-paginated, each carrying its profile URL, name, and headline.

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

members(group: string, params?: GroupMemberListQuery): Promise<GroupMemberListPage>

Example

import { Curviate } from "@curviate/sdk";
 
const curviate = new Curviate({
  apiKey: "cvt_live_...",
  baseUrl: "https://api.curviate.com",
});
 
const page = await curviate.account("acc_YOUR_ACCOUNT_ID").groups.members("YOUR_GROUP");
for (const item of page.items ?? []) {
  console.log(item.id);
}
// `page.cursor` is the opaque cursor for the next page (null when exhausted).

Parameters

NameTypeRequiredDescription
groupstringYesThe group to look up: a numeric group id (e.g. 9123014) or its full group URL; the id is extracted from either form.
namestringNoFilter members by name, prefix/substring, case-insensitive. Folds in member search as this endpoint, not a separate one.
limitnumberNoMaximum items per page (1-100, default 20). The returned count can exceed this; the response includes a cursor to continue.
cursorstringNoOpaque cursor from a prior response's cursor. Omit for the first page. Scoped to the name value it was minted under.

Returns

Resolves to GroupMemberListPage. Top-level fields: object, items, paging, cursor, safety_warning.

Error codes

CodeWhat it means, and what to do
UNAUTHORIZEDThe API key is missing, malformed, or revoked. Check the key you passed to the client.
INVALID_REQUESTA parameter failed validation. The message names the offending field; fix the request rather than retrying it.
RATE_LIMIT_ACCOUNTThis account's own quota is exhausted. Wait for the window in the Retry-After header, then retry.
RATE_LIMIT_TENANTThe tenant-wide quota is exhausted across all accounts. Slow the whole workload, not just this call.
PLATFORM_RATE_LIMITLinkedIn is throttling this account. Back off well beyond the hinted delay; sustained pressure risks the account.
PLATFORM_ERRORAn 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_FOUNDNo connected account with that id belongs to this tenant. List your accounts to get a current id.
INTERNALAn unexpected server error. Retry once; if it persists, it is ours, not yours.
NO_ACTIVE_SEATThe targeted account is not on an active seat. Buy or attach a seat in Billing, then retry.
RESOURCE_NOT_FOUNDThe 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.get: Retrieve a single LinkedIn group's full detail: its name, description, member count, membership status, and admin contact.
  • SDK Quick Start: installation, the client, account scoping, and pagination.