User Requests

A UserRequest is an operation that allows anonymous users to place a request for access on the login screen to the site administrator.

List User Requests

Endpoint

GET/user_requests

Return Object

UserRequest[]

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

curl https://app.files.com/api/rest/v1/user_requests.json \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

[
  {
    "id": 1,
    "name": "John Doe",
    "email": "john.doe@files.com",
    "details": "Changed Departments",
    "company": "Acme Inc."
  }
]

Show User Request

Endpoint

GET/user_requests/{id}

Return Object

UserRequest

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Request Parameters

ParameterDescription
id
int64
Required		User Request ID.

Example Request

curl https://app.files.com/api/rest/v1/user_requests/{id}.json \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

{
  "id": 1,
  "name": "John Doe",
  "email": "john.doe@files.com",
  "details": "Changed Departments",
  "company": "Acme Inc."
}

Create User Request

Endpoint

POST/user_requests

Return Object

UserRequest

Authorization Requirement

No authentication required; you may call this endpoint without a key or session.

Request Parameters

ParameterDescription
name
string
Required		Name of user requested
email
string
Required		Email of user requested
details
string
Required		Details of the user request
company
string		Company of the user requested

Example Request

curl https://app.files.com/api/rest/v1/user_requests.json \
  -X POST \
  -H 'Content-Type: application/json' \
  -d '{"name":"name","email":"email","details":"details","company":"Acme Inc."}' \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

{
  "id": 1,
  "name": "John Doe",
  "email": "john.doe@files.com",
  "details": "Changed Departments",
  "company": "Acme Inc."
}

Delete User Request

Endpoint

DELETE/user_requests/{id}

Return Object

No return value.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Request Parameters

ParameterDescription
id
int64
Required		User Request ID.

Example Request

curl https://app.files.com/api/rest/v1/user_requests/{id}.json \
  -X DELETE \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

The UserRequest Object

Some of the endpoints above return a UserRequest object. The attributes of this object are listed below.

AttributeDescription
id
int64		ID
name
string		User's full name
email
email		User email address
details
string		Details of the user's request
company
string		User's company name

Example UserRequest Object

{
  "id": 1,
  "name": "John Doe",
  "email": "john.doe@files.com",
  "details": "Changed Departments",
  "company": "Acme Inc."
}