Organization memberships

List memberships

Returns memberships across all workspaces the caller belongs to, paginated at 25 results per page. Owners and admins see every member; regular members see only their own row.

get/organization_memberships

Request

  • Base URL
    https://www.happyscribe.com/api/v1
  • Auth
    API key in header Authorization

Query parameters

organization_idstring
Example:wks_01k6a2r9s8x7c2dvq3m5n6p4ab

Restrict the result to a single workspace. A wks_ id; integer workspace ids are still accepted.

role'owner' | 'admin' | 'member' | 'guest'

Filter by exact role.

emailstring

Case-insensitive partial match on the user's email.

namestring

Case-insensitive partial match on the user's full name.

pageinteger

Page number to retrieve.

Response

A paginated list of memberships.

Example response

{
  "members": [
    {
      "id": 9001,
      "organization_id": "wks_01k6a2r9s8x7c2dvq3m5n6p4ab",
      "organization_name": "Acme Corp",
      "email": "alice@acme.com",
      "name": "Alice Smith",
      "role": "admin",
      "created_at": "2024-02-01T10:00:00.000Z",
      "updated_at": "2024-05-12T11:30:00.000Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.