v1

latestOpenAPI 3.0.02026-07-261733191.1 MB
Users

Get a user

Retrieve the details of one of your users.

get/users/{id}

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"
          ]
        },
        {
          "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"
          ]
        }
      ]
    }
  ]
}
All 173 operations