rev-orgs

List 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.
account
list of stringsOptional
Filters by account.
created_by
list of stringsOptional
Filters by creator.
created_date
objectOptional
cursor
stringOptional
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
custom_field_filter
list 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_fields
map from strings to anyOptional
Filters for custom fields.
display_name
list of stringsOptional
Array of display names of Rev orgs to be filtered.
external_ref
list of stringsOptional
List of external refs to filter Rev organizations for.
limit
integerOptional
The maximum number of Rev organizations to be retrieved per page.
mode
enumOptional
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: afterbefore
modified_date
objectOptional
sort_by
list of stringsOptional
Fields to sort the Rev organizations by and the direction to sort them.
tags
list of stringsOptional
List of tags to be filtered.

Response

This endpoint returns an object
rev_orgs
list of objects
List with all of the Rev organizations' information.
next_cursor
stringOptional
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursor
stringOptional
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.
POST
1curl -X POST https://api.devrev.ai/rev-orgs.list \
2     -H "Authorization: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{}'
200
Successful
1{
2  "rev_orgs": [
3    {
4      "id": "id",
5      "account": {
6        "id": "id"
7      },
8      "artifacts": [
9        {
10          "id": "id"
11        }
12      ],
13      "created_date": "2023-01-01T12:00:00Z",
14      "custom_schema_fragments": [
15        "custom_schema_fragments"
16      ],
17      "description": "description",
18      "display_id": "display_id",
19      "display_name": "display_name",
20      "domain": "domain",
21      "external_ref": "external_ref",
22      "modified_date": "2023-01-01T12:00:00Z",
23      "stock_schema_fragment": "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>",
24      "subtype": "subtype",
25      "tags": [
26        {
27          "tag": {
28            "id": "id",
29            "name": "name"
30          }
31        }
32      ]
33    }
34  ],
35  "next_cursor": "next_cursor",
36  "prev_cursor": "prev_cursor"
37}
Built with