Search Request

Search Request

get

Use the following parameters to search requests.

Authorizations
X-Ledger-API-KeystringRequired

If you've set up your API Key when initializing your LAM, you'll need to include it as a header along with the api user header. For more details, see step 5 of the get started documentation.

X-Ledger-API-UserstringRequired

(required) Username of a registered API User

Query parameters
approved_byinteger · nullableOptional

Returns requests which have been approved by the specified user.

Default: nullExample: 42
created_afterstring · date-time · nullableOptional

Returns objects created after the entered date.

Default: nullExample: 2020-09-12T14:15:22Z
created_beforestring · date-time · nullableOptional

Returns objects created before the entered date.

Default: nullExample: 2020-12-13T16:17:28Z
created_byinteger · nullableOptional

Returns requests which have been created by the specified user.

Default: nullExample: 42
idinteger · nullableOptional

Returns the object corresponding to the entered ID

Default: null
orderstring · enum · nullableOptional

Orders the list of results

Default: nullExample: descPossible values:
order_bystring · nullableOptional

criteria to order by

Default: nullExample: name
pageinteger · min: 1 · nullableOptional

Defines the page number to be fetched.

Default: 1Example: 3
page_sizeinteger · min: -1 · nullableOptional

Defines the number of elements displayed on a page. Must be a positive number with 0 and -1 return a maximum defined in the gate

Default: 20Example: 40
pending_byinteger · nullableOptional

Returns requests which are pending the specified user's approval.

Default: nullExample: 42
rejected_byinteger · nullableOptional

Returns requests which have been rejected by the specified user.

Default: nullExample: 42
target_idinteger · nullableOptional

Search by ID of the target object.

Default: null
Responses
chevron-right
200

Request search results

application/json
get
/requests

Last updated