Skip to main content

Get organization members

GET 
/v2/orgs/:org_id/members

Retrieves organization members based on the organization ID and the cursor, or based on the user emails provided in the request.

Required scope

organizations:read

Rate limiting

Level 3

Enterprise only

This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using this form.

Request​

Path Parameters

    org_id stringrequired

    id of the organization

    Example: 3074457345821141000

Query Parameters

    emails string
    role string

    Possible values: [organization_internal_admin, organization_internal_user, organization_external_user, organization_team_guest_user, unknown]

    license string

    Possible values: [full, occasional, free, free_restricted, full_trial, unknown]

    active boolean
    cursor string
    limit int32

    Possible values: >= 1 and <= 100

    Default value: 100

Responses​

Organization members queries successfully

Schema

    oneOf

    limit int32

    Maximum number of results returned based on the limit specified in the request. For example, if there are 20 results, the request has no cursor value, and the limit is set to 20, the size of the results will be 20. The rest of the results will not be returned. To retrieve the rest of the results, you must make another request and set the appropriate value for the cursor parameter value.

    size int32

    Number of results returned in the response considering the cursor and the limit values sent in the request. For example, if there are 20 results, the request does not have a cursor value, and the limit set to 10, the size of the results will be 10.

    data

    object[]

  • Array [

    • id stringrequired

    Id of the user

    active booleanrequired

    Flag is user active

    email stringrequired

    User email

    lastActivityAt date-time

    Last time when the user was active

    license stringrequired

    Possible values: [full, occasional, free, free_restricted, full_trial, unknown]

    Name of the current user license in the organization

    licenseAssignedAt date-time

    Time when the license was assigned to the user

    role stringrequired

    Possible values: [organization_internal_admin, organization_internal_user, organization_external_user, organization_team_guest_user, unknown]

    Name of the user role in the organization

    type string

    Default value: organization-member

    Type of the object returned.

  • ]

    • cursor string

    Indicator of the position of the next page of the result. To retrieve the next page, make another query setting its cursor field to the value returned by the current query. If the value is empty, there are no more pages to fetch.

    type string

    Default value: cursor-list

    Type of the object returned.

Loading...