Get Projects with Email Access

Returns the projects where the calling user has email access. By default (access=file), the response contains the projects where the user can file emails. With access=view, the response also contains the projects where the user can only view emails. The project email settings (domain and team restrictions) apply in both cases.

Without pageSize or projectIds, the response contains all the projects, in one page. Set pageSize to get one page of projects, sorted by name. offset, search and sortDirection also require pageSize. Set projectIds to get only the given projects, in one page. projectIds cannot be used with pageSize, offset, search or sortDirection. An invalid or repeated query parameter returns a 400.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The hub identifier.

Query Params
string
enum
Defaults to file

The email access to check. With file (the default), the response contains the projects where the user can file emails. With view, the response contains the projects where the user can view or file emails.

Allowed:
integer
1 to 100

The maximum number of projects to read for the page. The page can contain fewer items, because projects without email access are removed. Required when offset, search or sortDirection is set.

integer
0 to 2147483547
Defaults to 0

The number of projects to skip. Use the nextOffset of the previous page.

Words to find in the project name or number. Each word must match. Must not contain control characters.

string
enum
Defaults to asc

The sort direction of the projects, by name.

Allowed:
string

A comma-separated list of up to 100 project IDs. The response contains only these projects, if the user has email access to them.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json