Accounts

Export Accounts (POST)

Exports a collection of accounts.

POST
/accounts.export

Exports a collection of accounts.

Authorization

auth-token

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

application/json

created_by?array<string>

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

created_date?
display_name?array<string>

Array of display names of accounts to be filtered.

external_refs?array<string>

Array of references of accounts to be filtered.

first?integer

The number of accounts to return. The default is '50'.

Formatint32
Range1 <= value <= 500
modified_date?
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.

tier?array<string>

Tier of the accounts to be filtered.

websites?array<string>

Array of websites of accounts to be filtered.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.devrev.ai/accounts.export" \  -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",
      "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"
      },
      "tier": "string",
      "websites": [
        "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": "too_many_requests",
  "retry_after": 0
}
{
  "detail": "string",
  "message": "string",
  "type": "internal_error",
  "reference_id": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "service_unavailable"
}

Delete Account POST

Deletes an account.

Export Accounts GET

Exports a collection of accounts.