API Documentation

API Endpoint

Users

Users

GET /api/v2/users
Requestsreturns usersreturns :unauthorized

GET  /api/v2/users

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": "111",
      "type": "users",
      "attributes": {
        "updated_at": "2025-10-04T02:02:57.882+02:00",
        "email": "user111@email.com",
        "first_name": "name",
        "last_name": "surname",
        "time_zone": null,
        "avatar_url": null,
        "default_organization_id": 67,
        "default_organization_slug": "67-organization67",
        "intercom_hash": "a45531d87305154957cfd49b966db72b56514b03434ee7a2d6602932e4e62a42",
        "flags": {},
        "newsletter_consent": false,
        "newsletter_consent_at": null,
        "ical_token": null,
        "preferences": null,
        "sysadmin": false,
        "sysadmin_permissions": [],
        "two_factor_auth": false,
        "sso_provision": false,
        "account_access_expires_at": null,
        "locale": "en_US"
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/users?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/users?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  /api/v2/users?token=invalid

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
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",
      "source": {}
    }
  ]
}

Gets users
GET/api/v2/users

GET /api/v2/users/1
Requestsreturns userreturns :not_found

GET  /api/v2/users/113

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": "113",
    "type": "users",
    "attributes": {
      "updated_at": "2025-10-04T02:02:58.090+02:00",
      "email": "user113@email.com",
      "first_name": "name",
      "last_name": "surname",
      "time_zone": null,
      "avatar_url": null,
      "default_organization_id": 69,
      "default_organization_slug": "69-organization69",
      "intercom_hash": "7001ae4eb1e7b13b74a70607ef87d325125dbe1f615fdb1002bdf34d91dc4673",
      "flags": {},
      "newsletter_consent": false,
      "newsletter_consent_at": null,
      "ical_token": null,
      "preferences": null,
      "sysadmin": false,
      "sysadmin_permissions": [],
      "two_factor_auth": false,
      "sso_provision": false,
      "account_access_expires_at": null,
      "locale": "en_US"
    }
  },
  "meta": {}
}

GET  /api/v2/users/115

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
Responses404
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "404",
      "code": "record_not_found",
      "title": "Record Not Found",
      "detail": "The requested record was not found",
      "source": {}
    }
  ]
}

Gets a user
GET/api/v2/users/{id}

URI Parameters
HideShow
id
number (required) Example: 1

user id

PATCH /api/v2/users/1
Requestsupdates userreturns error

PATCH  /api/v2/users/116

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": "users",
    "attributes": {
      "default_organization_id": 2
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "116",
    "type": "users",
    "attributes": {
      "updated_at": "2025-10-04T02:02:58.357+02:00",
      "email": "user116@email.com",
      "first_name": "name",
      "last_name": "surname",
      "time_zone": null,
      "avatar_url": null,
      "default_organization_id": 71,
      "default_organization_slug": "71-organization71",
      "intercom_hash": "fc4f456e76c00653eaff1abd86769830acc5cfcd631ae8c8c9c275ceb82742db",
      "flags": {},
      "newsletter_consent": false,
      "newsletter_consent_at": null,
      "ical_token": null,
      "preferences": null,
      "sysadmin": false,
      "sysadmin_permissions": [],
      "two_factor_auth": false,
      "sso_provision": false,
      "account_access_expires_at": null,
      "locale": "en_US"
    }
  },
  "meta": {}
}

PATCH  /api/v2/users/117

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": "users",
    "attributes": {
      "first_name": ""
    }
  }
}
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",
      "source": {
        "pointer": "data/attributes/first_name"
      }
    }
  ]
}

Update a user
PATCH/api/v2/users/{id}

URI Parameters
HideShow
id
number (required) Example: 1

user id

PATCH /api/v2/users/1/update_password
Requestsupdates password

PATCH  /api/v2/users/118/update_password

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": "users",
    "attributes": {
      "current_password": "password1234",
      "password": "newpassword1234"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "118",
    "type": "users",
    "attributes": {
      "updated_at": "2025-10-04T02:02:58.693+02:00",
      "email": "user118@email.com",
      "first_name": "name",
      "last_name": "surname",
      "time_zone": null,
      "avatar_url": null,
      "default_organization_id": 73,
      "default_organization_slug": "73-organization73",
      "intercom_hash": "9fa3c38a0a2c5ed4b3965d496b5b194ec5eb94902bfc154ca4cd142f358d08ff",
      "flags": {},
      "newsletter_consent": false,
      "newsletter_consent_at": null,
      "ical_token": null,
      "preferences": null,
      "sysadmin": false,
      "sysadmin_permissions": [],
      "two_factor_auth": false,
      "sso_provision": false,
      "account_access_expires_at": null,
      "locale": "en_US"
    }
  },
  "meta": {}
}

Update password for a user
PATCH/api/v2/users/{id}/update_password

URI Parameters
HideShow
id
number (required) Example: 1

user id

Generated by aglio on 04 Oct 2025