API docs by Redocly

Workday Strategic Sourcing Events API (1.2)

Download OpenAPI specification:

Customer Support

We've provided detailed documentation below to guide you. However, if you need additional assistance, here's how you can get the support you need:

  • Community Discussions: Join the conversation on our Workday Community Discussion Boards (found under the "Collaborate" section in community). Connect with other users, share best practices, and get answers to your configuration questions.
  • Expert Configuration Assistance (Professional Services): For tailored, hands-on support with your specific project, our Professional Services team is available.
    • Looking for personalized guidance? Workday Success Plan customers can submit an "Ask" for expert insights on configuration and best practices.
    • Need custom solutions? Consider Expert Assist, our consulting service for detailed changes and project support.
  • Reporting System Issues: If you suspect a problem with the Workday system itself, please connect with our dedicated support team. Your company's Named Support Contact (NSC) can log a Product Support Defect case. We'll review the issue based on its impact and Workday's service level agreement (SLA).

API Specification

The API conforms to the JSON API Specification.

The current version of this service is indicated by the X-Api-Version header.

Sample version header: X-Api-Version: 1.2.

Date and Time Fields

Our API adheres to the ISO 8601 standard when accepting and formatting Date and Time fields. All Date and Time fields returned by this API will be in the UTC timezone.

Date and Time fields sent to this API can be in any timezone, provided they adhere to the ISO 8601 standard.

Authentication

The Workday Strategic Sourcing API uses API keys to authenticate requests. Every request will require all 3 HTTP headers:

HTTP Header Description
X-Api-Key a company-wide API key
X-User-Token a user-specific API token
X-User-Email user email

You can generate all of those from the API tokens section of your Profile page.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Rate Limiting

Rate limit windows are per second and are shared by all API Keys for a company.

The rate limit is 5 requests per second.

When request submissions exceed the limits, the limit-exceeding requests return 429 Too Many Requests error responses to the client.

Upon receiving a 429 response, it is recommended to retry the request in compliance with the rate limit. One example would be to add a sleep function for 1 second and retry.

External Identifiers (IDs)

The external_id field exists on many of the Workday Strategic Sourcing resources. This optional and mutable extension is intended to store foreign keys of the corresponding resource from a third party system. These IDs are not considered Sourcing Data and may be logged in external systems. Do not include any sensitive or personal data in IDs.

The purpose of external IDs is to:

  • Prevent duplicate record creation
  • Allow resources in Workday Strategic Sourcing and a third party system to share the same identifier
  • Allow for records to be queried or updated without requiring knowledge of the Workday Strategic Sourcing generated IDs

Pagination

Paginated endpoints may return a subset of the total results for a GET request that returns multiple resources. Endpoints that support pagination will include usage details in the Query Parameters section for the resource.

The paginated results can be configured using the page query parameter to configure the number of returned results. The default pagination size is 10 results and the maximum pagination size is 100 results per request.

Endpoints that support pagination may return "self" and "next" sections within the "links" section that navigate to the current and next pages respectively.

Example Paginated Request

Request Query Parameter Format

/projects?page[size]=25

Response Schema

The paginated response will also include the following schema

object

Result set metadata.

object (PaginationLinks)

List of related links.

null

Filters

The results can be filtered to a subset of the total set of results using filter query parameters.

Endpoints that support filtering will include usage details in the Query Parameters section for the resource.

Most filters that end in equals support a Query Parameter array format to filter by multiple values.

Example:

?filter[status_equals][]=submitted&filter[status_equals][]=resubmitted

Events

Use the events API to create, update, and query the events in Workday Strategic Sourcing.

Event Object

type
required
string (EventType)

Object type, should always be events.

id
required
integer (EventId)

Event identifier string.

object (EventAttributes)

Event attributes.

object (EventRelationship)

Event relationships.

object (ResourceLinks)

List of related links.

{
  • "id": "1",
  • "type": "events",
  • "attributes": {
    },
  • "relationships": {
    },
  • "links": {}
}

List Events

Returns a list of events for the specified criteria.

Authorizations:
(api_keyuser_tokenuser_email)
query Parameters
object (EventInputFilter)

Filter events by multiple criteria. Only one filter per attribute is supported. For best performance, we recommend 5 or less filters.

object (PageInput)

Customize pagination results with size.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/events/v1/events"

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ],
  • "links": {}
}

Create an Event

Events can only be created from a template. When a creation request is issued, the base event object will be created from the template and returned with the response. Child records such as attachments, price sheets and custom values, will be scheduled for copy asynchronously. Current duplication status can be retrieved from the duplication_state attribute, which will have one of following values:

  • scheduled - duplication is scheduled, but not yet started;
  • started - duplication started, but not yet finished;
  • finished - duplication completed;
  • failed - there was an error duplicating relationships.

An event should always have an associated project. Please make sure to specify it as a relationship object.

A new event will automatically inherit its spend category from the event template.

Please note, this endpoint does not support auction creation/duplication.

Authorizations:
(api_keyuser_tokenuser_email)
Request Body schema: application/vnd.api+json
object (EventCreate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Get an Event

Retrieves the details of an existing event. You need to supply the unique event identifier that was returned upon event creation.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique Event identifier.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/events/v1/events/1"

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update an Event

Updates the details of an existing event. You need to supply the unique identifier that was returned upon event creation.

Please note, that request body must include an id attribute with the value of your event unique identifier (the same one you passed in the URL).

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique Event identifier.

Request Body schema: application/vnd.api+json
object (EventUpdate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete an Event

Deletes an event. You need to supply the unique event identifier that was returned upon event creation.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique Event identifier.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     -X DELETE \
     "https://api.us.workdayspend.com/services/events/v1/events/1"

Describe Event Object

Returns the list of fields for the event object.

Authorizations:
(api_keyuser_tokenuser_email)

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/events/v1/events/describe"

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": { },
  • "meta": {
    }
}

Event Supplier Companies

Use the event supplier companies API to manage event suppliers.

Add Suppliers

Add suppliers to an event. Only events of type RFP are supported.

The operation will be rolled back upon any failure, and invitations won't be sent.

For best performance, we recommend inviting 10 or less suppliers in a single request.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
event_id
required
integer
Example: 1

Event identifier.

Request Body schema: application/vnd.api+json
Array of objects (SupplierCompany)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Remove Suppliers

Remove suppliers from an event. Only events of type RFP are supported.

The operation will be rolled back upon any failure, and invitations won't be removed.

For best performance, we recommend removing 10 or less suppliers in a single request.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
event_id
required
integer
Example: 1

Event identifier.

Request Body schema: application/vnd.api+json
object (SupplierCompany)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Add Suppliers using External IDs

Add suppliers to an event. Only events of type RFP are supported.

You must supply the unique event external identifier (the one you used when created the event).

You must supply the external identifiers of the supplier companies too.

The operation will be rolled back upon any failure, and invitations won't be sent.

For best performance, we recommend inviting 10 or less suppliers in a single request.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
event_external_id
required
string
Example: EVENT1

Event external identifier.

Request Body schema: application/vnd.api+json
Array of objects (ExternalSupplierCompany)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Remove Suppliers using External IDs

Remove suppliers from an event. Only events of type RFP are supported.

You must supply the unique event external identifier (the one you used when created the event).

You must supply the external identifiers of the supplier companies too.

The operation will be rolled back upon any failure, and invitations won't be removed.

For best performance, we recommend removing 10 or less suppliers in a single request.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
event_external_id
required
string
Example: EVENT1

Event external identifier.

Request Body schema: application/vnd.api+json
Array of objects (ExternalSupplierCompany)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Event Supplier Contacts

Use the event supplier contacts API to manage event suppliers. This API provides 2 advantages over the event supplier companies APIs:

  • It allows specifying the supplier contact to be associated/removed from an event.
  • It allows specifying multiple contacts for a given supplier.

Add Suppliers using Contacts

Add suppliers to an event using supplier contacts. Only events of type RFP are supported.

For best performance, we recommend inviting 10 or less supplier contacts in a single request.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
event_id
required
integer
Example: 1

Event identifier.

Request Body schema: application/vnd.api+json
Array of objects (SupplierContact)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Remove Suppliers using Contacts

Remove suppliers from an event using supplier contacts. Only events of type RFP are supported.

For best performance, we recommend removing 10 or less supplier contacts in a single request.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
event_id
required
integer
Example: 1

Event identifier.

Request Body schema: application/vnd.api+json
Array of objects (SupplierContact)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Add Suppliers using Contacts External IDs

Add suppliers to an event using supplier contacts. Only events of type RFP are supported.

You must supply the unique event external identifier (the one you used when created the event).

You must supply the external identifiers of the supplier contacts too.

The operation will be rolled back upon any failure, and invitations won't be sent.

For best performance, we recommend inviting 10 or less supplier contacts in a single request.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
event_external_id
required
string
Example: EVENT1

Event external identifier.

Request Body schema: application/vnd.api+json
Array of objects (ExternalSupplierContact)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Remove Suppliers using Contacts External IDs

Remove suppliers from an event using supplier contacts. Only events of type RFP are supported.

You must supply the unique event external identifier (the one you used when created the event).

You must supply the external identifiers of the supplier contacts too.

The operation will be rolled back upon any failure, and invitations won't be removed.

For best performance, we recommend removing 10 or less supplier contacts in a single request.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
event_external_id
required
integer
Example: 1

Event external identifier.

Request Body schema: application/vnd.api+json
Array of objects (ExternalSupplierContact)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Event Templates

Use the contract types API to query the event templates in Workday Strategic Sourcing.

Event Templates are used as a blueprint for newly created events.

Event Template Object

type
required
string (EventTemplateType)

Object type, should always be event_templates.

id
required
integer (EventTemplateId)

Event template identifier string.

object (EventTemplateAttributes)

Event template attributes.

object (ResourceLinks)

List of related links.

{
  • "type": "event_templates",
  • "id": 1,
  • "attributes": {
    },
  • "links": {
    }
}

List Event Templates

Returns a list of all event templates.

Authorizations:
(api_keyuser_tokenuser_email)

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/events/v1/event_templates"

Response samples

Content type
application/vnd.api+json
{}

Get an Event Template

Retrieves the details of an existing event template.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique event template identifier.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/events/v1/event_templates/1"

Response samples

Content type
application/vnd.api+json
{}

Worksheets

Use the worksheets API to create, update, and query the worksheets in Workday Strategic Sourcing.

Worksheet Object

type
required
string (WorksheetType)

Object type, should always be worksheets.

id
required
integer (WorksheetId)

Worksheet identifier string.

object (WorksheetAttributes)

Worksheet attributes.

object (ResourceLinks)

List of related links.

{
  • "type": "worksheets",
  • "id": 1,
  • "attributes": {
    },
  • "links": {
    }
}

List Worksheets

Returns a list of all worksheets.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
event_id
required
integer
Example: 1

Event identifier.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/events/v1/events/1/worksheets"

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ],
  • "links": {}
}

Get a Worksheet

Retrieves the details of an existing worksheet. You need to supply the unique worksheet identifier that was returned upon worksheet creation.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
event_id
required
integer
Example: 1

Event identifier.

id
required
integer
Example: 1

Unique Worksheet identifier.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/events/v1/events/1/worksheets/1"

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Describe Worksheet object

Returns a list of fields for the worksheet object.

Authorizations:
(api_keyuser_tokenuser_email)

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/events/v1/worksheets/describe"

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ],
  • "links": { }
}

Line Items

Use the line items API to create, update, and query the worksheet line items in Workday Strategic Sourcing.

Line Item Object

type
required
string (LineItemType)

Object type, should always be line_items.

id
required
integer (LineItemId)

LineItem identifier string.

object (LineItemAttributes)

LineItem attributes.

{
  • "type": "line_items",
  • "id": 1,
  • "attributes": {
    }
}

List Line Items

Returns a list of line items for the specified criteria.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
event_id
required
integer
Example: 1

Event identifier.

worksheet_id
required
integer
Example: 1

Worksheet identifier.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/events/v1/events/1/worksheets/1/line_items"

Response samples

Content type
application/vnd.api+json
{}

Create a Line Item

Create a line item with given cell values.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
event_id
required
integer
Example: 1

Event identifier.

worksheet_id
required
integer
Example: 1

Worksheet identifier.

Request Body schema: application/vnd.api+json
object (LineItemCreate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Bulk Create Line Items

Create multiple line items in a given worksheet. You can create up to 200 line items in a single request.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
event_id
required
integer
Example: 1

Event identifier.

worksheet_id
required
integer
Example: 1

Worksheet identifier.

Request Body schema: application/vnd.api+json
Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Get a Line Item

Retrieves the details of an existing line item. You need to supply the unique line item identifier that was returned upon line item creation.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
event_id
required
integer
Example: 1

Event identifier.

worksheet_id
required
integer
Example: 1

Worksheet identifier.

id
required
integer
Example: 1

Unique line item identifier.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/events/v1/events/1/worksheets/1/line_items/1"

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update a Line Item

Updates the details of an existing line item. You need to supply the unique line item that was returned upon line item creation.

Please note, that request body must include the id attribute with the value of your line item unique identifier (the same one you passed in the URL).

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
event_id
required
integer
Example: 1

Event identifier.

worksheet_id
required
integer
Example: 1

Worksheet identifier.

id
required
integer
Example: 1

Unique line item identifier.

Request Body schema: application/vnd.api+json
object (LineItemUpdate)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a Line Item

Deletes a line item. You need to supply the unique line item identifier that was returned upon line item creation.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
event_id
required
integer
Example: 1

Event identifier.

worksheet_id
required
integer
Example: 1

Worksheet identifier.

id
required
integer
Example: 1

Unique line item identifier.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     -X DELETE \
     "https://api.us.workdayspend.com/services/events/v1/events/1/worksheets/1/line_items/1"

Bids

Use the bids API to query the bids in Workday Strategic Sourcing. Only bids for events of type RFP are supported.

Bid Object

type
required
string (BidType)

Object type, should always be bids.

id
required
integer (BidId)

Bid identifier string.

object (BidAttributes)

Bid attributes.

object (BidRelationship)

Bid relationships.

object (ResourceLinks)

List of related links.

{
  • "id": "1",
  • "type": "bids",
  • "attributes": {
    },
  • "relationships": {
    },
  • "links": {}
}

List Bids

Returns a list of all bids. Only bids for events of type RFP are returned.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
event_id
required
integer
Example: 1

Event identifier.

query Parameters
object (BidInputFilter)

Filter bids by multiple criteria. Only one filter per attribute is supported. For best performance, we recommend 5 or less filters.

include
string (BidRelatedResources)
Enum: "event" "supplier_company"

Use the include parameter to request related resources along with the primary resource.

object (PageInput)

Customize pagination results with size.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/events/v1/events/1/bids"

Response samples

Content type
application/vnd.api+json
Example
{}

Get a Bid

Retrieves the details of an existing bid. You need to supply the unique bid identifier that was returned upon bid creation.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique Bid identifier.

query Parameters
include
string (BidRelatedResources)
Enum: "event" "supplier_company"

Use the include parameter to request related resources along with the primary resource.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/events/v1/bids/1"

Response samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Describe Bid object

Returns a list of fields for the bid object.

Authorizations:
(api_keyuser_tokenuser_email)

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/events/v1/bids/describe"

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    },
  • "data": [
    ],
  • "links": { }
}

Bid Line Items

Use the bid line items API to query the bid line items in Workday Strategic Sourcing.

Bid Line Item Object

type
required
string (BidLineItemType)

Object type, should always be bid_line_items.

id
required
integer (BidLineItemId)

BidLineItem identifier string.

object (BidLineItemAttributes)

BidLineItem attributes.

object (BidLineItemRelationship)

Bid line item relationship.

{
  • "id": "1",
  • "type": "bid_line_items",
  • "attributes": {
    },
  • "relationships": {
    }
}

List Bid Line Items

Returns a list of line items for a specific bid.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
bid_id
required
integer
Example: 1

Bid identifier.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/events/v1/bids/1/bid_line_items"

Response samples

Content type
application/vnd.api+json
{}

Get a Bid Line Item

Retrieves the details of an existing bid line item.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
integer
Example: 1

Unique bid line item identifier.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/events/v1/bid_line_items/1"

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

List All Bid Line Items

Returns a list of all bid line items.

Authorizations:
(api_keyuser_tokenuser_email)
query Parameters
object (BidLineItemInputFilter)

Filter bid line items by multiple criteria. Only one filter per attribute is supported. For best performance, we recommend 5 or less filters.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/events/v1/bid_line_items"

Response samples

Content type
application/vnd.api+json
{}

Describe Bid Line Item Object

Returns a list of fields for bid line item object.

Authorizations:
(api_keyuser_tokenuser_email)

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/events/v1/bid_line_items/describe"

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": { },
  • "meta": {
    }
}