Users (1.0)

Download OpenAPI specification:Download

APIs that allow you to retrieve and interact with user information.

Authentication

XCompleatApiKey

Security Scheme Type API Key
Header parameter name: x-api-compleat-key

Users

Users

Retrieves a list of users for the tenant. If the optional company id is passed the result returns only users that have access to the company switched on.

If a company Id is passed and the company with that is not for the tenant a result with error code 2 is return - 'Unknown company'.Used to retrieve company information. Every tenant has one or more companies associated with it. This will retrieve summary information on all companies created under a tenant's account.

Authorizations:
path Parameters
tenantId
required
string <guid>
Example: d025eedc-5ea0-4de8-be9f-f8873545add9

Id of the tenant to retrieve information for. The account requesting the data must have access to this tenant Id.

companyId
required
string <guid>
Example: 8d4bb975-eade-42fd-a064-bf448e493c1e

Optional company id (use NULL value if unavailable). If provided, users returned will be filtered to only users linked to the company that this Id represents.

header Parameters
x-api-version
required
integer
Value: 1
Example: 1

Indicates the version of this API to be used.

x-api-compleat-key
required
string <guid>
Example: d025eedc-5ea0-4de8-be9f-f8873545add9

The header containing compleat api key.

Responses

200

Successful response. A list of users will be returned.

400

Bad request. Incorrect data has been provided.

401

Unauthorized. The secure credentials passed do not allow access to this resource.

500

An internal error has occurred.

get/api/users/{tenantId}/{companyId}
/api/users/{tenantId}/{companyId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "Count": 3,
  • "Users":
    [
    ],
  • "MetaData":
    {}
}

User

Retrieves detailed information on a specific user account.

A valid user Id must be passed in the path - if an invalid user Id is passed in, an Http 400 error with error code 3 will be returned.

Authorizations:
path Parameters
tenantId
required
string <guid>
Example: d025eedc-5ea0-4de8-be9f-f8873545add9

Id of the tenant to retrieve information for. The account requesting the data must have access to this tenant Id.

userId
required
string <guid>
Example: 8d4bb975-eade-42fd-a064-bf448e493c1e

Id of the user to retrieve detailed information on.

header Parameters
x-api-version
required
integer
Value: 1
Example: 1

Indicates the version of this API to be used.

x-api-compleat-key
required
string <guid>
Example: d025eedc-5ea0-4de8-be9f-f8873545add9

The header containing compleat api key.

Responses

200

Successful response. Details on the requested user will be returned.

400

Bad request. Incorrect data has been provided.

401

Unauthorized. The secure credentials passed do not allow access to this resource.

500

An internal error has occurred.

get/api/user/{tenantId}/{userId}
/api/user/{tenantId}/{userId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "Id": "a769e820-10ff-4c96-ad9f-718b295c1aef",
  • "FirstName": "John",
  • "LastName": "Doe",
  • "Email": "john.doe@example.com",
  • "Role": "Finance controller",
  • "Nominee":
    {
    },
  • "Language":
    {
    },
  • "Status": "ACTIVE",
  • "TenantId": "0e5ca9e1-5ba3-483c-bc4c-d8dd2e078f06",
  • "Companies":
    [
    ],
  • "MetaData":
    {}
}