API Referencerev-orgs

List Rev Orgs (POST)

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

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
accountlist of stringsOptional
Filters by account.
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.
custom_field_filterlist of stringsOptional

Filters on custom fields. Input will be of the format (custom_field_filter=field_name1:val1,val2,val3&custom_field_filter=field_name2:val1,val2).

custom_fieldsobjectOptional
Filters for custom fields.
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

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.

Allowed values:
modified_dateobjectOptional
sort_bylist of stringsOptional
Fields to sort the Rev organizations by and the direction to sort them.
tagslist of stringsOptional
List of tags to be filtered.

Response

The response to getting a list of Rev organizations' information.
rev_orgslist of objects
List with all of the Rev organizations' information.
next_cursorstring or nullformat: "text"
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursorstring or nullformat: "text"
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Errors