Applications and agents authorized on this account

GET

/v1/account/principals

curl --request GET \
  --url 'https://api.trustysweep.com/v1/account/principals?limit=50' \
  --cookie sweep_session=<sweep_session>

• Production (test mode via sk_test_ keys)

Authorizations

• sessionCookie
• sessionToken

Parameters

Query Parameters

limit

integer

default: 50 >= 1 <= 200

cursor

string

Opaque cursor from next_cursor.

Responses

200

OK

Media typeapplication/json

object

data

required

Array<object>

object

id

required

string

type

required

string

Allowed values: user sweep_automation developer_application external_agent service connector

status

required

string

Allowed values: active suspended revoked expired

ownerId

One of:

string

string

null

null

tenantId

One of:

string

string

null

null

display_name

One of:

string

string

null

null

createdAt

required

string format: date-time

expiresAt

One of:

string

string format: date-time

null

null

revokedAt

One of:

string

string format: date-time

null

null

riskState

required

string

Allowed values: normal elevated blocked

lastActivityAt

One of:

string

string format: date-time

null

null

next_cursor

required

string | null

Example

{
  "data": [
    {
      "type": "user",
      "status": "active",
      "riskState": "normal"
    }
  ]
}

Headers

RateLimit-Limit

integer

Requests allowed in the current window.

RateLimit-Remaining

integer

Requests remaining in the current window.

RateLimit-Reset

integer

Seconds until the window resets.

400

Validation failed

Media typeapplication/problem+json

RFC 9457 problem details.

object

type

required

Https://developers.trustysweep.com/errors/

string format: uri

title

required

string

status

required

integer

detail

string

code

required

Machine-readable error code from errors.json

string

request_id

required

string

errors

Array<object>

object

path

required

string

message

required

string

Examplegenerated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

401

Unauthenticated

Media typeapplication/problem+json

RFC 9457 problem details.

object

type

required

Https://developers.trustysweep.com/errors/

string format: uri

title

required

string

status

required

integer

detail

string

code

required

Machine-readable error code from errors.json

string

request_id

required

string

errors

Array<object>

object

path

required

string

message

required

string

Examplegenerated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

403

Forbidden / action denied / step-up required

Media typeapplication/problem+json

RFC 9457 problem details.

object

type

required

Https://developers.trustysweep.com/errors/

string format: uri

title

required

string

status

required

integer

detail

string

code

required

Machine-readable error code from errors.json

string

request_id

required

string

errors

Array<object>

object

path

required

string

message

required

string

Examplegenerated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

404

Not found

Media typeapplication/problem+json

RFC 9457 problem details.

object

type

required

Https://developers.trustysweep.com/errors/

string format: uri

title

required

string

status

required

integer

detail

string

code

required

Machine-readable error code from errors.json

string

request_id

required

string

errors

Array<object>

object

path

required

string

message

required

string

Examplegenerated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

429

Rate limited

Media typeapplication/problem+json

RFC 9457 problem details.

object

type

required

Https://developers.trustysweep.com/errors/

string format: uri

title

required

string

status

required

integer

detail

string

code

required

Machine-readable error code from errors.json

string

request_id

required

string

errors

Array<object>

object

path

required

string

message

required

string

Examplegenerated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

Headers

Retry-After

integer

Seconds to wait before retrying.

RateLimit-Limit

integer

Requests allowed in the current window.

RateLimit-Remaining

integer

Requests remaining in the current window.

RateLimit-Reset

integer

Seconds until the window resets.

500

Internal error

Media typeapplication/problem+json

RFC 9457 problem details.

object

type

required

Https://developers.trustysweep.com/errors/

string format: uri

title

required

string

status

required

integer

detail

string

code

required

Machine-readable error code from errors.json

string

request_id

required

string

errors

Array<object>

object

path

required

string

message

required

string

Examplegenerated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}