The Users API from Bindbee — 2 operation(s) for users.
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/bindbee:bindbee-users-api"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.
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: 3.2.0
info:
title: Bindbee Users API
version: 0.1.0
tags:
- name: Users
paths:
/api/lms/v1/users:
get:
tags:
- Users
summary: Get Lms Users
description: Returns a list of LMS User objects.
operationId: get_lms_users_api_lms_v1_users_get
security:
- HTTPBearer: []
parameters:
- name: ids
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: If provided, will only return users for these IDs.
examples:
- 018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7
title: Ids
description: If provided, will only return users for these IDs.
- name: remote_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: The third-party API ID of the matching object.
title: Remote Id
description: The third-party API ID of the matching object.
- name: email_address
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: If provided, will only return users for this email address.
examples:
- john@doe.com
title: Email Address
description: If provided, will only return users for this email address.
- name: status
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: If provided, will only return enrollments for this status. Along with the standard values, any connector specific value returned in the response can be passed as well.
examples:
- ACTIVE
- PENDING
- INACTIVE
title: Status
description: If provided, will only return enrollments for this status. Along with the standard values, any connector specific value returned in the response can be passed as well.
- name: include_raw_data
in: query
required: false
schema:
type: boolean
description: Whether to include the original data Bindbee fetched from the third-party to produce these models.
examples:
- false
default: false
title: Include Raw Data
description: Whether to include the original data Bindbee fetched from the third-party to produce these models.
- name: include_custom_fields
in: query
required: false
schema:
type: boolean
description: Whether to include custom fields in the response.
examples:
- false
default: false
title: Include Custom Fields
description: Whether to include custom fields in the response.
- name: page_size
in: query
required: false
schema:
type: integer
maximum: 200
minimum: 1
description: Number of results to return per page. Maximum size is 200.
default: 50
title: Page Size
description: Number of results to return per page. Maximum size is 200.
- name: cursor
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: The pagination cursor value.
title: Cursor
description: The pagination cursor value.
- name: x-connector-token
in: header
required: true
schema:
type: string
title: X-Connector-Token
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedResponse_LmsUser_'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
'401':
description: Missing or invalid bearer authentication credentials.
headers:
WWW-Authenticate:
description: Bearer authentication challenge.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: Rate limit exceeded.
headers:
X-RateLimit-Limit:
description: Maximum requests allowed in the current window.
schema:
type: integer
X-RateLimit-Remaining:
description: Requests remaining in the current window.
schema:
type: integer
X-RateLimit-Reset:
description: Unix timestamp (seconds since epoch) at which the current rate-limit window resets.
schema:
type: integer
Retry-After:
description: Seconds to wait before retrying the request.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/lms/v1/users/{id}:
get:
tags:
- Users
summary: Get Lms User By Id
description: Returns an LMS User object with the given id.
operationId: get_lms_user_by_id_api_lms_v1_users__id__get
security:
- HTTPBearer: []
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
title: Id
- name: include_raw_data
in: query
required: false
schema:
type: boolean
description: Whether to include the original data Bindbee fetched from the third-party to produce these models.
examples:
- false
default: false
title: Include Raw Data
description: Whether to include the original data Bindbee fetched from the third-party to produce these models.
- name: include_custom_fields
in: query
required: false
schema:
type: boolean
description: Whether to include custom fields in the response.
examples:
- false
default: false
title: Include Custom Fields
description: Whether to include custom fields in the response.
- name: x-connector-token
in: header
required: true
schema:
type: string
title: X-Connector-Token
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LmsUser'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
'401':
description: Missing or invalid bearer authentication credentials.
headers:
WWW-Authenticate:
description: Bearer authentication challenge.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: Rate limit exceeded.
headers:
X-RateLimit-Limit:
description: Maximum requests allowed in the current window.
schema:
type: integer
X-RateLimit-Remaining:
description: Requests remaining in the current window.
schema:
type: integer
X-RateLimit-Reset:
description: Unix timestamp (seconds since epoch) at which the current rate-limit window resets.
schema:
type: integer
Retry-After:
description: Seconds to wait before retrying the request.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: The requested resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ErrorResponse:
type: object
required:
- detail
properties:
detail:
type: string
PaginatedResponse_LmsUser_:
properties:
cursor:
anyOf:
- type: string
- type: 'null'
title: Cursor
description: Cursor value to fetch next set of items
examples:
- MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1
page_size:
type: integer
title: Page Size
description: Indicates the count of items in the response
examples:
- 50
items:
items:
$ref: '#/components/schemas/LmsUser'
type: array
title: Items
description: List of items in the current response
type: object
required:
- cursor
- page_size
- items
title: PaginatedResponse[LmsUser]
LmsUser:
properties:
id:
type: string
format: uuid
title: Id
examples:
- 018b18ef-c487-703c-afd9-0ca478ccd9d6
remote_id:
anyOf:
- type: string
- type: 'null'
title: Remote Id
description: The third-party API ID of the matching object.
examples:
- '123321'
modified_at:
type: string
format: date-time
title: Modified At
description: This is the datetime that this object was last updated by Bindbee
examples:
- '2021-10-16T00:00:00Z'
raw_data:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Raw Data
description: This is the Raw data
examples:
- key_1: Platform dependent data 1
key_2: Platform dependent data 2
custom_fields:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Custom Fields
description: The custom fields related to the model
examples:
- category_group: REG
disability_type: ASBERG
hire_date: '1991-03-16T00:00:00'
hire_source: REFER
nationality: USA
original_hire_date: '1991-03-16T00:00:00'
first_name:
anyOf:
- type: string
- type: 'null'
title: First Name
description: The first name of the user
examples:
- Jane
last_name:
anyOf:
- type: string
- type: 'null'
title: Last Name
description: The last name of the user
examples:
- Doe
middle_name:
anyOf:
- type: string
- type: 'null'
title: Middle Name
description: The middle name of the user
examples:
- A.
email_address:
anyOf:
- type: string
- type: 'null'
title: Email Address
description: The email address of the user
examples:
- jane.doe@example.com
phone_number:
anyOf:
- type: string
- type: 'null'
title: Phone Number
description: The phone number of the user
examples:
- +1 415 555 1212
status:
anyOf:
- type: string
- type: 'null'
enum:
- ACTIVE
- PENDING
- INACTIVE
title: Status
description: The status of the user. If the value is not one of the defined enum values, the original value passed through will be returned.
examples:
- ACTIVE
type: object
required:
- id
- remote_id
- modified_at
- custom_fields
title: LmsUser
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
x-provenance:
method: harvested
publisher: Bindbee
source: https://api.bindbee.dev/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)