Rev orgs

List Rev Orgs

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

GET
/rev-orgs.list
AuthorizationBearer <token>

All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request. How do I find my token?

In: header

Query Parameters

account?array<string>

Filters by account.

created_by?array<string>

Filters by creator.

created_date.after?string

Filters for objects created after the provided timestamp (inclusive).

Formatdate-time
created_date.before?string

Filters for objects created before the provided timestamp (inclusive).

Formatdate-time
cursor?string

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

Formattext
custom_field_filter?array<string>

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?object

Filters for custom fields.

Empty Object

display_name?array<string>

Array of display names of Rev orgs to be filtered.

external_ref?array<string>

List of external refs to filter Rev organizations for.

limit?integer

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

Formatint32
mode?string

The iteration mode to use, otherwise if not set, then "after" is used.

Value in"after" | "before"
modified_date.after?string

Filters for objects created after the provided timestamp (inclusive).

Formatdate-time
modified_date.before?string

Filters for objects created before the provided timestamp (inclusive).

Formatdate-time
sort_by?array<string>

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

tags?array<string>

List of tags to be filtered.

Response Body

curl -X GET "https://api.devrev.ai/rev-orgs.list?account=ACC-12345&created_by=string&created_date.after=2023-01-01T12%3A00%3A00.000Z&created_date.before=2023-01-01T12%3A00%3A00.000Z&cursor=string&custom_field_filter=string&custom_fields=&display_name=string&external_ref=string&limit=0&mode=after&modified_date.after=2023-01-01T12%3A00%3A00.000Z&modified_date.before=2023-01-01T12%3A00%3A00.000Z&sort_by=string&tags=string"
{
  "next_cursor": "string",
  "prev_cursor": "string",
  "rev_orgs": [
    {
      "created_by": {
        "type": "dev_user",
        "display_id": "string",
        "id": "string",
        "display_name": "string",
        "display_picture": {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        },
        "email": "string",
        "full_name": "string",
        "state": "active"
      },
      "created_date": "2023-01-01T12:00:00.000Z",
      "display_id": "string",
      "id": "string",
      "modified_by": {
        "type": "dev_user",
        "display_id": "string",
        "id": "string",
        "display_name": "string",
        "display_picture": {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        },
        "email": "string",
        "full_name": "string",
        "state": "active"
      },
      "modified_date": "2023-01-01T12:00:00.000Z",
      "display_name": "string",
      "account": {
        "display_id": "string",
        "id": "string",
        "display_name": "string"
      },
      "artifacts": [
        {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        }
      ],
      "custom_fields": {},
      "custom_schema_fragments": [
        "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"
      ],
      "description": "string",
      "domain": "string",
      "external_ref": "string",
      "primary_rev_org": {
        "type": "account",
        "display_id": "string",
        "id": "string",
        "display_name": "string"
      },
      "stock_schema_fragment": "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id",
      "subtype": "string",
      "tags": [
        {
          "tag": {
            "display_id": "string",
            "id": "string",
            "name": "string",
            "style_new": {
              "color": "string"
            }
          },
          "value": "string"
        }
      ]
    }
  ]
}
{
  "detail": "string",
  "message": "string",
  "type": "artifact_already_attached_to_a_parent",
  "existing_parent": "string",
  "is_same": true
}
{
  "detail": "string",
  "message": "string",
  "type": "unauthenticated"
}
{
  "detail": "string",
  "message": "string",
  "type": "forbidden"
}
{
  "detail": "string",
  "message": "string",
  "type": "not_found"
}
{
  "detail": "string",
  "message": "string",
  "type": "too_many_requests",
  "retry_after": 0
}
{
  "detail": "string",
  "message": "string",
  "type": "internal_error",
  "reference_id": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "service_unavailable"
}