Users (1.0)

Download OpenAPI specification:Download

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

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:

XCompleatApiKey

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

Response samples

200
400
401
500

Content type

application/json

{"Count": 3,
"Users": [{"Id": "238fe304-a8cc-4c74-889f-a850dc6bd9a0",
"FirstName": "Jane",
"LastName": "Doe",
"EmailAddress": "jane.doe@example.com",
"Role": "Finance Director",
"Status": "ACTIVE",
"Active": true
},
{"Id": "f5503053-1f49-4ef0-b4d8-ba12ef67757a",
"FirstName": "John",
"LastName": "Doe",
"EmailAddress": "john.doe@example.com",
"Role": "Finance Controller",
"Status": "PWDRESET",
"Active": true
},
{"Id": "fb9cc11d-8ab1-4a7e-a3a9-172f274a3154",
"FirstName": "John",
"LastName": "Smith",
"EmailAddress": "john.smith@example.com",
"Role": "Operator",
"Status": "SUSPENDED",
"Active": true
}
],
"MetaData": {"RequestUrl": "https://[route]/api/users/e3bac1c0-f570-4ea6-af0b-b1817870e745",
"Version": 1,
"DateCreated": "2018-08-08T11:43:01.5753381Z"
}
}

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:

XCompleatApiKey

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

Response samples

200
400
401
500

Content type

application/json

{"Id": "a769e820-10ff-4c96-ad9f-718b295c1aef",
"FirstName": "John",
"LastName": "Doe",
"Email": "john.doe@example.com",
"Role": "Finance controller",
"Nominee": {"Id": "675882fe-131f-4369-84e8-543104b39a58",
"Name": "Jane Doe"
},
"Language": {"Code": "en-GB",
"Name": "English (United Kingdom)"
},
"Status": "ACTIVE",
"TenantId": "0e5ca9e1-5ba3-483c-bc4c-d8dd2e078f06",
"Companies": [{"Id": "68ae5d60-b0ab-4d02-b309-191f6dcb61b6",
"Name": "Company 1 example",
"IsApprover": true,
"IsGlobalAdministrator": true,
"IsCompanyAdministrator": false,
"IsAPOperator": true,
"CanApproverEditTransactions": false,
"CanAccessInvoicePacks": false,
"CanApproveInvoicePacks": false,
"CanCreateOrders": false,
"Layouts": [{"Id": "a5d7d816-1f57-4078-8606-17c618a5ed27",
"Name": "iCompleatInvoice Layout for Invoices"
},
{"Id": "5322f7a0-fe5f-4b6c-b693-2b384db621d0",
"Name": "iCompleatInvoice Layout for Credit Notes"
},
{"Id": "1131337a-9c80-46d1-9a39-40960408f506",
"Name": "iCompleatOrder Layout for Orders"
}
]
},
{"Id": "b377de7c-4ee2-4629-93e7-494fc066a0b3",
"Name": "Company 2 example",
"IsApprover": true,
"IsGlobalAdministrator": true,
"IsCompanyAdministrator": false,
"IsAPOperator": true,
"CanApproverEditTransactions": false,
"CanAccessInvoicePacks": false,
"CanApproveInvoicePacks": false,
"CanCreateOrders": false,
"Layouts": [{"Id": "3af21ebd-dea5-47c6-8dee-00e95ad2316e",
"Name": "iCompleatInvoice Layout for Credit Notes"
},
{"Id": "459bed69-2932-472e-8324-14999b2b821e",
"Name": "iCompleatInvoice Layout for Invoices"
},
{"Id": "81639ccb-c943-4b57-b7c0-39a77750fed6",
"Name": "iCompleatOrder Layout for Orders"
}
]
},
{"Id": "f925bea0-71dc-4b08-937d-fecbdb3c32df",
"Name": "Company 3 example",
"IsApprover": true,
"IsGlobalAdministrator": true,
"IsCompanyAdministrator": true,
"IsAPOperator": true,
"CanApproverEditTransactions": true,
"CanAccessInvoicePacks": false,
"CanApproveInvoicePacks": false,
"CanCreateOrders": true,
"Layouts": [{"Id": "b4a6e8a6-786c-4b92-9e52-41a89850adfa",
"Name": "iCompleatInvoice Layout for Invoices"
},
{"Id": "89742273-6bf2-4944-86b8-b97e78f5a3da",
"Name": "Default Layout "
},
{"Id": "84984397-c327-4624-9257-bd029748ed94",
"Name": "iCompleatInvoice Layout for Credit Notes"
}
]
}
],
"MetaData": {"RequestUrl": "https://[route]/api/user/e3bac1c0-f570-4ea6-af0b-b1817870e745/a769e820-10ff-4c96-ad9f-718b295c1aef",
"Version": 1,
"DateCreated": "2018-08-08T11:43:01.5753381Z"
}
}