Skip to content
Tallyraydocs

A user's sessions: yours, or the user_id staff name

GET
/v1/sessions
curl --request GET \
  --url 'https://example.com/v1/sessions?sort=created_at' \
  --header 'Authorization: Bearer <token>'

Who: a signed-in user, not an API key. Not for API keys.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
page_size
integer
>= 1

Rows a page, up to the list’s maximum; the service’s default when left out

page_token
string

The previous page’s meta.next_page_token

sort
string

Comma-separated fields, each with - for descending

user_id
string
include_revoked
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
data
required
Array<object>
object
account
required
object
id
integer format: int64
kind
required
string | null
Allowed values: network affiliate advertiser service workspace
created_at
required
string format: date-time
current
required
boolean
expires_at
required
string format: date-time
id
required
string
ip
required
string
last_refreshed_at
required
string | null format: date-time
revoke_reason
string | null
Allowed values: signed_out revoked password_changed user_disabled account_closed refresh_reused membership_removed membership_changed
revoked_at
required
string | null format: date-time
user_agent
required
string
user_id
required
string
meta
required
object
next_page_token
required
string | null
total
required
integer | null format: int64
total_approximate
required
boolean

Example 

{
  "data": [
    {
      "account": {
        "kind": "network"
      },
      "revoke_reason": "signed_out"
    }
  ]
}

default

Section titled “default”

An error, as go-commons apperr maps it

Media typeapplication/json
object
error
required
object
code
required
string
fields
object
key
additional properties
string
message
required
string

Example generated

{
  "error": {
    "code": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}