How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Gremlin

Gremlin companies API

Update company preferences, get all users or clients for a company, and get company details

Documentation Provider Profile APIs.io OpenAPI GitHub

Gremlin companies API is one of 55 APIs that Gremlin publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Companies. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 33 operations across 24 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.gremlin.com/v1.

33 operations 24 paths 28 schemas 5 DELETE11 GET1 PATCH13 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.gremlin.com/v1
Contact
Gremlin Support
License
Gremlin License
Terms of Service
View terms
Resource Areas
1

Paths & Operations 33

Across 24 paths, the API surfaces 33 operations — 5 DELETE, 11 GET, 1 PATCH, 13 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

companies 33

Update company preferences, get all users or clients for a company, and get company details

GET
/companies/zones
Gets all names of configured and detected zones
getZones → default403401
POST
/companies/zones
Create a zone
addZoneSetting body → default403401
POST
/companies
Allows a user to create a new Company
create_1 body → default403
GET
/companies/{identifier}/saml/claim-aliases
Returns all aliases for a company
getClaimAliasesForCompany 1 param → default403401
POST
/companies/{identifier}/saml/claim-aliases
Creates a claim alias for the company
createAlias 1 param body → default403401
GET
/companies/{identifier}/users
Returns all users for the supplied company
getUsersForCompany 1 param → default403401
POST
/companies/{identifier}/users
Create a new user.
createUserFromInvite 1 param body → default403
GET
/companies/{identifier}/saml/claim-aliases/{aliasId}
Returns an alias for a company
getClaimAlias 2 params → default403401
PUT
/companies/{identifier}/saml/claim-aliases/{aliasId}
Updates a claim alias for the company
updateAlias 2 params body → default403401
DELETE
/companies/{identifier}/saml/claim-aliases/{aliasId}
Deletes a claim alias for the company
deleteAlias 2 params → default403401
GET
/companies/zones/{zoneId}
Get a zone setting
getZoneSetting 1 param → default403401
PUT
/companies/zones/{zoneId}
Update a zone
editZoneSetting 1 param body → default403401
DELETE
/companies/zones/{zoneId}
Delete zone setting
deleteZoneSetting 1 param → default403401
GET
/companies/{identifier}/users/active/paged
Returns paginated active users for the supplied company
getActiveUsersForCompanyPaginated 3 params → default403401
GET
/companies/{identifier}/clients
Returns all clients for the supplied company
getClientsForCompany 1 param → default403401
GET
/companies/{identifier}
Gets a Company by its supplied guid
getCompany 2 params → default403401
PATCH
/companies/{identifier}
Update the prefs for company
updateCompanyPrefs 1 param body → default403401
GET
/companies/{identifier}/users/invited/paged
Returns paginated invited users for the supplied company
getInvitedUsersForCompanyPaginated 3 params → default403401
GET
/companies/{identifier}/users/revoked/paged
Returns paginated revoked users for the supplied company
getRevokedUsersForCompanyPaginated 3 params → default403401
GET
/companies/{identifier}/users/paged
Returns paginated users for the supplied company
getUsersForCompanyPaginated 3 params → default403401
POST
/companies/invite
Invites the specified email to create a new Company.
invite body → default403
POST
/companies/{identifier}/invites
Invite one or more users to join your Gremlin company
inviteUsersToCompany 1 param body → default403401
POST
/companies/{identifier}/users/{email}/active
User must exist. This is primarily used to reactivate a deactivated user.
rbacUnrevoke 2 params → default403401
DELETE
/companies/{identifier}/users/{email}/active
Deactivates a user.
rbacRevoke 2 params → default403401
DELETE
/companies/{identifier}/invites/{email}
Revoke a pending user invite.
rbacRevokeInvite 2 params → default403401
PUT
/companies/{identifier}/users/{email}
Update roles of existing user.
rbacUpdate 2 params body → default403401
POST
/companies/trialdeprecated
Allows an invited user to create a new Company for a trial.
trial body → default403
POST
/companies/{identifier}/auth/prefs
Updates the authentication preferences associated with this Company.
updateAuthMethodPrefs 1 param body → default403401
POST
/companies/{identifier}/mfaPrefs
Updates the MFA preferences associated with this Company.
updateMfaPrefs 1 param body → default403401
POST
/companies/{identifier}/oauth/settings
Updates the OAuth settings for this Company.
updateOAuthSettings 1 param body → default403401
POST
/companies/{identifier}/prefsdeprecated
Updates the preferences associated with this Company.
updatePrefs 1 param body → default403401
POST
/companies/{identifier}/saml/props
Updates the preferences associated with this Company.
updateSamlProperties 1 param body → default403401
DELETE
/companies/{identifier}/users/{email}/api-key/{api-key-id}
Requires the privilege [COMPANYUSERSWRITE](https://www.gremlin.com/docs/user-management/access-control/privileges)
userApiKeyRevoke 3 params → default403401

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are Info (19 properties), CompanyResponse (16 properties), CompanyEntitlementsResponse (14 properties), UpdateCompanyAuthMethodPrefsRequest (13 properties). Each schema is shown below with its type and property counts.

OrderedSamlAlias
object
3 properties
SamlIdpPrefs
object
6 properties
CompanyInviteResponse
object
2 properties
Key
object
2 properties
UpdateCompanyAuthMethodPrefsRequest
object
Represents a request to update the authentication method preferences for a company. When not passed, value of the pref is set to the Gremlin decided default va…
13 properties
InviteUserFromSelfSignupRequest
object
Represents a request to create a new user from the self signup page
4 properties 2 required
CreateOrUpdateClaimAliasRequest
object
Represents a request to create or update a SAML claims alias on behalf of a user
3 properties
ScheduleWindow
object
2 properties 2 required
CompanyResponse
object
16 properties
GremlinUserPrincipal
object
5 properties
OAuthSettings
object
7 properties
PrefsPatch
object
Prefs on team level
1 property
TestRunRestrictionWindow
object
2 properties 2 required
CreateUserRequest
object
Represents a request to create a new user within the company
4 properties 2 required
Prefs
object
Prefs for team
3 properties
AuthMethodPrefs
object
12 properties
CompanyEntitlementsResponse
object
14 properties
SetRolesRequest
object
1 property 1 required
SamlAliasIDs
object
1 property
CompanyPatch
object
3 properties
SamlAlias
object
6 properties
CreateCompanyRequest
object
Represents a request to create a new Gremlin company
6 properties 4 required
TeamRoles
object
3 properties
Info
object
19 properties
Zone
object
A zone setting for zonal tests
3 properties 2 required
UpdateOAuthSettingsRequest
object
A request to update the OAuth settings for a company
6 properties 5 required
InviteUserRequest
object
Represents a request to invite a user to Gremlin.
5 properties 1 required
AssignedRole
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gremlin-companies-api-openapi.yml Raw ↑

Other APIs Gremlin publishes across the network.

Gremlin agents API
AE Profile APIs.io
Gremlin apikeys API
AE Profile APIs.io
Gremlin attacks API
AE Profile APIs.io
Gremlin aws.metadata API
AE Profile APIs.io
Gremlin clients API
AE Profile APIs.io
Gremlin containers API
AE Profile APIs.io
Gremlin datadog API
AE Profile APIs.io
Gremlin disaster-recovery-test-reports API
AE Profile APIs.io
Gremlin disaster-recovery-tests API
AE Profile APIs.io
Gremlin executions API
AE Profile APIs.io
Gremlin external-integrations API
AE Profile APIs.io
Gremlin failure-flags.apps API
AE Profile APIs.io
#Companies
← Back to G APIs
API Details
ID
gremlin:gremlin-companies-api
Base URL
https://api.gremlin.com/v1
Docs
https://www.gremlin.com/docs
Provider
Gremlin
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

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.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=gremlin-companies-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/gremlin-companies-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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 Gremlin companies 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.