Losant

Losant Instance Org Members API

The Instance Org Members API from Losant — 2 operation(s) for instance org members.

GitHub OpenAPI

Operations 5

GET /instances/{instanceId}/orgs/{orgId}/members Returns a collection of instance organization members #
POST /instances/{instanceId}/orgs/{orgId}/members Creates a new organization member #
GET /instances/{instanceId}/orgs/{orgId}/members/{userId} Returns an organization member #
PATCH /instances/{instanceId}/orgs/{orgId}/members/{userId} Modifies the role of an organization member #
DELETE /instances/{instanceId}/orgs/{orgId}/members/{userId} Deletes an organization member #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/losant/openapi/losant-instance-org-members-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/losant:losant-instance-org-members-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

losant-instance-org-members-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Platform Instance Org Members API
  version: 1.31.0
  description: User API for accessing platform data
servers:
- url: https://api.losant.com
security:
- bearerAuth: []
tags:
- name: Instance Org Members
paths:
  /instances/{instanceId}/orgs/{orgId}/members:
    get:
      operationId: instanceOrgMembers.get
      summary: Returns a collection of instance organization members
      tags:
      - Instance Org Members
      parameters:
      - name: instanceId
        in: path
        required: true
        description: ID associated with the instance
        schema:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        example: 575ec8687ae143cd83dc4a97
      - name: orgId
        in: path
        required: true
        description: ID associated with the organization
        schema:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        example: 575ec8687ae143cd83dc4a97
      - name: sortField
        in: query
        required: false
        description: Field to sort the results by
        schema:
          type: string
          enum:
          - email
          - role
          default: email
        example: role
      - name: sortDirection
        in: query
        required: false
        description: Direction to sort the results by
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
        example: asc
      - name: filterField
        in: query
        required: false
        description: Field to filter the results by. Blank or not provided means no filtering.
        schema:
          type: string
          enum:
          - email
          - role
        example: email
      - name: filter
        in: query
        required: false
        description: Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
        schema:
          type: string
        example: my * instance
      responses:
        '200':
          description: A collection of instance organization members
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/instanceOrgMembers'
        '400':
          description: Error if malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: Error if instance was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      x-losant-auth-scopes:
      - instanceOrgMembers.get
    post:
      operationId: instanceOrgMembers.post
      summary: Creates a new organization member
      tags:
      - Instance Org Members
      parameters:
      - name: instanceId
        in: path
        required: true
        description: ID associated with the instance
        schema:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        example: 575ec8687ae143cd83dc4a97
      - name: orgId
        in: path
        required: true
        description: ID associated with the organization
        schema:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        example: 575ec8687ae143cd83dc4a97
      responses:
        '201':
          description: The newly added instance org member
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/instanceOrgMember'
        '202':
          description: An invite was sent to the new member's email address
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/instanceOrgInviteSent'
        '400':
          description: Error if malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: Error if instance was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/instanceOrgMemberPost'
        description: Object containing new member info
      x-losant-auth-scopes:
      - instanceOrgMembers.post
  /instances/{instanceId}/orgs/{orgId}/members/{userId}:
    get:
      operationId: instanceOrgMember.get
      summary: Returns an organization member
      tags:
      - Instance Org Members
      parameters:
      - name: instanceId
        in: path
        required: true
        description: ID associated with the instance
        schema:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        example: 575ec8687ae143cd83dc4a95
      - name: orgId
        in: path
        required: true
        description: ID associated with the organization
        schema:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        example: 575ec8687ae143cd83dc4a97
      - name: userId
        in: path
        required: true
        description: ID associated with the organization member
        schema:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        example: 575ec8687ae143cd83dc4a94
      responses:
        '200':
          description: A single organization member
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/instanceOrgMember'
        '400':
          description: Error if malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: Error if instance, organization, or member was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      x-losant-auth-scopes:
      - instanceOrgMember.get
    patch:
      operationId: instanceOrgMember.patch
      summary: Modifies the role of an organization member
      tags:
      - Instance Org Members
      parameters:
      - name: instanceId
        in: path
        required: true
        description: ID associated with the instance
        schema:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        example: 575ec8687ae143cd83dc4a95
      - name: orgId
        in: path
        required: true
        description: ID associated with the organization
        schema:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        example: 575ec8687ae143cd83dc4a97
      - name: userId
        in: path
        required: true
        description: ID associated with the organization member
        schema:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        example: 575ec8687ae143cd83dc4a94
      responses:
        '200':
          description: The modified organization member
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/instanceOrgMember'
        '400':
          description: Error if malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: Error if organization or member was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/instanceOrgMemberPatch'
        description: Object containing new member info
      x-losant-auth-scopes:
      - instanceOrgMember.patch
    delete:
      operationId: instanceOrgMember.delete
      summary: Deletes an organization member
      tags:
      - Instance Org Members
      parameters:
      - name: instanceId
        in: path
        required: true
        description: ID associated with the instance
        schema:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        example: 575ec8687ae143cd83dc4a95
      - name: orgId
        in: path
        required: true
        description: ID associated with the organization
        schema:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        example: 575ec8687ae143cd83dc4a97
      - name: userId
        in: path
        required: true
        description: ID associated with the organization member
        schema:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        example: 575ec8687ae143cd83dc4a94
      responses:
        '200':
          description: If member was successfully deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/success'
        '400':
          description: Error if malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: Error if organization or member was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      x-losant-auth-scopes:
      - instanceOrgMember.delete
components:
  schemas:
    error:
      title: Error
      description: Schema for errors returned by the API
      type: object
      properties:
        type:
          type: string
        message:
          type: string
        validationErrors:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              validationMessage:
                type: string
    success:
      title: Success
      description: Schema for reporting a successful operation
      type: object
      properties:
        success:
          type: boolean
          enum:
          - true
    instanceOrgMemberPost:
      title: Instance Org Member Post
      description: Schema for an Instance Organization member creation request
      oneOf:
      - type: object
        properties:
          userId:
            type: string
            pattern: ^[A-Fa-f\d]{24}$
          role:
            type: string
            enum:
            - admin
            - edit
            - collaborate
            - view
            - none
          applicationRoles:
            type: array
            items:
              type: object
              properties:
                resourceId:
                  type: string
                  pattern: ^[A-Fa-f\d]{24}$
                role:
                  type: string
                  enum:
                  - collaborate
                  - view
                  - none
              required:
              - resourceId
              - role
              additionalProperties: false
            maxItems: 100
          dashboardRoles:
            type: array
            items:
              type: object
              properties:
                resourceId:
                  type: string
                  pattern: ^[A-Fa-f\d]{24}$
                role:
                  type: string
                  enum:
                  - collaborate
                  - view
                  - none
              required:
              - resourceId
              - role
              additionalProperties: false
            maxItems: 100
        additionalProperties: false
        required:
        - userId
        - role
      - type: object
        properties:
          email:
            type: string
            format: email
            maxLength: 1024
          role:
            type: string
            enum:
            - admin
            - edit
            - collaborate
            - view
            - none
          applicationRoles:
            type: array
            items:
              type: object
              properties:
                resourceId:
                  type: string
                  pattern: ^[A-Fa-f\d]{24}$
                role:
                  type: string
                  enum:
                  - collaborate
                  - view
                  - none
              required:
              - resourceId
              - role
              additionalProperties: false
            maxItems: 100
          dashboardRoles:
            type: array
            items:
              type: object
              properties:
                resourceId:
                  type: string
                  pattern: ^[A-Fa-f\d]{24}$
                role:
                  type: string
                  enum:
                  - collaborate
                  - view
                  - none
              required:
              - resourceId
              - role
              additionalProperties: false
            maxItems: 100
          disallowTransfer:
            type: boolean
        additionalProperties: false
        required:
        - email
        - role
    instanceOrgInviteSent:
      title: Instance Organization Invite Sent
      description: Schema returned when adding a new instance organization member resulted in an invite being sent
      type: object
      properties:
        inviteSent:
          type: boolean
          enum:
          - true
    instanceOrgMembers:
      title: Instance Organization Members
      description: Schema for a collection of Organization members within an instance
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/instanceOrgMember'
        instanceId:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        orgId:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        count:
          type: integer
        filter:
          type: string
        filterField:
          type: string
        sortField:
          type: string
        sortDirection:
          type: string
          enum:
          - asc
          - desc
          - ASC
          - DESC
          - ''
    instanceOrgMember:
      title: Instance Org Member
      description: Schema for an Instance Organization member
      type: object
      properties:
        instanceId:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        orgId:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        userId:
          type: string
          pattern: ^[A-Fa-f\d]{24}$
        email:
          type: string
          format: email
          maxLength: 1024
        firstName:
          type: string
          minLength: 1
          maxLength: 1024
        lastName:
          type: string
          maxLength: 1024
        role:
          type: string
          enum:
          - admin
          - edit
          - collaborate
          - view
          - none
        applicationRoles:
          type: array
          items:
            type: object
            properties:
              resourceId:
                type: string
                pattern: ^[A-Fa-f\d]{24}$
              role:
                type: string
                enum:
                - collaborate
                - view
                - none
            required:
            - resourceId
            - role
            additionalProperties: false
          maxItems: 100
        dashboardRoles:
          type: array
          items:
            type: object
            properties:
              resourceId:
                type: string
                pattern: ^[A-Fa-f\d]{24}$
              role:
                type: string
                enum:
                - collaborate
                - view
                - none
            required:
            - resourceId
            - role
            additionalProperties: false
          maxItems: 100
        avatarUrl:
          type: string
          format: uri
          maxLength: 1024
        twoFactorAuthEnabled:
          type: boolean
        ssoLinked:
          type: boolean
      additionalProperties: false
    instanceOrgMemberPatch:
      title: Instance Org Member Patch
      description: Schema for an Instance Organization member modification request
      type: object
      properties:
        role:
          type: string
          enum:
          - admin
          - edit
          - collaborate
          - view
          - none
        applicationRoles:
          type: array
          items:
            type: object
            properties:
              resourceId:
                type: string
                pattern: ^[A-Fa-f\d]{24}$
              role:
                type: string
                enum:
                - collaborate
                - view
                - none
            required:
            - resourceId
            - role
            additionalProperties: false
          maxItems: 100
        dashboardRoles:
          type: array
          items:
            type: object
            properties:
              resourceId:
                type: string
                pattern: ^[A-Fa-f\d]{24}$
              role:
                type: string
                enum:
                - collaborate
                - view
                - none
            required:
            - resourceId
            - role
            additionalProperties: false
          maxItems: 100
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
x-derived-from:
  format: bravado 1.0
  by: all/0-working/bravado-to-openapi.py (roadmap#799)
  note: 'every action keeps its own path: resource.path + action.path'