Remote Partner Configuration API is one of 101 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.0.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 Product (7 properties), PricingPlan (7 properties), PricingPlanPartnerTemplate (6 properties), CreateSSOConfigurationResult (5 properties). Each schema is shown below with its type and property counts.
ParameterError
object
3 properties3 required
PricingPlan
object
A pricing plan assigned to a company, defining the product, billing frequency, and cost.
7 properties7 required
CreatePricingPlanWithPartnerTemplateParams
object
Parameters for creating a pricing plan with a partner template
2 properties1 required
MagicLinkResponse
object
1 property1 required
PricingPlanPartnerTemplate
object
Pricing plan partner template
6 properties4 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
ListCompanyPricingPlansResponse
object
Company pricing plans
1 property1 required
CreateSSOConfigurationResponse
object
1 property1 required
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
ProductPrice
object
3 properties3 required
CurrencyDefinition
object
Currency object without a UUID identifier
3 properties3 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
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
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
SSOConfigurationResponse
object
SSO Configuration response
1 property
UnprocessableEntityResponse
object
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…
CreateSSOConfigurationResult
object
5 properties5 required
ActionError
object
3 properties3 required
SSOConfigurationDetailsResponse
object
SSO Configuration Details response
1 property
Product
object
A Remote product offering (e.g., EOR, Contractor Management) with its tier and billing frequency.
7 properties3 required
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
CreatePricingPlanResponse
object
Response for creating a pricing plan
1 property1 required
UuidSlug
string
Identifier of the employment being terminated.
ListProductPricesResponse
object
1 property1 required
CreatePricingPlanWithoutPartnerTemplateParams
object
Parameters for creating a pricing plan without a partner template
3 properties3 required
CreatePricingPlanParams
object
Parameters for creating a pricing plan
SSOConfigurationDetails
object
The SSO configuration details needed to set up your identity provider (IdP) to connect with Remote.
2 properties2 required
MagicLinkParams
object
Magic link params
ListPricingPlanPartnerTemplatesResponse
object
List of pricing plan partner templates
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
Price
object
A monetary amount with its currency, used for pricing plan costs.
2 properties2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
