Custom Table Entry

These endpoints let you manage entries in custom tables in the system. It allows you to retrieve, create, update, and delete custom table entry records.

Get Custom Table Entries

get

Return the custom table entries.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

tableIdstringRequiredExample: d45ee37-92c4-4d76-9838-221ec2364701

Query parameters

querystringOptional

Filter entries based on specific criteria, depending on the custom table's schema.

Example: employeeId:emp-001

pageintegerOptional

Page number

Default: 0Example: 0

sizeinteger · min: 1 · max: 50Optional

Page size

Default: 10Example: 10

Responses

200

Successful operation

application/json

totalPagesintegerRequired

Total number of pages available

lastbooleanRequired

Indicates whether this is the last page

totalElementsintegerRequired

Total number of elements across all pages

numberOfElementsintegerRequired

Number of elements in the current page

firstbooleanRequired

Indicates whether this is the first page

sizeintegerRequired

Size of the page (number of elements per page)

numberintegerRequired

Current page number (zero-indexed)

400

Bad Request

get

/core/v1/custom-tables/{tableId}/entries

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/custom-tables/d45ee37-92c4-4d76-9838-221ec2364701/entries?query=employeeId%3Aemp-001&page=0&size=10" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "d45ee37-92c4-4d76-9838-221ec2364701",
      "certificationName": "AWS Solutions Architect",
      "issueDate": "2025-01-15",
      "employeeId": "emp-001"
    },
    {
      "id": "e56ff38-92c4-4d76-9838-221ec2364702",
      "certificationName": "Professional Scrum Master",
      "issueDate": "2025-02-20",
      "employeeId": "emp-001"
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 2,
  "numberOfElements": 2,
  "sort": [
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Create a new entry in a custom table

post

Creates a new entry in a custom table with the provided details

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

tableIdstringRequiredExample: d45ee37-92c4-4d76-9838-221ec2364701

Body

application/json

Other propertiesanyOptional

Responses

201

Entry created successfully

application/json

400

Bad Request

post

/core/v1/custom-tables/{tableId}/entries

cURLPython SDK

curl -X POST \
  "https://api.catapa.com/core/v1/custom-tables/d45ee37-92c4-4d76-9838-221ec2364701/entries" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{}'

{
  "id": "f67gg49-92c4-4d76-9838-221ec2364703",
  "certificationName": "AWS Certified Developer",
  "issueDate": "2025-03-01",
  "employeeId": "emp-002"
}

Update an entry in a custom table

put

Updates an existing entry in a custom table with the provided details

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

tableIdstringRequiredExample: d45ee37-92c4-4d76-9838-221ec2364701

entryIdstringRequiredExample: d45ee37-92c4-4d76-9838-221ec2364701

Body

application/json

Other propertiesanyOptional

Responses

200

Entry updated successfully

application/json

Other propertiesanyOptional

400

Bad Request

404

Entry not found

put

/core/v1/custom-tables/{tableId}/entries/{entryId}

cURLPython SDK

curl -X PUT \
  "https://api.catapa.com/core/v1/custom-tables/d45ee37-92c4-4d76-9838-221ec2364701/entries/d45ee37-92c4-4d76-9838-221ec2364701" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{}'

{
  "id": "d45ee37-92c4-4d76-9838-221ec2364701",
  "certificationName": "AWS Certified Solutions Architect - Updated",
  "issueDate": "2025-01-15",
  "employeeId": "emp-001"
}