Search organization members using reusable filters

POST

http://localhost:8000/api/organizations/:id/memberships/search

POST

/api/organizations/:id/memberships/search

curl -X POST http://localhost:8000/api/organizations/1/memberships/search \
     -H "Authorization: Token  <api_key>" \
     -H "Content-Type: application/json" \
     -d '{}'

200Successful

{
  "concurrency": {},
  "contributed_to_projects": [
    {
      "id": 1,
      "title": "string"
    }
  ],
  "created_projects": [
    {
      "id": 1,
      "title": "string"
    }
  ],
  "flex": {},
  "id": 1,
  "organization": 1,
  "role": "OW",
  "role_source": "manual",
  "tags": [
    {
      "id": 1,
      "label": "string"
    }
  ],
  "user": {
    "avatar": "string",
    "id": 1,
    "initials": "?",
    "last_activity": "2024-01-15T09:30:00Z",
    "lse_fields": {
      "email_notification_settings": {},
      "invite_expired": true,
      "invite_expired_at": "2024-01-15T09:30:00Z",
      "invite_activated": true,
      "invited_at": "2024-01-15T09:30:00Z",
      "invited_by": 1,
      "onboarding_state": "not_started",
      "social_auth_finished": true,
      "trial_company": "string",
      "trial_experience_labeling": "string",
      "trial_license_enterprise": true,
      "trial_models_in_production": "string",
      "trial_role": "annotator"
    },
    "pause": {},
    "username": "string",
    "contributed_to_projects": [
      {
        "id": 1,
        "title": "string"
      }
    ],
    "created_projects": [
      {
        "id": 1,
        "title": "string"
      }
    ],
    "active_organization": 1,
    "allow_newsletters": true,
    "custom_hotkeys": null,
    "date_joined": "2024-01-15T09:30:00Z",
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "phone": "string"
  },
  "user_type": "string"
}

POST transport for the versioned organization-member filter payload.

Authentication

AuthorizationToken

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example:

curl https://label-studio-host/api/projects -H “Authorization: Token [your-token]”

Path parameters

idintegerRequired

Request

This endpoint expects an object.

filtersanyRequired

Response

concurrencymap from strings to any or nullRead-only

contributed_to_projectslist of objects or nullRead-only

created_projectslist of objects or nullRead-only

flexmap from strings to any or nullRead-only

Per-member Flex claim/window state for Members UI (FIT-2339).

idintegerRead-only

organizationinteger

Organization ID

roleenum

OW - Owner
AD - Administrator
MA - Manager
RE - Reviewer
AN - Annotator
DI - Deactivated
NO - Not Activated
VO - View Only

role_sourceenum or null

manual - Manual
saml - SAML
scim - SCIM
ldap - LDAP
api - API
billing - Billing

tagslist of objectsRead-only

userobject

A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to control which fields are displayed, and whether to replace simple values with complex, nested serializations

user_typestring or nullRead-only