Remote Partner Configuration API
The Partner Configuration API from Remote — 7 operation(s) for partner configuration.
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/remote-partner-configuration-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:
title: Remote Partner Configuration API
version: 0.1.0
servers:
- url: https://gateway.remote.com/
variables: {}
- url: https://gateway.remote-sandbox.com/
variables: {}
security:
- OAuth2: []
tags:
- name: Partner Configuration
paths:
/v1/companies/{company_id}/pricing-plans:
get:
callbacks: {}
deprecated: false
description: 'List all pricing plans for a company.
Currently the endpoint only returns the pricing plans for the EOR monthly product and the contractor products (Standard, Plus and COR).
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage companies (`company_management`) | View pricing plans (`pricing_plan:read`) | Manage pricing plans (`pricing_plan:write`) |
'
operationId: get_v1_companies_company_id_pricing-plans
parameters:
- description: Company ID
example: 123e4567-e89b-12d3-a456-426614174000
in: path
name: company_id
required: true
schema:
$ref: '#/components/schemas/UuidSlug'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListCompanyPricingPlansResponse'
description: Success
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityResponse'
description: Unprocessable Entity
security:
- OAuth2ClientCredentials:
- https://gateway.remote.com/company.manage
- pricing_plan:read
- pricing_plan:write
- company_management
- all:write
- all:read
- OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- pricing_plan:read
- pricing_plan:write
- company_management
- all:write
- all:read
summary: List pricing plans
tags:
- Partner Configuration
post:
callbacks: {}
deprecated: false
description: 'Create a pricing plan for a company, in order to do that we have 2 ways:
1. Create a pricing plan from a partner template
2. Create a pricing plan from a product price
The pricing plan is always created in the company''s desired currency.
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage companies (`company_management`) | - | Manage pricing plans (`pricing_plan:write`) |
'
operationId: post_v1_companies_company_id_pricing-plans
parameters:
- description: Company ID
example: 123e4567-e89b-12d3-a456-426614174000
in: path
name: company_id
required: true
schema:
$ref: '#/components/schemas/UuidSlug'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePricingPlanParams'
description: Create Pricing Plan parameters
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePricingPlanResponse'
description: Success
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityResponse'
description: Unprocessable Entity
security:
- OAuth2ClientCredentials:
- https://gateway.remote.com/company.manage
- pricing_plan:write
- company_management
- all:write
summary: Create a pricing plan for a company
tags:
- Partner Configuration
/v1/sso-configuration/details:
get:
callbacks: {}
deprecated: false
description: 'Shows the SSO Configuration details for the company.
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage company resources (`company_admin`) | - | Manage SSO (`sso_configuration:write`) |
'
operationId: get_v1_sso-configuration_details
parameters: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SSOConfigurationDetailsResponse'
description: Success
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
description: Not Found
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsResponse'
description: Unprocessable Entity
security:
- CustomerAPIToken:
- https://gateway.remote.com/company.manage
- sso_configuration:write
- company_admin
- all:write
OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- sso_configuration:write
- company_admin
- all:write
summary: Show the SSO Configuration Details
tags:
- Partner Configuration
/v1/pricing-plan-partner-templates:
get:
callbacks: {}
deprecated: false
description: 'List all pricing plan partner templates.
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage companies (`company_management`) | View pricing plans (`pricing_plan:read`) | Manage pricing plans (`pricing_plan:write`) |
'
operationId: get_v1_pricing-plan-partner-templates
parameters: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListPricingPlanPartnerTemplatesResponse'
description: Success
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityResponse'
description: Unprocessable Entity
security:
- OAuth2ClientCredentials:
- https://gateway.remote.com/company.manage
- pricing_plan:read
- pricing_plan:write
- company_management
- all:write
- all:read
summary: List pricing plan partner templates
tags:
- Partner Configuration
/v1/sso-configuration:
get:
callbacks: {}
deprecated: false
description: 'Shows the current SSO Configuration for the company.
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage company resources (`company_admin`) | View SSO configuration (`sso_configuration:read`) | Manage SSO (`sso_configuration:write`) |
'
operationId: get_v1_sso-configuration
parameters: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SSOConfigurationResponse'
description: Success
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
description: Not Found
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsResponse'
description: Unprocessable Entity
security:
- CustomerAPIToken:
- https://gateway.remote.com/company.manage
- sso_configuration:read
- sso_configuration:write
- company_admin
- all:write
- all:read
OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- sso_configuration:read
- sso_configuration:write
- company_admin
- all:write
- all:read
summary: Show the current SSO Configuration
tags:
- Partner Configuration
post:
callbacks: {}
deprecated: false
description: 'Creates the SSO Configuration for the company.
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage company resources (`company_admin`) | - | Manage SSO (`sso_configuration:write`) |
'
operationId: post_v1_sso-configuration
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSSOConfigurationParams'
description: CreateSSOConfiguration
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSSOConfigurationResponse'
description: Created
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
description: Not Found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictResponse'
description: Conflict
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityResponse'
description: Unprocessable Entity
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsResponse'
description: Unprocessable Entity
security:
- CustomerAPIToken:
- https://gateway.remote.com/company.manage
- sso_configuration:write
- company_admin
- all:write
OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- sso_configuration:write
- company_admin
- all:write
summary: Create the SSO Configuration
tags:
- Partner Configuration
/v1/magic-link:
post:
callbacks: {}
deprecated: false
description: 'Generates a magic link for a passwordless authentication.
To create a magic link for a company admin, you need to provide the `user_id` parameter.
To create a magic link for an employee, you need to provide the `employment_id` parameter.
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage company resources (`company_admin`) | - | Create magic links (`magic_link:write`) |
'
operationId: post_v1_magic-link
parameters:
- description: 'Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.
The refresh token needs to have been obtained through the Authorization Code flow.
'
example: Bearer <COMPANY-SCOPED ACCESS TOKEN>
in: header
name: Authorization
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MagicLinkParams'
description: Magic links generator body
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MagicLinkResponse'
description: Success
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityResponse'
description: Unprocessable Entity
security:
- OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- magic_link:write
- company_admin
- all:write
summary: Magic links generator
tags:
- Partner Configuration
/v1/companies/{company_id}/product-prices:
get:
callbacks: {}
deprecated: false
description: 'list product prices in the company''s desired currency.
the endpoint currently only returns the product prices for the EOR monthly product and the contractor products (Standard, Plus and COR).
the product prices are then used to create a pricing plan for the company.
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage companies (`company_management`) | View pricing plans (`pricing_plan:read`) | Manage pricing plans (`pricing_plan:write`) |
'
operationId: get_v1_companies_company_id_product-prices
parameters:
- description: Company ID
example: 123e4567-e89b-12d3-a456-426614174000
in: path
name: company_id
required: true
schema:
$ref: '#/components/schemas/UuidSlug'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListProductPricesResponse'
description: Success
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityResponse'
description: Unprocessable Entity
security:
- OAuth2ClientCredentials:
- https://gateway.remote.com/company.manage
- pricing_plan:read
- pricing_plan:write
- company_management
- all:write
- all:read
summary: Show product prices in the company's desired currency
tags:
- Partner Configuration
/v1/companies/{company_id}/create-token:
post:
callbacks: {}
deprecated: false
description: Creates new tokens for a given company
operationId: post_v1_companies_company_id_create-token
parameters:
- description: The ID of the company
example: ec5366b1-a1bc-434c-bdec-7604c5ba6af6
in: path
name: company_id
required: true
schema:
type: string
- description: The scope of the token
example: document:read timeoff:write
in: query
name: scope
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyTokenResponse'
description: Success
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityResponse'
description: Unprocessable Entity
security:
- OAuth2ClientCredentials: []
summary: Create a new token for a company
tags:
- Partner Configuration
webhooks:
sso_configuration.updated:
post:
deprecated: false
description: This event is triggered when the SSO Configuration is updated.
summary: sso_configuration.updated
tags:
- Partner Configuration
responses:
2XX:
description: Any 200 response confirms that the webhook was delivered.
security: []
operationId: sso_configuration.updated
requestBody:
content:
application/json:
schema:
required:
- event_type
- company_id
example:
company_id: d2091b1e-b1a4-437a-91ea-2809ffbb6d59
event_type: sso_configuration.updated
properties:
company_id:
type: string
description: The unique identifier of the related company.
event_type:
type: string
description: The webhook event type identifier.
company.pricing_plan.updated:
post:
deprecated: false
description: This event is triggered when a company pricing plan is updated.
summary: company.pricing_plan.updated
tags:
- Partner Configuration
responses:
2XX:
description: Any 200 response confirms that the webhook was delivered.
security: []
operationId: company.pricing_plan.updated
requestBody:
content:
application/json:
schema:
required:
- event_type
- company_id
- pricing_plan_id
example:
company_id: 2614f814-b08e-4c8e-8c4d-ddbcc4692d99
event_type: company.pricing_plan.updated
pricing_plan_id: 129d02bc-dd6a-11ed-ac99-cb057df06a33
properties:
company_id:
type: string
description: The unique identifier of the related company.
event_type:
type: string
description: The webhook event type identifier.
pricing_plan_id:
type: string
description: The unique identifier of the pricing plan.
sso_configuration.disabled:
post:
deprecated: false
description: This event is triggered when the SSO Configuration is disabled.
summary: sso_configuration.disabled
tags:
- Partner Configuration
responses:
2XX:
description: Any 200 response confirms that the webhook was delivered.
security: []
operationId: sso_configuration.disabled
requestBody:
content:
application/json:
schema:
required:
- event_type
- company_id
example:
company_id: d2091b1e-b1a4-437a-91ea-2809ffbb6d59
event_type: sso_configuration.disabled
properties:
company_id:
type: string
description: The unique identifier of the related company.
event_type:
type: string
description: The webhook event type identifier.
sso_configuration.enabled:
post:
deprecated: false
description: This event is triggered when the SSO Configuration is enabled.
summary: sso_configuration.enabled
tags:
- Partner Configuration
responses:
2XX:
description: Any 200 response confirms that the webhook was delivered.
security: []
operationId: sso_configuration.enabled
requestBody:
content:
application/json:
schema:
required:
- event_type
- company_id
example:
company_id: d2091b1e-b1a4-437a-91ea-2809ffbb6d59
event_type: sso_configuration.enabled
properties:
company_id:
type: string
description: The unique identifier of the related company.
event_type:
type: string
description: The webhook event type identifier.
components:
schemas:
PricingPlanPartnerTemplate:
additionalProperties: false
description: Pricing plan partner template
example:
base_price:
amount: 29900
currency:
code: CZK
name: Czech Koruna
symbol: Kč
id: 3b840951-099f-4bd5-90b9-032f7bfe51d9
price:
amount: 29900
currency:
code: CZK
name: Czech Koruna
symbol: Kč
product:
description: EOR Monthly
features:
- Feature 1
- Feature 2
frequency: monthly
name: EOR Monthly
short_name: EOR
tier: standard
properties:
base_price:
$ref: '#/components/schemas/Price'
id:
type: string
period:
description: The period in months for the template, 0 means unlimited
type: integer
price:
$ref: '#/components/schemas/Price'
product:
$ref: '#/components/schemas/Product'
unlimited:
description: Whether the template is unlimited in time (do not expire)
type: boolean
required:
- id
- product
- price
- base_price
title: PricingPlanPartnerTemplate
type: object
UnauthorizedResponse:
description: Returned when the request does not include valid authentication credentials. Ensure you are passing a valid OAuth2 access token or API token in the Authorization header.
example:
message: Unauthorized
properties:
message:
pattern: Unauthorized
type: string
required:
- message
title: UnauthorizedResponse
type: object
CompanyTokenResponse:
additionalProperties: false
description: OAuth2 tokens returned after a company authorizes access. Use the access token in the Authorization header for subsequent API calls. Use the refresh token to obtain a new access token when the current one expires.
example:
access_token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.cThIIoDvwdueQB468K5xDc5633seEFoqwxjF_xSJyQQ
expires_in: 3600
refresh_token: 16ab2c69-fd3c-4112-855d-2052baa10d20
properties:
access_token:
description: 'The OAuth2 access token (JWT). Include this in the `Authorization: Bearer <token>` header for API requests.'
type: string
expires_in:
description: The number of seconds until the access token expires.
type: integer
refresh_token:
description: The refresh token used to obtain a new access token when the current one expires.
type: string
required:
- access_token
- expires_in
- refresh_token
title: CompanyTokenResponse
type: object
CreatePricingPlanWithPartnerTemplateParams:
additionalProperties: false
description: Parameters for creating a pricing plan with a partner template
example:
pricing_plan_partner_template_id: 37e7f0ce-055c-46a1-b60f-1ac73a083699
start_date: '2025-01-01'
properties:
pricing_plan_partner_template_id:
description: The pricing plan partner template ID
format: uuid
type: string
start_date:
description: The start date of the pricing plan
format: date
type: string
required:
- pricing_plan_partner_template_id
title: CreatePricingPlanWithPartnerTemplateParams
type: object
ListCompanyPricingPlansResponse:
additionalProperties: false
description: Company pricing plans
example:
data:
pricing_plans:
- base_price:
amount: 29900
currency:
code: CZK
name: Czech Koruna
symbol: Kč
end_date: '2025-12-31'
id: 3b840951-099f-4bd5-90b9-032f7bfe51d9
price:
amount: 29900
currency:
code: CZK
name: Czech Koruna
symbol: Kč
product:
description: EOR Monthly
features:
- Feature 1
- Feature 2
frequency: monthly
name: EOR Monthly
short_name: EOR
tier: standard
start_date: '2025-01-01'
type: termed
properties:
data:
additionalProperties: false
properties:
pricing_plans:
items:
$ref: '#/components/schemas/PricingPlan'
type: array
required:
- pricing_plans
type: object
required:
- data
title: ListCompanyPricingPlansResponse
type: object
TooManyRequestsResponse:
description: Returned when the API rate limit has been exceeded (HTTP 429). Wait before retrying. Check the `Retry-After` response header for the recommended wait time.
example:
message: Too many requests
properties:
message:
pattern: Too many requests
type: string
title: TooManyRequestsResponse
type: object
NotFoundResponse:
description: Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
example:
message: '{resource} not found'
properties:
message:
description: A message indicating which resource was not found.
pattern: Not Found
type: string
title: NotFoundResponse
type: object
UnprocessableEntityResponse:
anyOf:
- properties:
errors:
type: object
required:
- errors
type: object
- properties:
message:
oneOf:
- type: string
- $ref: '#/components/schemas/ParameterError'
- items:
$ref: '#/components/schemas/ParameterError'
title: ParameterErrors
type: array
- $ref: '#/components/schemas/ActionError'
- items:
$ref: '#/components/schemas/ActionError'
title: ActionErrors
type: array
required:
- message
type: object
example:
errors:
some_field:
- is invalid
title: UnprocessableEntityResponse
type: object
SSOConfigurationDetails:
description: The SSO configuration details needed to set up your identity provider (IdP) to connect with Remote.
example:
audience_uri: urn:auth:remote-sso:89c4fbb2-some-id-8e4b-280f8795bbd8
sso_url: https://remote-sso.com/login/callback?connection=89c4fbb2-some-id-8e4b-280f8795bbd8
properties:
audience_uri:
description: The audience URI (Entity ID) for the SAML assertion. Configure this in your identity provider's SAML settings.
type: string
sso_url:
description: The SSO login callback URL. Configure this as the Assertion Consumer Service (ACS) URL in your identity provider.
type: string
required:
- sso_url
- audience_uri
title: SSOConfigurationDetails
type: object
CreateSSOConfigurationResponse:
example:
data:
audience_uri: urn:auth:remote-sso:89c4fbb2-some-id-8e4b-280f8795bbd8
certificate: c29tZSBjZXJ0aWZpY2F0ZSBleGFtcGxl...
domain: example.com
identity_provider_url: example.provider.com
sso_url: https://remote-sso.com/login/callback?connection=89c4fbb2-some-id-8e4b-280f8795bbd8
properties:
data:
$ref: '#/components/schemas/CreateSSOConfigurationResult'
required:
- data
title: CreateSSOConfigurationResponse
type: object
ProductPrice:
additionalProperties: false
example:
base_price:
amount: 29900
currency:
code: CZK
name: Czech Koruna
symbol: Kč
id: 123e4567-e89b-12d3-a456-426614174000
name: EOR Monthly Core
properties:
base_price:
$ref: '#/components/schemas/Price'
id:
description: The product price id
format: uuid
type: string
name:
description: The product price name
type: string
required:
- id
- name
- base_price
title: ProductPrice
type: object
ListPricingPlanPartnerTemplatesResponse:
additionalProperties: false
description: List of pricing plan partner templates
example:
data:
pricing_plan_partner_templates:
- base_price:
amount: 29900
currency:
code: CZK
name: Czech Koruna
symbol: Kč
id: 3b840951-099f-4bd5-90b9-032f7bfe51d9
price:
amount: 29900
currency:
code: CZK
name: Czech Koruna
symbol: Kč
product:
description: EOR Monthly
features:
- Feature 1
- Feature 2
frequency: monthly
name: EOR Monthly
short_name: EOR
tier: standard
properties:
data:
additionalProperties: false
properties:
pricing_plan_partner_templates:
items:
$ref: '#/components/schemas/PricingPlanPartnerTemplate'
type: array
required:
- pricing_plan_partner_templates
type: object
required:
- data
title: ListPricingPlanPartnerTemplatesResponse
type: object
UuidSlug:
description: Identifier of the employment being terminated.
example: 663e0b79-c893-45ff-a1b2-f6dcabc098b5
format: uuid
title: UuidSlug
type: string
SSOConfigurationDetailsResponse:
description: SSO Configuration Details response
example:
data:
audience_uri: urn:auth:remote-sso:89c4fbb2-some-id-8e4b-280f8795bbd8
sso_url: https://remote-sso.com/login/callback?connection=89c4fbb2-some-id-8e4b-280f8795bbd8
properties:
data:
$ref: '#/components/s
# --- truncated at 32 KB (61 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/remote/refs/heads/main/openapi/remote-partner-configuration-api-openapi.yml