Losant Instance Members API
The Instance Members API from Losant — 2 operation(s) for instance members.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/losant:losant-instance-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Platform Instance Members API
version: 1.31.0
description: User API for accessing platform data
servers:
- url: https://api.losant.com
security:
- bearerAuth: []
tags:
- name: Instance Members
paths:
/instances/{instanceId}/members:
get:
operationId: instanceMembers.get
summary: Returns a collection of instance members
tags:
- Instance 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: 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 members
content:
application/json:
schema:
$ref: '#/components/schemas/instanceMembers'
'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:
- instanceMembers.get
post:
operationId: instanceMembers.post
summary: Creates a new instance member
tags:
- Instance 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
responses:
'200':
description: The newly created instance member
content:
application/json:
schema:
$ref: '#/components/schemas/instanceMember'
'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/instanceMemberPost'
description: Object containing new member info
x-losant-auth-scopes:
- instanceMembers.post
/instances/{instanceId}/members/{userId}:
get:
operationId: instanceMember.get
summary: Returns an instance member
tags:
- Instance 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: userId
in: path
required: true
description: ID associated with the instance member
schema:
type: string
pattern: ^[A-Fa-f\d]{24}$
example: 575ec8687ae143cd83dc4a94
responses:
'200':
description: A single instance member
content:
application/json:
schema:
$ref: '#/components/schemas/instanceMember'
'400':
description: Error if malformed request
content:
application/json:
schema:
$ref: '#/components/schemas/error'
'404':
description: Error if instance or member was not found
content:
application/json:
schema:
$ref: '#/components/schemas/error'
x-losant-auth-scopes:
- instanceMember.get
patch:
operationId: instanceMember.patch
summary: Modifies the role of an instance member
tags:
- Instance 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: userId
in: path
required: true
description: ID associated with the instance member
schema:
type: string
pattern: ^[A-Fa-f\d]{24}$
example: 575ec8687ae143cd83dc4a94
responses:
'200':
description: The modified instance member
content:
application/json:
schema:
$ref: '#/components/schemas/instanceMember'
'400':
description: Error if malformed request
content:
application/json:
schema:
$ref: '#/components/schemas/error'
'404':
description: Error if instance or member was not found
content:
application/json:
schema:
$ref: '#/components/schemas/error'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/instanceMemberPatch'
description: Object containing new member info
x-losant-auth-scopes:
- instanceMember.patch
delete:
operationId: instanceMember.delete
summary: Deletes an instance member
tags:
- Instance 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: userId
in: path
required: true
description: ID associated with the instance 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 instance or member was not found
content:
application/json:
schema:
$ref: '#/components/schemas/error'
x-losant-auth-scopes:
- instanceMember.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
instanceMembers:
title: Instance Members
description: Schema for a collection of Instance members
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/instanceMember'
instanceId:
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
- ''
instanceMemberPatch:
title: Instance Member Patch
description: Schema for an Instance member modification request
type: object
properties:
role:
type: string
enum:
- admin
- view
additionalProperties: false
required:
- role
instanceMemberPost:
title: Instance Member Post
description: Schema for an Instance member creation request
type: object
properties:
userId:
type: string
pattern: ^[A-Fa-f\d]{24}$
email:
type: string
format: email
maxLength: 1024
role:
type: string
enum:
- admin
- view
additionalProperties: false
anyOf:
- required:
- email
- role
- required:
- userId
- role
instanceMember:
title: Instance Member
description: Schema for an Instance member
type: object
properties:
instanceId:
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
- view
avatarUrl:
type: string
format: uri
maxLength: 1024
twoFactorAuthEnabled:
type: boolean
ssoLinked:
type: boolean
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'