Accounts

List Accounts (POST)

Gets a list of accounts.

POST
/accounts.list

Authorization

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

Request Body

created_by?array<string>

Filters for accounts created by the specified user(s).

created_date?date-time-filter
cursor?string

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

Formattext
custom_fields?object

Filters for custom fields.

Empty Object

display_name?array<string>

Array of display names of accounts to be filtered.

domains?array<string>

Domains for accounts to be filtered.

external_refs?array<string>

Array of references of accounts to be filtered.

limit?integer

The maximum number of accounts to return per page. The default is '50'.

Formatint32
mode?list-mode

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.

Value in"after" | "before"
modified_date?date-time-filter
owned_by?array<string>

Filters for accounts owned by the specified user(s).

sort_by?array<string>

Fields to sort the accounts by and the direction to sort them in.

stage?array<string>

Filters for accounts on specified stages.

subtype?array<string>

Subtypes of the accounts to be filtered.

tags?array<string>

List of tags to be filtered.

tier?array<string>

Tier of the accounts to be filtered.

websites?array<string>

Array of websites of accounts to be filtered.

Response Body

curl -X POST "https://api.devrev.ai/accounts.list" \  -H "Content-Type: application/json" \  -d '{}'
{
  "accounts": [
    {
      "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",
      "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",
      "domains": [
        "string"
      ],
      "external_refs": [
        "string"
      ],
      "owned_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"
        }
      ],
      "primary_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"
        }
      ],
      "tier": "string",
      "websites": [
        "string"
      ]
    }
  ],
  "next_cursor": "string",
  "prev_cursor": "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"
}