API Documentation
Sessions ¶
Sessions ¶
GET /api/v2/sessions
Requests
GET /api/v2/sessions
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": [
{
"id": "58",
"type": "sessions",
"attributes": {
"name": null,
"note": null,
"user_id": 119,
"token": "2cb4f326-b36d-4573-b7b1-1a4549920fb4",
"last_ip": null,
"location": null,
"device": null,
"platform": null,
"browser": null,
"machine": false,
"read_only": false,
"last_activity_at": "2025-09-03T06:03:33.596+02:00",
"token_expires_at": null,
"two_factor_auth": false,
"single_sign_on": false,
"agent_first_name": null,
"agent_last_name": null,
"agent_avatar": null
},
"relationships": {
"user": {
"meta": {
"included": false
}
}
}
}
],
"links": {
"first": "http://api-test.productive.io/api/v2/sessions?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://api-test.productive.io/api/v2/sessions?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200
}
}
Get all sessionsGET/api/v2/sessions
DELETE /api/v2/sessions/1
Requests
DELETE /api/v2/sessions/60
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
This response has no content.
POST /api/v2/sessions/machine
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "sessions",
"attributes": {
"name": "test token",
"read_only": true
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "68",
"type": "sessions",
"attributes": {
"name": "test token",
"note": null,
"user_id": 123,
"token": "0e431877-dcfc-485b-b614-c0cfade111da",
"last_ip": "127.0.0.1",
"location": "",
"device": null,
"platform": null,
"browser": "Mozilla",
"machine": true,
"read_only": true,
"last_activity_at": "2025-09-03T06:03:33.715+02:00",
"token_expires_at": null,
"two_factor_auth": false,
"single_sign_on": false,
"agent_first_name": null,
"agent_last_name": null,
"agent_avatar": null
},
"relationships": {
"user": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
POST /api/v2/sessions/machine
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "sessions",
"attributes": {}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/name"
}
}
]
}
POST /api/v2/sessions/jwt?expires_in=60
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/json; charset=utf-8
Body
{
"jwt": "eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxMjksImV4cCI6MTc1Njg3MjI3MywidHlwZSI6InJlYWQtb25seSJ9.NKxooHHhQrHGHV8bOpEfqnvbfMk0tFqvF-ACQKMrhmk",
"payload": {
"user_id": 129,
"exp": 1756872273,
"type": "read-only"
}
}
POST /api/v2/sessions
Requests
POST /api/v2/sessions
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "sessions",
"attributes": {
"email": "login@email.com",
"password": "123123"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "2195",
"type": "sessions",
"attributes": {
"name": null,
"note": null,
"user_id": 7591,
"token": "704d8082-9487-4314-8223-aae9a4208919",
"last_ip": "127.0.0.1",
"location": "",
"device": null,
"platform": null,
"browser": "Mozilla",
"machine": false,
"read_only": false,
"last_activity_at": "2025-09-03T06:19:34.278+02:00",
"token_expires_at": "2025-09-17T06:19:34.278+02:00",
"two_factor_auth": false,
"single_sign_on": false,
"agent_first_name": null,
"agent_last_name": null,
"agent_avatar": null
},
"relationships": {
"user": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
POST /api/v2/sessions
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "sessions",
"attributes": {
"email": "login@email.com",
"password": "aaa"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "401",
"code": "invalid_auth_token",
"title": "Unauthenticated",
"detail": "You are not authenticated",
"source": {}
}
]
}
POST /api/v2/sessions
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "sessions",
"attributes": {
"email": "login+invalid@email.com",
"password": "123123"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "401",
"code": "invalid_auth_token",
"title": "Unauthenticated",
"detail": "You are not authenticated",
"source": {}
}
]
}
Create a sessionPOST/api/v2/sessions
URI Parameters
string
(required) Example: user%40mail.comemail
- password
string
(required) Example: 123password
PUT /api/v2/sessions/1/validate_otp
Requests
PUT /api/v2/sessions/2201/validate_otp
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "sessions",
"attributes": {
"otp": "291638",
"password": "123123"
},
"relationships": {
"user": {
"data": {
"type": "users",
"id": "7606"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "2201",
"type": "sessions",
"attributes": {
"name": null,
"note": null,
"user_id": 7606,
"token": "dcab2338-c599-476a-860b-dbe18d55f76b",
"last_ip": null,
"location": null,
"device": null,
"platform": null,
"browser": null,
"machine": false,
"read_only": false,
"last_activity_at": "2025-09-03T06:19:34.927+02:00",
"token_expires_at": null,
"two_factor_auth": true,
"single_sign_on": false,
"agent_first_name": null,
"agent_last_name": null,
"agent_avatar": null
},
"relationships": {
"user": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PUT /api/v2/sessions/2203/validate_otp
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "sessions",
"attributes": {
"otp": "abcdefgh",
"password": "123123"
},
"relationships": {
"user": {
"data": {
"type": "users",
"id": "7609"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "2203",
"type": "sessions",
"attributes": {
"name": null,
"note": null,
"user_id": 7609,
"token": "a1a11d24-4f7b-425e-808c-2d7c62eed189",
"last_ip": null,
"location": null,
"device": null,
"platform": null,
"browser": null,
"machine": false,
"read_only": false,
"last_activity_at": "2025-09-03T06:19:35.074+02:00",
"token_expires_at": null,
"two_factor_auth": true,
"single_sign_on": false,
"agent_first_name": null,
"agent_last_name": null,
"agent_avatar": null
},
"relationships": {
"user": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PUT /api/v2/sessions/2205/validate_otp
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "sessions",
"attributes": {
"otp": "291638",
"password": "000000"
},
"relationships": {
"user": {
"data": {
"type": "users",
"id": "7612"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "401",
"code": "invalid_auth_token",
"title": "Unauthenticated",
"detail": "You are not authenticated",
"source": {}
}
]
}
PUT /api/v2/sessions/2207/validate_otp
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "sessions",
"attributes": {
"otp": "000000",
"password": "123123"
},
"relationships": {
"user": {
"data": {
"type": "users",
"id": "7615"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "attribute is invalid",
"source": {
"pointer": "data/attributes/otp"
}
}
]
}
Validates s sessionPUT/api/v2/sessions/{id}/validate_otp
URI Parameters
- id
number
(required) Example: 1session id
- password
string
(required) Example: 123password
- otp
string
(required) Example: abcotp
- user_id: `1` (number, required) - user_id
string
(required)
Generated by aglio on 03 Sep 2025