Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
PricingDashboard
GuidesAPI ReferenceCLI
API ReferenceAccount and accessService Accounts

List service accounts

Returns the organization's service accounts, each with its role, whether it is disabled, how many unrevoked API keys it holds, and who created it.

Required permission

Requires the serviceaccount.read permission. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

orl service-accounts list
GET
/v1/service-accounts

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Response Body

Service accounts

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://api.openrelay.inc/v1/service-accounts'
Example Response
[  {    "id": "string",    "name": "string",    "description": "string",    "roleId": "string",    "roleName": "string",    "disabled": true,    "keyCount": 0,    "createdBy": "string",    "createdAt": "string"  }]

Overview

Organization-owned identities with a role, for keys that should outlive the people who created them. Deleting an account revokes its keys. Available to organizations with permissions enabled; otherwise these endpoints return 404.

Create a service account POST

Creates an organization-owned identity with a role, for API keys not tied to a person. It cannot hold the Owner role; an org may have at most 200. Requires a signed-in session. Its role must be within the creator's own access.