GETpartial

List own clients, grants and notices

List own clients, grants and notices

/api/oauth/clientslistAccountOAuthClients

Authentication and authority

Use one listed account-session, scoped OAuth, or partner credential alternative. Account tokens retain the approving account’s authority. Cookie-authenticated writes require same-origin authorization. Alternatives are OR; schemes in one alternative are AND.

CanonicalSession

Parameters

This operation has no path, query, or header parameters.

Responses

200

Successful operation.

application/json

{
  "$ref": "#/components/schemas/AccountAuthorizations",
  "type": "object",
  "properties": {
    "clients": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AccountOAuthClient",
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "kind": {
            "type": "string",
            "enum": [
              "personal",
              "agent",
              "partner"
            ]
          },
          "partnerId": {
            "type": "string"
          },
          "mcpCaseId": {
            "type": "string"
          },
          "redirectUris": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "scopes": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "cases:read",
                "filings:write",
                "answers:write",
                "submissions:write",
                "records:confirm",
                "records:write",
                "invitations:write",
                "messages:write",
                "remedies:write",
                "consents:write",
                "offline_access",
                "representatives:manage",
                "procedural:request",
                "termination:write"
              ]
            }
          },
          "createdAt": {
            "type": "string"
          },
          "revokedAt": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "kind",
          "redirectUris",
          "scopes",
          "createdAt"
        ]
      }
    },
    "grants": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AccountAuthorityGrant",
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "clientId": {
            "type": "string"
          },
          "delegatePartnerId": {
            "type": "string"
          },
          "scope": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "cases:read",
                "filings:write",
                "answers:write",
                "submissions:write",
                "records:confirm",
                "records:write",
                "invitations:write",
                "messages:write",
                "remedies:write",
                "consents:write",
                "offline_access",
                "representatives:manage",
                "procedural:request",
                "termination:write"
              ]
            }
          },
          "resource": {
            "type": "string"
          },
          "terms": {
            "$ref": "#/components/schemas/AccountOAuthTerms",
            "type": "object",
            "properties": {
              "rulesVersion": {
                "type": "string"
              },
              "rulesHash": {
                "type": "string"
              },
              "disclosureVersion": {
                "type": "string"
              },
              "disclosureHash": {
                "type": "string"
              }
            },
            "required": [
              "rulesVersion",
              "rulesHash",
              "disclosureVersion",
              "disclosureHash"
            ]
          },
          "caseId": {
            "type": "string"
          },
          "caseBinding": {
            "type": "object",
            "properties": {
              "disputeId": {
                "type": "string"
              },
              "membershipId": {
                "type": "string"
              },
              "side": {
                "type": "string",
                "enum": [
                  "claimant",
                  "respondent"
                ]
              }
            },
            "required": [
              "disputeId",
              "membershipId",
              "side"
            ]
          },
          "standing": {
            "$ref": "#/components/schemas/AccountStandingBounds",
            "type": "object",
            "properties": {
              "acts": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "file_dispute",
                    "answer"
                  ]
                }
              },
              "maximumAmount": {
                "type": "object",
                "properties": {
                  "currency": {
                    "type": "string",
                    "const": "USD"
                  },
                  "minorUnits": {
                    "type": "string",
                    "pattern": "^[1-9][0-9]{0,14}$"
                  }
                },
                "required": [
                  "currency",
                  "minorUnits"
                ]
              },
              "transactionIds": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "expiresAt": {
                "type": "string",
                "format": "date-time"
              },
              "procedure": {
                "type": "string",
                "const": "standard"
              },
              "clock": {
                "type": "string",
                "const": "ordinary"
              }
            },
            "required": [
              "acts",
              "maximumAmount",
              "expiresAt",
              "procedure",
              "clock"
            ]
          },
          "approvedAt": {
            "type": "string"
          },
          "expiresAt": {
            "type": "string"
          },
          "revokedAt": {
            "type": "string"
          },
          "source": {
            "type": "string",
            "enum": [
              "authorization_code",
              "hosted_link",
              "agent_registration"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "expired",
              "revoked",
              "reacceptance_required"
            ]
          }
        },
        "required": [
          "id",
          "principalId",
          "clientId",
          "scope",
          "resource",
          "terms",
          "approvedAt",
          "expiresAt",
          "source"
        ]
      }
    },
    "notices": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "grantId": {
            "type": "string"
          },
          "caseId": {
            "type": "string"
          },
          "termsDigest": {
            "type": "string"
          },
          "createdAt": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "grantId",
          "caseId",
          "termsDigest",
          "createdAt"
        ]
      }
    }
  },
  "required": [
    "clients",
    "grants",
    "notices"
  ]
}
default

Authorization failure; consent_required requires explicit reacceptance.

application/json

{
  "$ref": "#/components/schemas/AccountOAuthError",
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  },
  "required": [
    "error"
  ]
}

Example response

Successful response

{
  "clients": [
    {
      "id": "id_test",
      "name": "name_test",
      "kind": "personal",
      "redirectUris": [
        "redirectUris_test"
      ],
      "scopes": [
        "cases:read"
      ],
      "createdAt": "createdAt_test"
    }
  ],
  "grants": [
    {
      "id": "id_test",
      "principalId": "principal_test_123",
      "clientId": "clientId_test",
      "scope": [
        "cases:read"
      ],
      "resource": "resource_test",
      "terms": {
        "rulesVersion": "rulesVersion_test",
        "rulesHash": "rulesHash_test",
        "disclosureVersion": "disclosureVersion_test",
        "disclosureHash": "disclosureHash_test"
      },
      "approvedAt": "approvedAt_test",
      "expiresAt": "expiresAt_test",
      "source": "authorization_code"
    }
  ],
  "notices": [
    {
      "id": "id_test",
      "grantId": "grantId_test",
      "caseId": "pcase_test_123",
      "termsDigest": "termsDigest_test",
      "createdAt": "createdAt_test"
    }
  ]
}

Errors

Read the response status and stable error code. See errors and rate limits for recovery. Refresh the resource before resolving a state or digest conflict.

Idempotency and retries

  • For throttling, honor Retry-After when present. Back off on retryable server failures.