/gab/groups

POST /api/gab/groups

Price: 1 credit

Get Gab Group

How to use it

Read one Gab group by its numeric id: title, description, member count, category, moderators and the group's own visibility settings. Groups are a Gab feature with no Mastodon equivalent, and a post made inside one carries the group under its group field. Pass the numeric id, or a /groups/{id} URL; ids come from that group field, from gab/groups/featured, or from a group URL.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• group string required — Numeric Gab group id, or a gab.com /groups/{id} URL (examples: "11", "https://gab.com/groups/11"; minLength: 1)

Response

• @type string (default: "GabGroup")
• id string required
• name string nullable
• alias string nullable
• url string nullable
• description string nullable
• description_html string nullable
• image string nullable
• category string nullable
• category_id string nullable
• member_count integer nullable
• created_at string nullable
• is_private boolean (default: false)
• is_verified boolean (default: false)
• is_archived boolean (default: false)
• is_paused boolean (default: false)
• is_moderated boolean (default: false)
• is_visible boolean (default: false)
• has_password boolean (default: false)
• is_quote_allowed boolean (default: false)
• is_members_visible boolean (default: false)
• is_media_visible boolean (default: false)
• is_links_visible boolean (default: false)
• is_admins_visible boolean (default: false)
• moderators array (default: [])
  • @type string (default: "GabGroupModerator")
  • account_id string nullable
  • role string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Group not found. Verify the numeric group id. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.