Users

Retrieve the details of one of your users.

get/users/{id}

Request

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

Path parameters

idstring required

Sequence User ID

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version'2024-07-30'

Use this header to select an API version

Response

OK

idstring required

The unique ID of this user.

emailstring required

The email address of this user.

sequenceAccountIdsstring[] required

A list of Sequence account IDs. These account IDs represent the accounts this user has access to.

statestring required

The state of this user.

rolesRole[] required

The roles assigned to this user for the current Sequence account.

Example response

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

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