Saved Views & Filters | VivreCRM API

List saved views

GET/api/v1/saved_views/

Response fields 9

idstring (uuid)
namestring
scopeenum
entityenum
configobject
created_byobject
can_editobject
created_atstring (date-time)
updated_atstring (date-time)

curl "https://api.vivrecrm.com/api/v1/saved_views/" \
  -H "X-Api-Key: $VIVRE_API_KEY"

import os, requests

resp = requests.get(
    "https://api.vivrecrm.com/api/v1/saved_views/",
    headers={"X-Api-Key": os.environ["VIVRE_API_KEY"]},
)
print(resp.json())

const resp = await fetch("https://api.vivrecrm.com/api/v1/saved_views/", {
  method: "GET",
  headers: {
    "X-Api-Key": process.env.VIVRE_API_KEY,
  },
});
console.log(await resp.json());

Response 200

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "name": "Kaveri Foods",
      "scope": "personal",
      "entity": "lead",
      "config": {},
      "created_by": null,
      "can_edit": null,
      "created_at": "2026-10-17T09:30:00+05:30",
      "updated_at": "2026-10-17T09:30:00+05:30"
    }
  ]
}

Create saved view

POST/api/v1/saved_views/

Body

namestringRequired
scopeenum: One of personal, org.
configobject

Response fields 9

idstring (uuid)
namestring
scopeenum
entityenum
configobject
created_byobject
can_editobject
created_atstring (date-time)
updated_atstring (date-time)

curl -X POST "https://api.vivrecrm.com/api/v1/saved_views/" \
  -H "X-Api-Key: $VIVRE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Kaveri Foods"}'

import os, requests

resp = requests.post(
    "https://api.vivrecrm.com/api/v1/saved_views/",
    headers={"X-Api-Key": os.environ["VIVRE_API_KEY"]},
    json={
      "name": "Kaveri Foods"
    },
)
print(resp.json())

const resp = await fetch("https://api.vivrecrm.com/api/v1/saved_views/", {
  method: "POST",
  headers: {
    "X-Api-Key": process.env.VIVRE_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Kaveri Foods"
  }),
});
console.log(await resp.json());

Response 201

{
  "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "name": "Kaveri Foods",
  "scope": "personal",
  "entity": "lead",
  "config": {},
  "created_by": null,
  "can_edit": null,
  "created_at": "2026-10-17T09:30:00+05:30",
  "updated_at": "2026-10-17T09:30:00+05:30"
}

Retrieve

GET/api/v1/saved_views/{public_id}/

Parameters

public_idpath, stringRequired: The record's public id (a UUID).

Response fields 9

idstring (uuid)
namestring
scopeenum
entityenum
configobject
created_byobject
can_editobject
created_atstring (date-time)
updated_atstring (date-time)

curl "https://api.vivrecrm.com/api/v1/saved_views/7c9e6679-7425-40de-944b-e07fc1f90ae7/" \
  -H "X-Api-Key: $VIVRE_API_KEY"

import os, requests

resp = requests.get(
    "https://api.vivrecrm.com/api/v1/saved_views/7c9e6679-7425-40de-944b-e07fc1f90ae7/",
    headers={"X-Api-Key": os.environ["VIVRE_API_KEY"]},
)
print(resp.json())

const resp = await fetch("https://api.vivrecrm.com/api/v1/saved_views/7c9e6679-7425-40de-944b-e07fc1f90ae7/", {
  method: "GET",
  headers: {
    "X-Api-Key": process.env.VIVRE_API_KEY,
  },
});
console.log(await resp.json());

Response 200

{
  "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "name": "Kaveri Foods",
  "scope": "personal",
  "entity": "lead",
  "config": {},
  "created_by": null,
  "can_edit": null,
  "created_at": "2026-10-17T09:30:00+05:30",
  "updated_at": "2026-10-17T09:30:00+05:30"
}

Replace (full update; PATCH for partial)

PUT/api/v1/saved_views/{public_id}/

Parameters

public_idpath, stringRequired: The record's public id (a UUID).

Body

namestringRequired
scopeenum: One of personal, org.
configobject

Response fields 9

idstring (uuid)
namestring
scopeenum
entityenum
configobject
created_byobject
can_editobject
created_atstring (date-time)
updated_atstring (date-time)

curl -X PUT "https://api.vivrecrm.com/api/v1/saved_views/7c9e6679-7425-40de-944b-e07fc1f90ae7/" \
  -H "X-Api-Key: $VIVRE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Kaveri Foods"}'

import os, requests

resp = requests.put(
    "https://api.vivrecrm.com/api/v1/saved_views/7c9e6679-7425-40de-944b-e07fc1f90ae7/",
    headers={"X-Api-Key": os.environ["VIVRE_API_KEY"]},
    json={
      "name": "Kaveri Foods"
    },
)
print(resp.json())

const resp = await fetch("https://api.vivrecrm.com/api/v1/saved_views/7c9e6679-7425-40de-944b-e07fc1f90ae7/", {
  method: "PUT",
  headers: {
    "X-Api-Key": process.env.VIVRE_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Kaveri Foods"
  }),
});
console.log(await resp.json());

Response 200

{
  "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "name": "Kaveri Foods",
  "scope": "personal",
  "entity": "lead",
  "config": {},
  "created_by": null,
  "can_edit": null,
  "created_at": "2026-10-17T09:30:00+05:30",
  "updated_at": "2026-10-17T09:30:00+05:30"
}

Update

PATCH/api/v1/saved_views/{public_id}/

Parameters

public_idpath, stringRequired: The record's public id (a UUID).

Body

namestringRequired
scopeenum: One of personal, org.
configobject

Response fields 9

idstring (uuid)
namestring
scopeenum
entityenum
configobject
created_byobject
can_editobject
created_atstring (date-time)
updated_atstring (date-time)

curl -X PATCH "https://api.vivrecrm.com/api/v1/saved_views/7c9e6679-7425-40de-944b-e07fc1f90ae7/" \
  -H "X-Api-Key: $VIVRE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Kaveri Foods"}'

import os, requests

resp = requests.patch(
    "https://api.vivrecrm.com/api/v1/saved_views/7c9e6679-7425-40de-944b-e07fc1f90ae7/",
    headers={"X-Api-Key": os.environ["VIVRE_API_KEY"]},
    json={
      "name": "Kaveri Foods"
    },
)
print(resp.json())

const resp = await fetch("https://api.vivrecrm.com/api/v1/saved_views/7c9e6679-7425-40de-944b-e07fc1f90ae7/", {
  method: "PATCH",
  headers: {
    "X-Api-Key": process.env.VIVRE_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Kaveri Foods"
  }),
});
console.log(await resp.json());

Response 200

{
  "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "name": "Kaveri Foods",
  "scope": "personal",
  "entity": "lead",
  "config": {},
  "created_by": null,
  "can_edit": null,
  "created_at": "2026-10-17T09:30:00+05:30",
  "updated_at": "2026-10-17T09:30:00+05:30"
}

Delete

DELETE/api/v1/saved_views/{public_id}/

Parameters

public_idpath, stringRequired: The record's public id (a UUID).

curl -X DELETE "https://api.vivrecrm.com/api/v1/saved_views/7c9e6679-7425-40de-944b-e07fc1f90ae7/" \
  -H "X-Api-Key: $VIVRE_API_KEY"

import os, requests

resp = requests.delete(
    "https://api.vivrecrm.com/api/v1/saved_views/7c9e6679-7425-40de-944b-e07fc1f90ae7/",
    headers={"X-Api-Key": os.environ["VIVRE_API_KEY"]},
)
print(resp.status_code)

const resp = await fetch("https://api.vivrecrm.com/api/v1/saved_views/7c9e6679-7425-40de-944b-e07fc1f90ae7/", {
  method: "DELETE",
  headers: {
    "X-Api-Key": process.env.VIVRE_API_KEY,
  },
});
console.log(resp.status);

Copy a view

POST/api/v1/saved_views/{public_id}/copy/

A new view with the same setup, owned by whoever copies it. Members copy into a personal view only; owners and admins into either. Viewers copy nothing (403). The name must be free (400).

Parameters

public_idpath, stringRequired: The record's public id (a UUID).

Body

namestringRequired
scopeenum: One of personal, org.

Response fields 9

idstring (uuid)
namestring
scopeenum
entityenum
configobject
created_byobject
can_editobject
created_atstring (date-time)
updated_atstring (date-time)

curl -X POST "https://api.vivrecrm.com/api/v1/saved_views/7c9e6679-7425-40de-944b-e07fc1f90ae7/copy/" \
  -H "X-Api-Key: $VIVRE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Kaveri Foods"}'

import os, requests

resp = requests.post(
    "https://api.vivrecrm.com/api/v1/saved_views/7c9e6679-7425-40de-944b-e07fc1f90ae7/copy/",
    headers={"X-Api-Key": os.environ["VIVRE_API_KEY"]},
    json={
      "name": "Kaveri Foods"
    },
)
print(resp.json())

const resp = await fetch("https://api.vivrecrm.com/api/v1/saved_views/7c9e6679-7425-40de-944b-e07fc1f90ae7/copy/", {
  method: "POST",
  headers: {
    "X-Api-Key": process.env.VIVRE_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Kaveri Foods"
  }),
});
console.log(await resp.json());

Response 201

{
  "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "name": "Kaveri Foods",
  "scope": "personal",
  "entity": "lead",
  "config": {},
  "created_by": null,
  "can_edit": null,
  "created_at": "2026-10-17T09:30:00+05:30",
  "updated_at": "2026-10-17T09:30:00+05:30"
}