Skip to main content
GET
/
scans
/
sessions
Get All Scans
curl --request GET \
  --url https://api.swoogo.com/api/v1/scans/sessions \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "created_at": "2023-04-21 15:46:23",
      "updated_at": "2023-04-21 15:47:37"
    }
  ],
  "_links": {
    "self": {
      "href": ""
    },
    "first": {
      "href": ""
    },
    "last": {
      "href": ""
    }
  },
  "_meta": {
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "perPage": 20
  }
}

Authorizations

​
Authorization
string
header
required

OAuth 2.0 bearer token obtained from POST /oauth2/token. Tokens expire after 30 minutes. Include in the Authorization header as Bearer {access_token}.

Query Parameters

​
event_id
integer
required

integer - required - The ID of the event you want to retrieve scans for

Example:

1

​
session_id
string

integer - optional - Optionally see only the scans for one session

Example:

""

​
registrant_id
string

integer - optional - The ID of the registrant the scan is associated with

Example:

""

​
fields
string

string - optional - Comma separated list of fields you want to return

Example:

"id,event_id,registrant_id,typecreated_by,created_at,scan_id"

​
page
string

integer - optional - The page of results you want to view

Example:

"1"

​
per-page
string

integer - optional - The number of results per page (to a max of 200)

Example:

"5"

​
search
string

string - optional - Filter conditions to narrow the results. Valid operators are =, !=, >=, <=, >, <, contains, beginswith, endswith

Example:

"id>123"

​
sort
string

string - optional - Sort the results (add - in front for opposite sort direction, e.g. "-id")

​
ids
string

Comma-separated list of IDs to retrieve. When provided, only records matching these IDs are returned. All values must be positive integers. Maximum 100 IDs per request.

Response

Collection

​
items
object[]
​
_links
object
​
_meta
object