Get a Requester List

post

https://prod1.serveture.com/public-api/list_requesters/

Returns a list of requesters in the system.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

requester_id_list

array of int32s

A list of requester_ids that you would like to retrieve information about. It may be a list of IDs (such as [1, 5, 7, 100]), or it may also be just a one item list (such as [5]).

requester_id_list

enterprise_id

int32

The unique identifier for an enterprise. If provided, the call will return only those requesters directly linked to the enterprise_id. This parameter is ignored for an Enterprise API User.

branch_id

string

The unique identifier for a branch within a given Marketplace. If provided, the call will return only the requesters linked to the branch. This parameter is used only for a Marketplace API User. If both enterprise_id and branch_id parameters are sent, the latter is ignored.

order_by

object

The order applied to the list. The returned list of requesters can be ordered by any of the specified set of fields.

page_number

int32

The specific page to retrieve within a full list of requesters. If not specified, it defaults to page 1.

page_size

int32

The number of items to display per page. If not specified, it defaults to 25. The minimum page size is 1, and the maximum page size is 100.

system_filters

object

A list of standard system filters that can be applied to the requester list returned.

attrib_filters

object

A list of attributes and their values to filter the returned list of requesters on. Each filter attribute should be a dictionary structured as follows. Note: Requesters who have not submitted any choices or answers for a particular attribute will be excluded from filter results related to that attribute, as no comparison can be made if the attribute does not exist for the requester.

extra_attributes

array of int32s

A list of extra attrib_ids to be included beyond the standard default attributes that are returned for each requester's profile (these are generally the First Name, Last Name, UserName, Vetted Status, and Login Status). The list of possible attribute IDs can be retrieved from the Get Attribute List API call using the Requester Registration realm.

extra_attributes

Headers

Authorization

string

required

Defaults to Token <place token here>

The authorization token returned from the Log In endpoint.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200200

2XX2XX