Users

List all Users

Changed on Sep 7, 2026

List all users within your Sequence account.

get/users

Request

Base URL
https://sandbox.sequencehq.com/api
URL
https://sandbox.sequencehq.com/api/users
Auth
none declared. Required headers: Authorization

Query parameters

limitinteger

Maximum number of objects to return per-page. Must be between 1 and 100 (inclusive).

afterstring

Pagination offset. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.

beforestring

Pagination offset. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.next or pagination.previous to retrieve each page.

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version'2024-07-30'

Use this header to select an API version

Response

Example response

{
  "items": [
    {
      "id": "7b1f28b9-a4ad-450b-a0ea-fd647d5109b2",
      "email": "john@example.xyz",
      "sequenceAccountIds": [
        "83da2ca4-49c7-4d81-9c9a-ba5be11768b0",
        "c0901c87-e1a9-48e9-9e2f-9e05c402dcea"
      ],
      "state": "active",
      "roles": [
        {
          "roleName": "financeUser",
          "permissions": [
            {
              "resource": "org.customer",
              "actions": [
                "create",
                "read",
                "update",
                "delete",
                "archive",
                "sync"
              ]
            },
            {
              "resource": "org.billing",
              "actions": [
                "create",
                "read",
                "update",
                "delete",
                "archive",
                "start",
                "sync"
              ]
            },
            {
              "resource": "org.product",
              "actions": [
                "create",
                "read",
                "update",
                "delete",
                "archive"
              ]
            },
            {
              "resource": "org.quote",
              "actions": [
                "read",
                "execute"
              ]
            },
            {
              "resource": "org.invoice",
              "actions": [
                "create",
                "read",
                "update",
                "delete",
                "archive",
                "finalize",
                "send",
                "sync"
              ]
            },
            {
              "resource": "org.creditNote",
              "actions": [
                "create",
                "read",
                "update",
                "delete",
                "archive",
                "finalize",
                "send",
                "sync"
              ]
            },
            {
              "resource": "org.usage",
              "actions": [
                "read"
              ]
            },
            {
              "resource": "org.revenueRecognition",
              "actions": [
                "create",
                "read",
                "update",
                "delete",
                "archive"
              ]
            },
            {
              "resource": "org.settings",
              "actions": [
                "read",
                "invite"
              ]
            },
            {
              "resource": "org.integration",
              "actions": [
                "read"
              ]
            },
            {
              "resource": "org.tax",
              "actions": [
                "create",
                "read",
                "update",
                "delete",
                "archive"
              ]
            },
            {
              "resource": "org.asset",
              "actions": [
                "create",
                "read",
                "update",
                "delete",
                "archive"
              ]
            },
            {
              "resource": "org.watchtower",
              "actions": [
                "read"
              ]
            },
            {
              "resource": "org.bulkAction",
              "actions": [
                "create",
                "read",
                "update",
                "delete",
                "archive"
              ]
            },
            {
              "resource": "org.savedView",
              "actions": [
                "create",
                "read",
                "update",
                "delete",
                "archive"
              ]
            }
          ]
        }
      ]
    }
  ],
  "pagination": {
    "after": "ZTMwOWU5NDgtMDg4ZS00ZDc3LWI2NTQtY2Q4NTQ5OGYxNTU1IzE2NTgyNjA4NTYwMzMwMTMjREVTQw==",
    "before": "NjRlZjJmZjktMmJjYi00M2RiLWI0ZDUtOTAxMDU4MjRiMTdmIzE2NTgyNjA3NTk3NTE2ODEjQVND",
    "totalResultSize": 100
  }
}

Changes

Sep 7, 2026cd0cfb494aef Revision changes
- warning
  added the new {"roleName":"admin","permissions":[{"resource":"org.customer","actions":["create","read","update","delete","archive","sync"]},{"resource":"org.billing","actions":["create","read","update","delete","archive","start","sync"]},{"resource":"org.product","actions":["create","read","update","delete","archive"]},{"resource":"org.invoice","actions":["create","read","update","delete","archive","finalize","send","sync"]},{"resource":"org.creditNote","actions":["create","read","update","delete","archive","finalize","send","sync"]},{"resource":"org.quote","actions":["create","read","update","delete","archive","publish","accept","execute","sync"]},{"resource":"org.revenueRecognition","actions":["create","read","update","delete","archive"]},{"resource":"org.usage","actions":["create","read","update","delete","archive"]},{"resource":"org.settings","actions":["create","read","update","delete","archive","invite"]},{"resource":"org.integration","actions":["create","read","update","delete","archive"]},{"resource":"org.tax","actions":["create","read","update","delete","archive"]},{"resource":"org.asset","actions":["create","read","update","delete","archive"]},{"resource":"org.watchtower","actions":["create","read","update","delete","archive"]},{"resource":"org.bulkAction","actions":["create","read","update","delete","archive"]},{"resource":"org.savedView","actions":["create","read","update","delete","archive"]}]} enum value to the /// response property for the response status
- warning
  added the new {"roleName":"financeUser","permissions":[{"resource":"org.customer","actions":["create","read","update","delete","archive","sync"]},{"resource":"org.billing","actions":["create","read","update","delete","archive","start","sync"]},{"resource":"org.product","actions":["create","read","update","delete","archive"]},{"resource":"org.quote","actions":["read","execute"]},{"resource":"org.invoice","actions":["create","read","update","delete","archive","finalize","send","sync"]},{"resource":"org.creditNote","actions":["create","read","update","delete","archive","finalize","send","sync"]},{"resource":"org.usage","actions":["read"]},{"resource":"org.revenueRecognition","actions":["create","read","update","delete","archive"]},{"resource":"org.settings","actions":["read","invite"]},{"resource":"org.integration","actions":["read"]},{"resource":"org.tax","actions":["create","read","update","delete","archive"]},{"resource":"org.asset","actions":["create","read","update","delete","archive"]},{"resource":"org.watchtower","actions":["read"]},{"resource":"org.bulkAction","actions":["create","read","update","delete","archive"]},{"resource":"org.savedView","actions":["create","read","update","delete","archive"]}]} enum value to the /// response property for the response status
- warning
  added the new {"roleName":"salesUser","permissions":[{"resource":"org.customer","actions":["create","read","update","delete","archive","sync"]},{"resource":"org.billing","actions":["read"]},{"resource":"org.product","actions":["read"]},{"resource":"org.quote","actions":["create","read","update","delete","archive","publish","accept","sync"]},{"resource":"org.invoice","actions":["read"]},{"resource":"org.creditNote","actions":["read"]},{"resource":"org.usage","actions":["read"]},{"resource":"org.revenueRecognition","actions":["read"]},{"resource":"org.settings","actions":["read","invite"]},{"resource":"org.integration","actions":["read"]},{"resource":"org.tax","actions":["read"]},{"resource":"org.asset","actions":["create","read","update","delete","archive"]},{"resource":"org.watchtower","actions":["read"]},{"resource":"org.bulkAction","actions":["create","read","update","delete","archive"]},{"resource":"org.savedView","actions":["create","read","update","delete","archive"]}]} enum value to the /// response property for the response status
- info
  removed the {"roleName":"admin","permissions":[{"resource":"org.customer","actions":["create","read","update","delete","archive"]},{"resource":"org.billing","actions":["create","read","update","delete","archive","start"]},{"resource":"org.product","actions":["create","read","update","delete","archive"]},{"resource":"org.invoice","actions":["create","read","update","delete","archive","finalize","send"]},{"resource":"org.creditNote","actions":["create","read","update","delete","archive","finalize","send"]},{"resource":"org.quote","actions":["create","read","update","delete","archive","publish","accept","execute"]},{"resource":"org.revenueRecognition","actions":["create","read","update","delete","archive"]},{"resource":"org.usage","actions":["create","read","update","delete","archive"]},{"resource":"org.settings","actions":["create","read","update","delete","archive","invite"]},{"resource":"org.integration","actions":["create","read","update","delete","archive"]},{"resource":"org.tax","actions":["create","read","update","delete","archive"]},{"resource":"org.asset","actions":["create","read","update","delete","archive"]},{"resource":"org.watchtower","actions":["create","read","update","delete","archive"]},{"resource":"org.bulkAction","actions":["create","read","update","delete","archive"]},{"resource":"org.savedView","actions":["create","read","update","delete","archive"]}]} enum value from the /// response property for the response status
- info
  removed the {"roleName":"financeUser","permissions":[{"resource":"org.customer","actions":["create","read","update","delete","archive"]},{"resource":"org.billing","actions":["create","read","update","delete","archive","start"]},{"resource":"org.product","actions":["create","read","update","delete","archive"]},{"resource":"org.quote","actions":["read","execute"]},{"resource":"org.invoice","actions":["create","read","update","delete","archive","finalize","send"]},{"resource":"org.creditNote","actions":["create","read","update","delete","archive","finalize","send"]},{"resource":"org.usage","actions":["read"]},{"resource":"org.revenueRecognition","actions":["create","read","update","delete","archive"]},{"resource":"org.settings","actions":["read","invite"]},{"resource":"org.integration","actions":["read"]},{"resource":"org.tax","actions":["create","read","update","delete","archive"]},{"resource":"org.asset","actions":["create","read","update","delete","archive"]},{"resource":"org.watchtower","actions":["read"]},{"resource":"org.bulkAction","actions":["create","read","update","delete","archive"]},{"resource":"org.savedView","actions":["create","read","update","delete","archive"]}]} enum value from the /// response property for the response status
- info
  removed the {"roleName":"salesUser","permissions":[{"resource":"org.customer","actions":["create","read","update","delete","archive"]},{"resource":"org.billing","actions":["read"]},{"resource":"org.product","actions":["read"]},{"resource":"org.quote","actions":["create","read","update","delete","archive","publish","accept"]},{"resource":"org.invoice","actions":["read"]},{"resource":"org.creditNote","actions":["read"]},{"resource":"org.usage","actions":["read"]},{"resource":"org.revenueRecognition","actions":["read"]},{"resource":"org.settings","actions":["read","invite"]},{"resource":"org.integration","actions":["read"]},{"resource":"org.tax","actions":["read"]},{"resource":"org.asset","actions":["create","read","update","delete","archive"]},{"resource":"org.watchtower","actions":["read"]},{"resource":"org.bulkAction","actions":["create","read","update","delete","archive"]},{"resource":"org.savedView","actions":["create","read","update","delete","archive"]}]} enum value from the /// response property for the response status
Jul 20, 2026c48cffa2c23d Revision changes
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status

Operation history