Archive Entity

POST

entities

{id}

archive

Archive Entity

curl --request POST \
  --url https://public.api.serval.com/v2/entities/{id}/archive \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://public.api.serval.com/v2/entities/{id}/archive', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public.api.serval.com/v2/entities/{id}/archive",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://public.api.serval.com/v2/entities/{id}/archive"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/entities/{id}/archive")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "key": "<string>",
    "name": "<string>",
    "teamId": "<string>",
    "entityTypeId": "<string>",
    "entityTypeKey": "<string>",
    "createdByUserId": "<string>",
    "updatedByUserId": "<string>",
    "createdAt": "2025-01-15T01:30:15.000Z",
    "updatedAt": "2025-01-15T01:30:15.000Z",
    "deletedAt": "2025-01-15T01:30:15.000Z",
    "archivedAt": "2025-01-15T01:30:15.000Z",
    "fieldValues": [
      {
        "id": "<string>",
        "entityId": "<string>",
        "fieldId": "<string>",
        "fieldKey": "<string>",
        "fieldName": "<string>",
        "dataType": "DATA_TYPE_UNSPECIFIED",
        "value": 123,
        "setByUserId": "<string>",
        "setByAppInstanceId": "<string>",
        "createdAt": "2025-01-15T01:30:15.000Z",
        "deletedAt": "2025-01-15T01:30:15.000Z",
        "pinned": true,
        "redacted": true,
        "sensitive": true,
        "setByFormula": true
      }
    ],
    "sourceAppInstanceIds": [
      "<string>"
    ],
    "sharedMetadata": {
      "sourceTeamId": "<string>",
      "sourceTeamName": "<string>"
    },
    "sourceApps": [
      {
        "appInstanceId": "<string>",
        "displayName": "<string>",
        "serviceName": "<string>",
        "serviceDisplayName": "<string>",
        "logoUrl": "<string>",
        "domain": "<string>",
        "useIntegratedServiceRegistry": true,
        "isCustom": true
      }
    ]
  },
  "pendingChange": {
    "id": "<string>",
    "entityId": "<string>",
    "entityTypeId": "<string>",
    "operation": "ENTITY_CHANGE_OPERATION_UNSPECIFIED",
    "state": "ENTITY_PENDING_CHANGE_STATE_UNSPECIFIED",
    "entityWorkflowRuleIds": [
      "<string>"
    ],
    "submittedByUserId": "<string>",
    "createdAt": "2025-01-15T01:30:15.000Z",
    "fieldChanges": [
      {
        "fieldId": "<string>",
        "beforeJson": "<string>",
        "afterJson": "<string>",
        "redacted": true,
        "pinned": true
      }
    ],
    "runs": [
      {
        "entityWorkflowRuleId": "<string>",
        "workflowId": "<string>",
        "workflowRunId": "<string>",
        "state": "ENTITY_PENDING_CHANGE_RUN_STATE_UNSPECIFIED"
      }
    ],
    "reason": "<string>"
  }
}

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Workspace-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.

Credential	Access requirements
Organization-scoped API key	`entities:write`
Workspace-scoped API key	`entities:write`
User-based token (OAuth)	Supported, subject to permissions

Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Workspace keys must allow every workspace checked by the request. OAuth access depends on the user’s roles and resource access.

Change a record in a workspace’s database, or in a database shared with one of your workspaces: The permission is checked on the record’s owning workspace, or on a workspace the record’s database is shared with; Read alone admits no changes. A record in a database not shared with one of your workspaces is refused. Update requires Update access; archive and unarchive require Delete access. Database, table, field and record conditions still apply.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

The ID of the entity to archive. Allowed in its owning workspace or through a workspace its database is shared with at "Can write".

Response

200 - application/json

Success

data

data · object

Show child attributes

pendingChange

EntityPendingChange · object | null

Show child attributes

Archive Entity

curl --request POST \
  --url https://public.api.serval.com/v2/entities/{id}/archive \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://public.api.serval.com/v2/entities/{id}/archive', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public.api.serval.com/v2/entities/{id}/archive",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://public.api.serval.com/v2/entities/{id}/archive"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/entities/{id}/archive")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "key": "<string>",
    "name": "<string>",
    "teamId": "<string>",
    "entityTypeId": "<string>",
    "entityTypeKey": "<string>",
    "createdByUserId": "<string>",
    "updatedByUserId": "<string>",
    "createdAt": "2025-01-15T01:30:15.000Z",
    "updatedAt": "2025-01-15T01:30:15.000Z",
    "deletedAt": "2025-01-15T01:30:15.000Z",
    "archivedAt": "2025-01-15T01:30:15.000Z",
    "fieldValues": [
      {
        "id": "<string>",
        "entityId": "<string>",
        "fieldId": "<string>",
        "fieldKey": "<string>",
        "fieldName": "<string>",
        "dataType": "DATA_TYPE_UNSPECIFIED",
        "value": 123,
        "setByUserId": "<string>",
        "setByAppInstanceId": "<string>",
        "createdAt": "2025-01-15T01:30:15.000Z",
        "deletedAt": "2025-01-15T01:30:15.000Z",
        "pinned": true,
        "redacted": true,
        "sensitive": true,
        "setByFormula": true
      }
    ],
    "sourceAppInstanceIds": [
      "<string>"
    ],
    "sharedMetadata": {
      "sourceTeamId": "<string>",
      "sourceTeamName": "<string>"
    },
    "sourceApps": [
      {
        "appInstanceId": "<string>",
        "displayName": "<string>",
        "serviceName": "<string>",
        "serviceDisplayName": "<string>",
        "logoUrl": "<string>",
        "domain": "<string>",
        "useIntegratedServiceRegistry": true,
        "isCustom": true
      }
    ]
  },
  "pendingChange": {
    "id": "<string>",
    "entityId": "<string>",
    "entityTypeId": "<string>",
    "operation": "ENTITY_CHANGE_OPERATION_UNSPECIFIED",
    "state": "ENTITY_PENDING_CHANGE_STATE_UNSPECIFIED",
    "entityWorkflowRuleIds": [
      "<string>"
    ],
    "submittedByUserId": "<string>",
    "createdAt": "2025-01-15T01:30:15.000Z",
    "fieldChanges": [
      {
        "fieldId": "<string>",
        "beforeJson": "<string>",
        "afterJson": "<string>",
        "redacted": true,
        "pinned": true
      }
    ],
    "runs": [
      {
        "entityWorkflowRuleId": "<string>",
        "workflowId": "<string>",
        "workflowRunId": "<string>",
        "state": "ENTITY_PENDING_CHANGE_RUN_STATE_UNSPECIFIED"
      }
    ],
    "reason": "<string>"
  }
}

Get started

Authentication

Endpoints

Development

Authentication and permissions

Authorizations

Path Parameters

Response

​Authentication and permissions

Authorizations

Path Parameters

Response

Authentication and permissions