List Rev Orgs (POST)

POST

Gets the list of Rev organizations’ information belonging to the authenticated user’s Dev Organization which the user is also authorized to access.

Request

This endpoint expects an object.
created_bylist of stringsOptional

Filters by creator.

created_dateobjectOptional
cursorstringOptionalformat: "text"

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

display_namelist of stringsOptional

Array of display names of Rev orgs to be filtered.

external_reflist of stringsOptional

List of external refs to filter Rev organizations for.

limitintegerOptional

The maximum number of Rev organizations to be retrieved per page.

modeenumOptional
Allowed values: afterbefore

The iteration mode to use. If “after”, then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If “before”, then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.

modified_dateobjectOptional
sort_bylist of stringsOptional

Fields to sort the Rev organizations by and the direction to sort them.

Response

The response to getting a list of Rev organizations’ information.

rev_orgslist of objects

List with all of the Rev organizations’ information.

next_cursorstringOptionalformat: "text"

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptionalformat: "text"

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Errors

Update Rev Org
Built with