API Documentation

API Endpoint

Sessions

Sessions

GET /api/v2/sessions
Requestsreturns sessions

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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "58",
      "type": "sessions",
      "attributes": {
        "name": null,
        "note": null,
        "user_id": 100,
        "token": "0123bab8-c4b0-4903-ba6c-5a4e0987dcba",
        "last_ip": null,
        "location": null,
        "device": null,
        "platform": null,
        "browser": null,
        "machine": false,
        "read_only": false,
        "last_activity_at": "2026-04-07T06:03:12.429+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 sessions
GET/api/v2/sessions

DELETE /api/v2/sessions/1
Requestsinvalidates sessionreturns userreturns errorreturns jwt token and payload

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
Responses204
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
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "68",
    "type": "sessions",
    "attributes": {
      "name": "test token",
      "note": null,
      "user_id": 104,
      "token": "a23cee7d-6bd1-4393-8a49-1ad081d4d575",
      "last_ip": "127.0.0.1",
      "location": "",
      "device": null,
      "platform": null,
      "browser": "Mozilla",
      "machine": true,
      "read_only": true,
      "last_activity_at": "2026-04-07T06:03:12.533+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": {}
  }
}
Responses422
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",
      "meta": {},
      "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
Responses201
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "jwt": "eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxMTAsImV4cCI6MTc3NTUzNDY1MiwidHlwZSI6InJlYWQtb25seSJ9.kiZDSqiq1dYIMv0fz1PGJhqSrFBVhXE6aejEWphId4E",
  "payload": {
    "user_id": 110,
    "exp": 1775534652,
    "type": "read-only"
  }
}

Deletes a session
DELETE/api/v2/sessions/{id}

URI Parameters
HideShow
id
number (required) Example: 1

session id

POST /api/v2/sessions
Requestsreturns session when email found and password matchingreturns error when password not matchingreturns error when email not found

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"
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "2259",
    "type": "sessions",
    "attributes": {
      "name": null,
      "note": null,
      "user_id": 7447,
      "token": "955cb978-2b2e-49c3-9425-249c4004dd95",
      "last_ip": "127.0.0.1",
      "location": "",
      "device": null,
      "platform": null,
      "browser": "Mozilla",
      "machine": false,
      "read_only": false,
      "last_activity_at": "2026-04-07T06:13:49.138+02:00",
      "token_expires_at": "2026-04-21T06:13:49.138+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"
    }
  }
}
Responses401
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",
      "meta": {},
      "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"
    }
  }
}
Responses401
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",
      "meta": {},
      "source": {}
    }
  ]
}

Create a session
POST/api/v2/sessions

URI Parameters
HideShow
email
string (required) Example: user%40mail.com

email

password
string (required) Example: 123

password

PUT /api/v2/sessions/1/validate_otp
Requestsupdates session when password matching and otp validupdates session when password matching and valid recovery codereturns error when password not matching and otp validreturns error when password matching and otp invalid

PUT  /api/v2/sessions/2265/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": "809059",
      "password": "123123"
    },
    "relationships": {
      "user": {
        "data": {
          "type": "users",
          "id": "7462"
        }
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "2265",
    "type": "sessions",
    "attributes": {
      "name": null,
      "note": null,
      "user_id": 7462,
      "token": "f005b10f-cb0f-45ec-abef-813a6e5e053f",
      "last_ip": null,
      "location": null,
      "device": null,
      "platform": null,
      "browser": null,
      "machine": false,
      "read_only": false,
      "last_activity_at": "2026-04-07T06:13:49.755+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/2267/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": "7465"
        }
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "2267",
    "type": "sessions",
    "attributes": {
      "name": null,
      "note": null,
      "user_id": 7465,
      "token": "97b928ff-c864-4524-a2f1-6a9e4fce8b8a",
      "last_ip": null,
      "location": null,
      "device": null,
      "platform": null,
      "browser": null,
      "machine": false,
      "read_only": false,
      "last_activity_at": "2026-04-07T06:13:49.892+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/2269/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": "809059",
      "password": "000000"
    },
    "relationships": {
      "user": {
        "data": {
          "type": "users",
          "id": "7468"
        }
      }
    }
  }
}
Responses401
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",
      "meta": {},
      "source": {}
    }
  ]
}

PUT  /api/v2/sessions/2271/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": "7471"
        }
      }
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "session_otp_invalid",
      "title": "Invalid Attribute",
      "detail": "is invalid",
      "meta": {},
      "source": {
        "pointer": "data/attributes/otp"
      }
    }
  ]
}

Validates s session
PUT/api/v2/sessions/{id}/validate_otp

URI Parameters
HideShow
id
number (required) Example: 1

session id

password
string (required) Example: 123

password

otp
string (required) Example: abc

otp

user_id: `1` (number, required) - user_id
string (required) 

Generated by aglio on 07 Apr 2026