Remote Partner Configuration API is one of 14 APIs that Remote publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Partner Configuration. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
9 operations
across 7 paths,
and defines 32 schemas.
It is described by OpenAPI 3.2.0, at version 0.1.0.
Requests are made against 2 base URLs: https://gateway.remote.com/, https://gateway.remote-sandbox.com/.
9 operations7 paths32 schemas5 GET4 POST
Metadata
The identity and technical contract details declared by the specification.
Remote Partner Configuration API declares
7 security schemes
for authenticating requests.
It accepts HTTP basic authentication (BasicAuth).
It accepts HTTP bearer tokens (ClientToken).
It accepts HTTP bearer tokens (CustomerAPIToken).
It supports OAuth 2.0 (OAuth2) using the authorizationCode and clientCredentials flows, exposing 77 scopes.
It supports OAuth 2.0 (OAuth2Assertion) using the clientCredentials flow, exposing 21 scopes.
It supports OAuth 2.0 (OAuth2AuthorizationCode) using the authorizationCode flow, exposing 73 scopes.
It supports OAuth 2.0 (OAuth2ClientCredentials) using the clientCredentials flow, exposing 18 scopes.
By default, every request must be authenticated.
BasicAuth — Authenticate using the basic authentication for partners. Use the CLIENTID as login and CLIENTSECRET as password.
ClientToken — Authenticate a partner using only the the provided clienttoken. This authentication method only allows accessing marketing endpoints.
CustomerAPIToken — Authenticate using API Key generated by the customer in their Integration Settings page.
OAuth2 — Authenticate using OAuth 2.0 protocol.
OAuth2Assertion — Authenticate as the employee using the urn:ietf:params:oauth:grant-type:jwt-bearer grant in the OAuth2 protocol.
OAuth2AuthorizationCode — Authenticate as the token authorizer using authorizationcode / refreshtoken grants in the OAuth 2.0 protocol.
OAuth2ClientCredentials — Authenticate using clientcredentials grant in the OAuth 2.0 protocol.
Paths & Operations 9
Across 7 paths, the API surfaces 9 operations — 5 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are PricingPlan (7 properties), Product (7 properties), PricingPlanPartnerTemplate (6 properties), CreateSSOConfigurationResult (5 properties). Each schema is shown below with its type and property counts.
PricingPlanPartnerTemplate
object
Pricing plan partner template
6 properties4 required
UnauthorizedResponse
object
Returned when the request does not include valid authentication credentials. Ensure you are passing a valid OAuth2 access token or API token in the Authorizati…
1 property1 required
CompanyTokenResponse
object
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 o…
3 properties3 required
CreatePricingPlanWithPartnerTemplateParams
object
Parameters for creating a pricing plan with a partner template
2 properties1 required
ListCompanyPricingPlansResponse
object
Company pricing plans
1 property1 required
TooManyRequestsResponse
object
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.
1 property
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
UnprocessableEntityResponse
object
SSOConfigurationDetails
object
The SSO configuration details needed to set up your identity provider (IdP) to connect with Remote.
2 properties2 required
CreateSSOConfigurationResponse
object
1 property1 required
ProductPrice
object
3 properties3 required
ListPricingPlanPartnerTemplatesResponse
object
List of pricing plan partner templates
1 property1 required
UuidSlug
string
Identifier of the employment being terminated.
SSOConfigurationDetailsResponse
object
SSO Configuration Details response
1 property
MagicLinkResponse
object
1 property1 required
ActionError
object
3 properties3 required
Price
object
A monetary amount with its currency, used for pricing plan costs.
2 properties2 required
CreatePricingPlanResponse
object
Response for creating a pricing plan
1 property1 required
PricingPlan
object
A pricing plan assigned to a company, defining the product, billing frequency, and cost.
7 properties7 required
MagicLinkParams
object
Magic link params
ListProductPricesResponse
object
1 property1 required
CreatePricingPlanParams
object
Parameters for creating a pricing plan
ParameterError
object
3 properties3 required
Product
object
A Remote product offering (e.g., EOR, Contractor Management) with its tier and billing frequency.
7 properties3 required
SSOConfigurationResponse
object
SSO Configuration response
1 property
CreateSSOConfigurationResult
object
5 properties5 required
CurrencyDefinition
object
Currency object without a UUID identifier
3 properties3 required
CreatePricingPlanWithoutPartnerTemplateParams
object
Parameters for creating a pricing plan without a partner template
3 properties3 required
BadRequestResponse
object
Returned when the request is malformed or contains invalid parameters. The message may be a simple string or a structured object with a code and detailed messa…
ConflictResponse
object
Returned when the request conflicts with the current state of a resource (HTTP 409). For example, trying to create a resource that already exists or performing…
1 property
CreateSSOConfigurationParams
object
Parameters for setting up SAML SSO for a company. Requires the email domain, identity provider URL, and the IdP's SAML signing certificate.
3 properties3 required
SSOConfiguration
object
A complete SSO configuration for a company, including both Remote-generated values (ssourl, audienceuri) and company-provided values (domain, identityprovideru…
4 properties4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Remote Partner Configuration API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.