Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Workday Extend Custom Object Definitions API

Operations for defining and managing custom object types including their schemas, attributes, and relationships to standard Workday objects.

Workday Extend Custom Object Definitions API is one of 16 APIs that Workday Extend publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Custom Object Definitions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and an API reference.

This API exposes 5 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://{baseUrl}/api/customObjects/v1/{tenant}.

5 operations 2 paths 6 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://api.workday.com/extend/v1
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Workday Extend Custom Object Definitions API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 2 scopes. By default, every request must be authenticated.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Custom Object Definitions 5

Operations for defining and managing custom object types including their schemas, attributes, and relationships to standard Workday objects.

GET
/customObjectDefinitions
Workday Extend List custom object definitions
listCustomObjectDefinitions 3 params → 200401403
POST
/customObjectDefinitions
Workday Extend Create a custom object definition
createCustomObjectDefinition body → 201400401403
GET
/customObjectDefinitions/{definitionId}
Workday Extend Retrieve a custom object definition
getCustomObjectDefinition 1 param → 200401403404
PATCH
/customObjectDefinitions/{definitionId}
Workday Extend Update a custom object definition
updateCustomObjectDefinition 1 param body → 200400401403404
DELETE
/customObjectDefinitions/{definitionId}
Workday Extend Delete a custom object definition
deleteCustomObjectDefinition 1 param → 204401403404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are CustomObjectDefinition (11 properties), CustomObjectField (10 properties), CustomObjectFieldCreate (7 properties), CustomObjectDefinitionCreate (5 properties). Each schema is shown below with its type and property counts.

CustomObjectField
object
10 properties
CustomObjectDefinition
object
11 properties
CustomObjectFieldCreate
object
7 properties 2 required
CustomObjectDefinitionUpdate
object
2 properties
ErrorResponse
object
2 properties
CustomObjectDefinitionCreate
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workday-extend-custom-object-definitions-api-openapi.yml Raw ↑

Other APIs Workday Extend publishes across the network.

Workday Orchestrate Insights API
Workday Illuminate AI API
Workday Extend App Configurations API
Workday Extend App Deployments API
Workday Extend App Versions API
Workday Extend Apps API
Workday Extend Custom Object Fields API
Workday Extend Custom Object Instances API
Workday Extend Graph Query API
Workday Extend Orchestration Executions API
Workday Extend Orchestration Steps API
Workday Extend Orchestration Triggers API