SHshipmondo
Staff accounts

Retrieve a single staff account

Changed on

Returns a staff account related to the current user, based on the given id.

get/staff_accounts/{id}

Request

  • Base URL
    https://sandbox.shipmondo.com/api/public/v3
  • URL
    https://sandbox.shipmondo.com/api/public/v3/staff_accounts/{id}
  • Auth
    HTTP basic

Path parameters

idinteger required

ID for the staff_account to be included in the filter

Response

Successful.

idnumber nullable

The identifier for the staff account. Null while the staff account is invited and the invite has not been accepted yet.

namestring

The name of the account.

emailstring nullable

The e-mail of the account. For an invited staff account, the e-mail the invite was sent to.

status'invited' | 'active'

The status of the staff account.

permissionsstring[]

A list of permissions the user has for the app

Example response

{
  "id": 27,
  "name": "Lene Hansen",
  "email": "info@minvirksomhed.dk",
  "status": "active",
  "permissions": [
    "dashboard",
    "orders",
    "shipments"
  ]
}

Changes

  • d3c430847097Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • info

      added the optional property to the response with the status