Company related resource, includes: users, apitoken (Private Authentication API Token)

API Token

Method
Description

GET

get-company-api-token

https://api.pepperi.com/v1.0/company/apitoken

Retrieves company level API Token, Company ID and API Base URI. Requires Admin credentials.

POST

post-company-api-token

https://api.pepperi.com/v1.0/company/apitoken

Updates company level API Token . Admin Credentails are required. CompanyID is required.

Users

Method
Description

GET

get-users

https://api.pepperi.com/v1.0/users

{Beta} Retrieves a list of users including details about each user and its nested objects.

GET

get-user-by-id

https://api.pepperi.com/v1.0/users/{id}

{Beta} Retrieves a single user by internal id.

GET

get-user-by-externalid

https://api.pepperi.com/v1.0/users/externalid/{id}

{Beta} Retrieves a single user by external id.

GET

get-users-metadata

https://api.pepperi.com/v1.0/metadata/users

{Beta} Retrieves the users metadata(schema).

GET

get-login-log-by-user-id

https://api.pepperi.com/v1.0/users/{id}/log

{Beta} Retrieves a single user login and sync log by user internal id.

GET

get-users-totals

https://api.pepperi.com/v1.0/totals/users

Retrieves aggregated data for the users resource.