WorkOS · Schema

UserlandUserOrganizationMembershipBaseList

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name Type Description
object string Indicates this is a list response.
data array The list of records for the current page.
list_metadata object Pagination cursors for navigating between pages of results.
View JSON Schema on GitHub

JSON Schema

workos-userlanduserorganizationmembershipbaselist-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserlandUserOrganizationMembershipBaseList",
  "title": "UserlandUserOrganizationMembershipBaseList",
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "description": "Indicates this is a list response.",
      "const": "list"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "description": "Distinguishes the organization membership object.",
            "const": "organization_membership"
          },
          "id": {
            "type": "string",
            "description": "The unique ID of the organization membership.",
            "example": "om_01HXYZ123456789ABCDEFGHIJ"
          },
          "user_id": {
            "type": "string",
            "description": "The ID of the user.",
            "example": "user_01E4ZCR3C56J083X43JQXF3JK5"
          },
          "organization_id": {
            "type": "string",
            "description": "The ID of the organization which the user belongs to.",
            "example": "org_01EHZNVPK3SFK441A1RGBFSHRT"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "inactive",
              "pending"
            ],
            "description": "The status of the organization membership. One of `active`, `inactive`, or `pending`.",
            "example": "active"
          },
          "directory_managed": {
            "type": "boolean",
            "description": "Whether this organization membership is managed by a directory sync connection.",
            "example": false
          },
          "organization_name": {
            "type": "string",
            "description": "The name of the organization which the user belongs to.",
            "example": "Acme Corp"
          },
          "custom_attributes": {
            "type": "object",
            "additionalProperties": {},
            "description": "An object containing IdP-sourced attributes from the linked [Directory User](/reference/directory-sync/directory-user) or [SSO Profile](/reference/sso/profile). Directory User attributes take precedence when both are linked.",
            "example": {
              "department": "Engineering",
              "title": "Developer Experience Engineer",
              "location": "Brooklyn"
            }
          },
          "created_at": {
            "format": "date-time",
            "type": "string",
            "description": "An ISO 8601 timestamp.",
            "example": "2026-01-15T12:00:00.000Z"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string",
            "description": "An ISO 8601 timestamp.",
            "example": "2026-01-15T12:00:00.000Z"
          }
        },
        "required": [
          "object",
          "id",
          "user_id",
          "organization_id",
          "status",
          "directory_managed",
          "created_at",
          "updated_at"
        ]
      },
      "description": "The list of records for the current page."
    },
    "list_metadata": {
      "type": "object",
      "properties": {
        "before": {
          "type": [
            "string",
            "null"
          ],
          "description": "An object ID that defines your place in the list. When the ID is not present, you are at the start of the list.",
          "example": "om_01HXYZ123456789ABCDEFGHIJ"
        },
        "after": {
          "type": [
            "string",
            "null"
          ],
          "description": "An object ID that defines your place in the list. When the ID is not present, you are at the end of the list.",
          "example": "om_01HXYZ987654321KJIHGFEDCBA"
        }
      },
      "required": [
        "before",
        "after"
      ],
      "description": "Pagination cursors for navigating between pages of results."
    }
  },
  "required": [
    "object",
    "data",
    "list_metadata"
  ]
}