SkySlope Users API
The Users API from SkySlope — 4 operation(s) for users.
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/skyslope-users-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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:
x-logo:
url: https://s3.amazonaws.com/cdn.skyslope.com/forms/forms-logo-w-top-padding.png
href: https://skyslope.com/
altText: SkySlope
title: SkySlope Partnership API Reference Users API
version: 1.0.0
description: '# Introduction
The SkySlope Forms API is organized around REST.'
termsOfService: https://skyslope.com/terms-conditions/
contact:
name: Support
url: https://support.skyslope.com/hc/en-us
email: support@skyslope.com
servers:
- url: https://forms.skyslope.com/partner/api
description: Production server
- url: https://staging-forms.skyslope.com/partner/api
description: Staging server
- url: https://integ-forms.skyslope.com/partner/api
description: Integration server
tags:
- name: Users
paths:
/users/profile:
get:
summary: Get User Profile
tags:
- Users
description: Retrieve the user profile of the currently authenticated user
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The id of the user who belongs to the profile.
subscriberId:
type: string
description: The subscriber id of the user.
firstName:
type: string
description: The first name of the user.
middleName:
type: string
description: The middle name of the user.
lastName:
type: string
description: The last name of the user.
suffix:
type: string
description: The suffix of the user.
email:
type: string
description: The email of the user.
primaryPhoneNumber:
type: string
description: The primary phone number of the user.
brokerageName:
type: string
description: The name of the brokerage that the user belongs to.
brokerageAddress:
type: object
description: The address of the brokerage that the user belongs to.
properties:
streetAddress:
type: string
description: The street address of the brokerage.
unitNumber:
type: string
description: The unit number of the brokerage.
city:
type: string
description: The city of the brokerage.
state:
type: string
description: The state of the brokerage.
postalCode:
type: string
description: The postal code of the brokerage.
county:
type: string
description: The county of the brokerage.
brokeragePhone:
type: string
description: The phone number of the brokerage that the user belongs to.
brokerageFax:
type: string
description: The fax number of the brokerage that the user belongs to.
regions:
type: array
description: An array of regions that the user has access to.
items:
type: object
properties:
country:
type: string
region:
type: string
libraries:
type: array
description: An array of libraries that the user has access to.
items:
type: number
authProfiles:
type: array
description: An array of the auth profiles of the user.
items:
additionalFields: true
isInitialized:
type: boolean
description: Evaluates to true if the user profile has been on-boarded.
termAcceptanceDate:
type: string
description: The date and time the user accepted the terms.
mlsCode:
type: string
description: The mls code of the user.
licenseNumber:
type: string
description: The license number of the user.
brokerageLicenseNumber:
type: string
description: The license number of the brokerage that the user belongs to.
brokerageMLSCode:
type: string
description: The mls code of the brokerage that the user belongs to.
isAutoDeletePreDraftEnvelopeAllowed:
type: boolean
description: Evaluates to true if auto delete pre draft envelopes is enabled.
isAutoDeleteFormAllowed:
type: boolean
description: Evaluates to true if auto delete forms is enabled.
consentedAssociations:
type: array
description: An array of the consented associations for the user.
items:
type: string
userPreferences:
type: object
properties:
digitalSigningPlatformPreference:
type: string
description: The digital signing platform preference of the user.
nhdProviderPreference:
type: string
description: The nhd provider preference of the user.
location:
type: string
description: The location of the user.
createdOn:
type: string
description: The date and time the user profile was created.
createdBy:
type: string
description: The id of the user who created the user profile.
updatedOn:
type: string
description: The date and time the user profile was last updated.
updatedBy:
type: string
description: The id of the user who last updated the user profile.
default:
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
operationId: getUsersProfile
x-operation-id-source: derived
/group:
post:
summary: Add Group
tags:
- Users
description: 'Create a new group via accounts-api.
REQUIRED SCOPES:
admin.groups'
requestBody:
content:
application/json:
schema:
type: object
properties:
brokerageId:
type: string
description: The brokerage id for the new group. If not provided, will be auto-generated with prefix "partnerApi_".
brokerageName:
type: string
description: The name of the brokerage.
responses:
'200':
description: Group already exists.
content:
application/json:
schema:
type: object
properties:
groupId:
type: string
description: The id of the newly created group.
required:
- groupId
'201':
description: Group successfully created.
content:
application/json:
schema:
type: object
properties:
groupId:
type: string
description: The id of the newly created group.
required:
- groupId
'400':
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
'401':
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
'500':
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
default:
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
operationId: postGroup
x-operation-id-source: derived
/groups/{groupId}/child:
post:
summary: Add Child Group
tags:
- Users
description: 'Create a new child group for a parent group via accounts-api.
REQUIRED SCOPES:
admin.groups'
requestBody:
content:
application/json:
schema:
type: object
required:
- name
properties:
name:
type: string
minLength: 1
description: The name of the child group.
required: true
parameters:
- schema:
type: string
minLength: 1
in: path
name: groupId
required: true
description: The id of the parent group.
responses:
'200':
description: Child group already exists for the parent group.
content:
application/json:
schema:
type: object
properties:
childGroupId:
type: string
description: The id of the newly created child group.
required:
- childGroupId
'201':
description: Child group successfully created.
content:
application/json:
schema:
type: object
properties:
childGroupId:
type: string
description: The id of the newly created child group.
required:
- childGroupId
'400':
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
'401':
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
'500':
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
default:
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
operationId: postGroupsByGroupIdChild
x-operation-id-source: derived
/users/{userId}/groups/{groupId}:
post:
summary: Add Group to User
tags:
- Users
description: 'Add group to a user.
REQUIRED SCOPES:
admin.groups'
parameters:
- schema:
type: string
minLength: 1
in: path
name: userId
required: true
description: The id of the user to add to the group.
- schema:
type: string
minLength: 1
in: path
name: groupId
required: true
description: The id of the group to add the user to.
responses:
'204':
description: Group successfully added to user.
default:
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
operationId: postUsersByUserIdGroupsByGroupId
x-operation-id-source: derived
delete:
summary: Remove User from Group
tags:
- Users
description: 'Remove a user from a group.
REQUIRED SCOPES:
admin.groups'
parameters:
- schema:
type: string
minLength: 1
in: path
name: userId
required: true
description: The id of the user to remove from the group.
- schema:
type: string
minLength: 1
in: path
name: groupId
required: true
description: The id of the group to remove the user from.
responses:
'204':
description: User successfully removed from group.
default:
description: An object containing the error that occurred.
content:
application/json:
schema:
type: object
description: An object containing the error that occurred.
properties:
code:
type: string
description: A code that represents the error that occurred.
message:
type: string
description: A description of the error that occurred.
errors:
type: array
description: An array of the errors that occurred.
items:
type: string
traceId:
type: string
description: A request correlation ID.
operationId: deleteUsersByUserIdGroupsByGroupId
x-operation-id-source: derived