{ "openapi": "3.0.4", "info": { "title": "Crelate® API", "description": "# Overview\r\nThe Crelate API is built on HTTP and is RESTful. Our API has predictable resource-oriented URLs, accepts and returns JSON, and uses standard HTTP response codes and verbs. Every endpoint requires a [valid API key](#section/Overview/Authentication). \r\n\r\n## Disclaimer\r\n\r\nThe Crelate API is under active development. As such, endpoints may change over time. We make all efforts to avoid\r\nbreaking changes, but it is occasionally necessary. We will communicate breaking changes in advance in our Impact\r\nGuides, which are shared directly to active customers as well as on our\r\nHelp Site.\r\n\r\nFeedback is greatly appreciated. Submit your feedback here.\r\n\r\n## Authentication\r\nThe Crelate API uses API keys to authenticate requests. An API key can be provisioned under\r\nManage Your Profile and Preferences.\r\nAn organization's administrator will need to \r\nenable API access for non-admin users. All requests made with this key operate as the associated user and not the organization.\r\n\r\n⚠️ **Take care when sharing your API key.** Anyone who has access to your API key can make requests on your behalf,\r\nand these operations will show in audit logs as your identity.\r\n\r\nAPI access can be disabled or a user's API key regenerated at any time. After disabling or regenerating an API key,\r\nexisting API processes that use that key will fail and must be updated to use the new key.\r\n\r\nWhen making HTTP requests, include the API key using the header name `X-Api-Key`.\r\n\r\nAll calls to the API must be made over HTTPS. Calls over normal HTTP will fail. API requests without authentication will also fail.\r\n\r\n## Zapier integration\r\nZapier is an online integration platform that allows you to create business automation processes through a web interface. Zapier offers connectivity to over 1,500 third party services including Crelate.\r\n\r\n- What is Crelate's Zapier Integration?\r\n- Get Started With Crelate + Zapier\r\n\r\n# General API Concepts\r\n\r\n## Lookups\r\n\r\nCrelate uses lookups to link records together in a 1:1 relationship. For example, a Job refers to its parent/target Company with the property `AccountId`. \r\n\r\n```JSON\r\n...\r\n \"AccountId\": {\r\n \"Id\": \"62bae789-24c8-4407-3f13-deab8172db08\",\r\n \"Title\": \"Crelate Retail\"\r\n },\r\n...\r\n```\r\n\r\nA lookup's `Title` is display text and may not reflect a later rename of the linked record, so group or join records\r\non `Id`.\r\n\r\nSome Lookup fields in Crelate can link to multiple entity types. In these cases, the entity name must be included with\r\nthe Id of the record. These fields use the `LookupAny` schema, and available entity types can be discovered using the\r\nmetadata endpoints for the entity containing such fields.\r\n\r\n\r\n\r\n## Multi-Lookups\r\n\r\nMulti-lookups are arrays of Lookups which link records in a 1:many relationship. Most Multi-lookups contain only one\r\nentity type, but there are cases where a Multi-lookup can contain multiple entity types.\r\n\r\n## Custom Fields\r\n\r\nCrelate provides up to 20 custom fields on each of [Jobs](#tag/Jobs), [Contacts](#tag/Contacts), and [Companies](#tag/Companies). Each custom field accepts a single type, defined as part of the custom field setup: string, date, number, or a custom picklist.\r\n\r\nAll custom fields are created with a display name for human-readable presentation of data and a logical name used when interacting with the Crelate API. Custom fields are modified and returned as part of a property bag alongside fields provided by Crelate with the following schema:\r\n\r\n```json\r\n\"entity\": {\r\n\t...\r\n\t\"CustomFields\": {\r\n\t\t\"My_custom_field\": \"A sample text value\",\r\n\t\t\"NumberField\": 123.456,\r\n\t},\r\n\t...\r\n}\r\n```\r\n\r\nA custom picklist field returns its chosen item as an `{Id, Title}` lookup to a\r\n[Custom Picklist Item](#tag/Custom-Picklist-Items), or a list of them when several items can be chosen. The `Id` is a\r\npicklist item, not a user or contact, and `Title` already holds the item's text.\r\n\r\nInformation about the format (and available values for custom picklist fields) as well as display and logical names is accessible by using the `/info` operation for entity types that support custom fields. More information about custom fields in general is available as a KBA here.\r\n\r\n> _Note: Creating new custom picklist fields is not supported by the API at this time._\r\n\r\n## Tags\r\n\r\nIn the Crelate API, various entities support the use of Tags. Tags may be categorized under a custom Tag Category or belong to the default category. Each Tag Category has a globally unique identifier (GUID) except for the default category, which has no Id. The tags schema is a dictionary keyed by the Tag Category Id (empty GUID for the default Tag Category) with the value existing as an array of tag lookup objects. \r\n\r\n⚠️ It is important to note that updating the Tags property for a record is a _complete replace_: any tags not in the update payload will be lost, **including tags in categories you did not include in the payload**. You can easily get the full tag set by retrieving the record first and specifying that you want the attribute _Tags_. This behavior is specific to Tags; see [Update Semantics](#section/API-Usage/Update-Semantics) for how other collection-valued fields behave.\r\n\r\n```json\r\n...\r\n\"Tags\": \r\n{\r\n\t \"00000000-0000-0000-0000-000000000000\": \r\n\t [\r\n\t\t{\r\n\t\t\t\"Id\": \"2af526dd-8169-4557-a355-965cdd2dda08\",\r\n\t\t\t\"Title\": \"Default Tag 1\"\r\n\t\t}\r\n\t],\r\n\t\"02903744-c151-46b0-589b-972f22a5d908\": \r\n\t[\r\n\t\t{\r\n\t\t\t\"Id\": \"2af526dd-8169-4557-a355-965cdd2dda08\",\r\n\t\t\t\"Title\": \"Custom Tag 1\"\r\n\t\t}\r\n\t]\r\n},\r\n...\r\n```\r\n\r\nThe Crelate API currently supports tags on these entities:\r\n- Applications\r\n- Companies\r\n- Contacts\r\n- Jobs\r\n\r\n## Record Status/Entity Status\r\n\r\nRecord Status (`EntityStatus` field) is used to indicate the current state of a record. Statuses are customizable per\r\ninstance of Crelate. Each status is represented by a unique (per-entity) integer value. Status metadata includes a UI \r\ndisplay name and various rules for presentation, such as whether the status should block communication with records\r\nhaving that status like the default Do Not Use status. Not all entities support Record Status, and since statuses\r\nvary per entity, it's important to understand the available values, which can be discovered by querying the metadata\r\nendpoints for the entity in question and inspecting the list of values for the `EntityStatus` field.\r\n\r\nIt's important to note that Record Status is independent of the various workflows in Crelate, like Sales or Recruiting.\r\nSince a record—like a Contact—can be a candidate for many Jobs, the Contact's Record Status cannot and does not convey\r\nthe candidate's recruitment workflow status on any of those Jobs, but may give contextual clues to how the candidate\r\nshould or should not be interacted with.\r\n\r\nThe schema containing Record Status metadata is as follows:\r\n\r\n\r\n\r\n## Documents\r\n\r\nDocuments, or Attachments, are a sub-type of [Artifacts](#tag/Artifacts) in Crelate. When uploading file contents for a\r\ntarget record in Crelate (like a Contact), an Artifact is created with the file contents. Document Types are synonymous\r\nwith Artifact Types, though an Advanced Artifact may not always have a file associated with it;\r\nhowever, Standard Artifacts always will.\r\n\r\n## Webhooks\r\n\r\nA webhook is an HTTPS endpoint you own that Crelate calls when a record changes. Instead of polling the API for\r\nchanges, you register a URL and Crelate sends it a `POST` request each time a matching operation occurs.\r\n\r\n⚠️ Webhooks require the **Business Plus** plan or higher.\r\n\r\n### Supported Events\r\n\r\n| Entity | Create | Update | Delete |\r\n| --- | --- | --- | --- |\r\n| [Contacts](#tag/Contacts) | ✓ | ✓ | ✓ |\r\n| [Companies](#tag/Companies) | ✓ | ✓ | ✓ |\r\n| [Jobs](#tag/Jobs) | ✓ | ✓ | ✓ |\r\n| [Placements](#tag/Placements) | ✓ | ✓ | ✓ |\r\n\r\n### Named Events\r\n\r\nA webhook can be narrowed to a named event, a specific kind of change within an entity's operation. A webhook with\r\nan event fires only when that event occurs; a webhook without one fires on every matching operation.\r\n\r\n| Event | Entity | Operation | Fires when |\r\n| --- | --- | --- | --- |\r\n| `Jobs.Published` | Jobs | Update | A job is put on the job portal. |\r\n| `Jobs.Unpublished` | Jobs | Update | A job is taken off the job portal. |\r\n\r\nWhen creating a webhook through the API, pass the event as `eventName` alongside its `entityName` and\r\n`operationName`. An event that does not belong to that entity and operation is rejected.\r\n\r\n### Creating a Webhook\r\n\r\nWebhooks are configured in Crelate. See this KBA for setup instructions.\r\n\r\n### Payload\r\n\r\nEvery webhook request is a `POST` with a JSON body in the following structure:\r\n\r\n```json\r\n{\r\n \"entityId\": \"62bae789-24c8-4407-3f13-deab8172db08\",\r\n \"entityName\": \"Contacts\",\r\n \"operationName\": \"Update\",\r\n \"externalPrimaryKey\": \"EXT-12345\",\r\n \"fields\": [\r\n \"FirstName\",\r\n \"LastName\"\r\n ],\r\n \"operationTimeUtc\": \"2026-01-01T15:00:00Z\",\r\n \"orgName\": \"yourorganization\",\r\n \"eventName\": null\r\n}\r\n```\r\n\r\n| Property | Type | Description |\r\n| --- | --- | --- |\r\n| entityId | GUID | The Id of the record that changed. |\r\n| entityName | string | The type of record: `Contacts`, `Companies`, `Jobs`, or `Placements`. |\r\n| operationName | string | The operation performed: `Create`, `Update`, or `Delete`. |\r\n| externalPrimaryKey | string | The record's external primary key. Empty when the record does not have one. |\r\n| fields | string array | **Update only.** The fields whose values were changed by the update, not the full set of fields on the record. `null` for `Create` and `Delete`. |\r\n| operationTimeUtc | date-time | When the operation occurred, in UTC. Every webhook fired by the same operation carries the same value. |\r\n| orgName | string | The name of the Crelate organization the record belongs to. |\r\n| eventName | string | The [named event](#section/General-API-Concepts/Webhooks) the webhook is narrowed to, such as `Jobs.Published`. `null` for a webhook without one. |\r\n\r\n### Webhooks Are Notifications Only\r\n\r\nThe payload tells you _that_ a record changed, not what it now contains. To get the record's current data, call the\r\nmatching retrieve endpoint with `entityId` (for example `GET contacts/{id}` for a `Contacts` event). A deleted record\r\ncan no longer be retrieved, so use `entityId` and `externalPrimaryKey` from a `Delete` payload to identify it on your side.\r\n\r\n### Responding to a Webhook\r\n\r\nYour endpoint must return `200 OK` within **5 seconds**. A slower response, a non-success status code, or a connection\r\nfailure counts as a failed delivery. Do your processing, including any calls back to the Crelate API, after you have\r\nresponded rather than before.\r\n\r\nCrelate does not retry a failed delivery. After **10** failed deliveries, the webhook is disabled and must be\r\nre-enabled in Crelate before it will fire again.\r\n\r\n# API Usage\r\n\r\n## Requests\r\n\r\nThe Crelate API uses the standard HTTP verbs `GET`, `POST`, `PATCH`, and `DELETE`, and in general accepts and returns JSON.\r\n\r\n### Query Parameters\r\nMost endpoints that retrieve records support querystring parameters that allow for sorting, filtering, and pagination. \r\n\r\n### Retrieve Options\r\nMost top-level GET requests support an additional body parameter to configure different aspects of the retrieved data. \r\n\r\n\r\n\r\nFor instance, if you were only concerned with the fields `FirstName` and `AccountId` along with the total record count for jobs, you would provide a JSON body with the GET request: \r\n\r\n```http\r\nGET https://app.crelate.com/api3/jobs\r\nX-Api-Key: \r\n```\r\n\r\n```json \r\n{ \r\n \"options\": { \r\n \"Fields\": [ \r\n\"FirstName\", \r\n\"AccountId\" \r\n ], \r\n \"TotalCount\": true \r\n } \r\n} \r\n``` \r\n\r\nSome endpoints expose subtypes of `RetrieveOptions` which provide domain-specific options to influence request execution.\r\n\r\nNot all HTTP clients and generated client libraries support sending a request body with a GET request. For\r\ncompatibility, every retrieve option can also be supplied as a querystring parameter instead:\r\n\r\n| Querystring parameter | Body property | Example |\r\n| --- | --- | --- |\r\n| `fields` | `Fields` | `?fields=FirstName,AccountId` or `?fields=FirstName&fields=AccountId` |\r\n| `total_count` | `TotalCount` | `?total_count=true` |\r\n| `unmask_values` | `UnmaskValues` | `?unmask_values=true` |\r\n| `filter_operator` | `FilterOperator` | `?filter_operator=or` |\r\n\r\nThe equivalent of the example above without a request body:\r\n\r\n```http\r\nGET https://app.crelate.com/api3/jobs?fields=FirstName,AccountId&total_count=true\r\nX-Api-Key: \r\n```\r\n\r\nSupplying `fields` or `filter_operator` in **both** the querystring and the request body returns a `400 Bad Request`.\r\nFor the boolean options (`total_count`, `unmask_values`), a querystring value takes precedence over the request body.\r\n\r\n## Required Properties \r\n\r\nRequired fields for each entity can be discovered by calling the metadata endpoint. Organization required fields are not reflected in the API documentation.\r\n\r\nWhich fields are required is **configurable per Crelate organization**, so required-ness is intentionally absent from\r\nthe request schemas in this documentation: a payload that succeeds against one organization may be rejected by another.\r\nBefore creating records, call and cache the entity's `/info` metadata endpoint (for example `GET contacts/info`) for the target\r\norganization to discover its field configuration, and be prepared to handle `400` validation errors for missing\r\nrequired fields.\r\n\r\n## Update Semantics\r\n\r\nUpdate (`PATCH`) requests modify only the fields present in the payload; omitted fields are left untouched. Within a\r\nsupplied field, the behavior depends on the field type:\r\n\r\n- Collection fields (multi-value fields such as email addresses, phone numbers, and websites) are _merged_: values\r\n in the payload are applied, and existing values not present in the payload are preserved.\r\n- Tags are the exception: updating `Tags` is a _complete replace_ of the full tag set. See [Tags](#section/General-API-Concepts/Tags).\r\n\r\n## Responses\r\n\r\nAll responses returned by the Crelate API are in the same structure, which is comprised of the following three properties: `Data`, [Metadata](#section/API-Usage/Metadata), and [Errors](#section/API-Usage/Errors). The data property represents the object(s) returned.\r\n\r\nThis structure provides consistency for success, error, and partial success API responses.\r\n\r\n| Property | Description |\r\n| --- | --- |\r\n| Data | The data being returned - retrieved or Id of newly created records. |\r\n| Metadata | Metadata returned to provide additional context to a Crelate API response. REST Hypermedia in the form of pagination URLs are returned here when available. |\r\n| Errors | Describes errors encountered when making the request. | \r\n\r\n## Rate Limiting\r\n\r\nCrelate API usage is subject to rate limiting. The rate limit is generally 120 requests per minute per IP address, but\r\nthrottling may be applied sooner if many resource-intensive and/or long-running operations are performed too quickly.\r\nAdditionally note that repeated error status code requests (e.g. 400, 401, 403, 500) will more aggressively trigger rate\r\nlimiting, so be sure to handle all error status codes in your integrations and use exponential backoff retries when\r\nencountering 429 responses.\r\n\r\nRate limiting is enforced at the network edge, before requests reach the API. A rate-limited request receives a\r\n`429 Too Many Requests` response that does **not** use the standard `Data`/`Metadata`/`Errors` envelope. Instead,\r\nthe response body is a flat object, and the retry delay is conveyed by the `retry_after_seconds` property (no\r\n`Retry-After` header is returned):\r\n\r\n```json\r\n{\r\n \"error\": \"Sample error message\",\r\n \"message\": \"Too many requests.\",\r\n \"status\": 429,\r\n \"retry_after_seconds\": \"60\"\r\n}\r\n```\r\n\r\nWhen you receive a `429`, wait at least `retry_after_seconds` seconds before retrying. If the property is absent,\r\nfall back to exponential backoff.\r\n\r\n## Errors\r\n\r\nThe Crelate API follows the error response format laid out below for all endpoints. Your client must be prepared to gracefully handle errors by checking additional members of the response.\r\n\r\nWhen an error occurs, the response will contain an `Errors` array. Each error object contains the following properties:\r\n\r\n\r\n\r\n### HTTP Status Code Summary\r\n| Code | Status | Message |\r\n| --- | --- | --- |\r\n| 200 | OK | Request was successful. |\r\n| 204 | No Content | Request was successful but has nothing to return. |\r\n| 206 | Partial Content | Request was partially successful. Data and Errors will both contain values. |\r\n| 400 | Bad Request | The request was unacceptable, often due to incorrect or missing parameters. |\r\n| 401 | Unauthorized | The API key specified is not valid. |\r\n| 403 | Forbidden |\tThe API key specified is associated with a principal that does not have permissions to perform the request. |\r\n| 404 | Not Found |\tThe requested resource does not exist. |\r\n| 409 | Conflict | A duplicate was found. |\r\n| 429 | Too Many Requests | The rate limit has been exceeded. See [Rate Limiting](#section/API-Usage/Rate-Limiting) for the response shape and retry guidance. |\r\n| 500 | Server Error | Crelate encountered an issue. |\r\n\r\n### Partial Success (206)\r\n\r\nWhen a request is partially successful, the response status is `206 Partial Content` and **both** `Data` and `Errors`\r\ncontain values: `Data` holds the results of the operations that succeeded, and `Errors` describes the failures. Note\r\nthat entries in the `Errors` array are **not** positionally correlated with the items in your request; use the\r\nidentifiers and details within each error's `Message` to determine which inputs failed, not the array index.\r\n\r\n### Unsupported Parameters and Fields\r\n\r\nAn endpoint applies a querystring parameter only when it recognizes the parameter's name, and applies a JSON request\r\nbody field only when it matches a member of the target schema. A name it does not recognize, including one that\r\ndiffers from a supported name only by capitalization, is not applied. The request still succeeds, so the response\r\nwould otherwise look the same as one where every parameter and field you sent was applied.\r\n\r\nEach unapplied querystring parameter is reported as an entry in the `Errors` array with a `Type` of\r\n`IgnoredParameter`; each unapplied body field is reported the same way with a `Type` of `IgnoredField`. Both carry a\r\n`Code` of `200`. These entries describe how the request was handled; they do not mean the request failed. To tell a\r\nfailure from a report like this, check each entry's `Code` rather than whether the array is empty.\r\n\r\nFile-download endpoints return the raw file bytes rather than the `Data`/`Metadata`/`Errors` envelope, so they have\r\nno `Errors` array. They report unapplied parameters in the `X-Crelate-Ignored-Parameters` response header instead, as\r\na comma-separated list of the parameter names, each percent-encoded (RFC 3986).\r\n\r\nTo have such a request rejected instead of answered, add `validation=strict` to the querystring. The response is\r\nthen a `400 Bad Request` carrying one `IgnoredParameter` or `IgnoredField` entry per unsupported parameter or field\r\nfound across the querystring and the body, and no data is returned. `strict` is the only accepted value.\r\n\r\n## Pagination\r\n\r\nAll retrieve endpoints that return a list of records support pagination through querystring parameters. The Metadata\r\nproperty returned on all responses can be used to assist with pagination (it includes Prev and Next links).\r\n\r\n| Parameter | Type | Default | Description |\r\n| --- | --- | --- | --- |\r\n| offset | number | 0 | Number of records to offset the retrieve by. |\r\n| limit | number | 100 | Maximum number of records to retrieve. (Maximum of 200) | \r\n\r\nWhen paging through a result set, follow the `Next` link from the response [Metadata](#section/API-Usage/Metadata)\r\nrather than computing offsets yourself. Setting a `sort_by` is highly recommended whenever you use `offset`. Without\r\nan explicit sort, page boundaries are not guaranteed to be stable between requests.\r\n\r\n## Synchronizing Data\r\n\r\nOffset-based pagination is not stable when records are being created, modified, or deleted concurrently: records can\r\nshift between pages mid-walk, causing some to be skipped and others to appear twice. For incremental synchronization,\r\ndo not walk the full record set by offset. Instead, filter by modified date (for example, the `modified_after`\r\nquerystring parameter available on most list endpoints), sort by modified date, and track the latest modified date you\r\nhave processed as the starting point of your next sync window.\r\n\r\n[Webhooks](#section/General-API-Concepts/Webhooks) can notify you when Contacts, Companies, Jobs, and Placements change. For\r\nother entities, and to catch up after a missed notification, poll with modified-date windows.\r\n\r\n## Sorting and Filtering\r\n\r\n### Sorting\r\n\r\nEvery retrieve endpoint that returns a list of records supports sorting based on the allowed properties of the entity.\r\n\r\n| Parameter | Type | Default | Description |\r\n| --- | --- | --- | --- |\r\n|sort_by | string array | `modifiedOn desc` | Comma separated sort options. Each option is an attribute with an optional direction e.g. “FirstName asc”. Default direction is ascending if not provided. | \r\n\r\nTo find the properties available for sorting on an entity you can utilize the metadata endpoint under the property's `ValidFor` field.\r\n\r\n### Filtering\r\n\r\nThe Crelate API supports filtering options for the majority of retrieve endpoints that return a list of records.\r\nYou provide these filters as querystring parameters. Each endpoint allows for different filtering options based on the entity. \r\n\r\nFor example, I might want to find all jobs that are published to the job portal and have the tag of \"Manager\". The request would be structured as:\r\n\r\n```http\r\nGET https://app.crelate.com/api3/jobs?published=true&tag_names=Manager\r\nX-Api-Key: \r\n```\r\nYou can find the filter options available on each endpoint in this documentation.\r\n\r\n## Date and Time Values\r\n\r\nAll dates are expected to be supplied as ISO 8601\r\nformat in the UTC timezone.\r\nFor example `2023-01-01T15:00:00Z`. If dates are supplied in any other format or timezone, the operation may fail,\r\nor you may encounter unpredictable results.\r\n\r\n## Phone Number Values\r\n\r\nAll phone number values in Crelate are expected to conform to the [E.164 format](https://en.wikipedia.org/wiki/E.164).\r\nPhone number values applied within Crelate will be coerced to this format; this allows for consistent and deterministic\r\nquerying of phone number values throughout the platform. Note that phone number values used to query for records will\r\nalso be coerced to this format.\r\n\r\nExample: A value of `+1 425-123-4567` will be reformatted to `+14251234567`. This applies to both setting a phone number\r\nvalue and querying for records with that phone number.\r\n\r\n## Metadata\r\n\r\nThe Crelate API returns additional metadata that provides more details based on the endpoint.\r\n\r\n\r\n\r\n- Links: These are helper hrefs available for pagination.\r\n - Self: The URL for the request made\r\n - Prev: The URL for the previous page\r\n - Next: The URL for the next page\r\n - First: The URL for the first page\r\n - Last: The URL for the last page\r\n\r\n```json\r\n\"Metadata\": {\r\n \"CorrelationId\": \"f131dc39-f1ef-43e7-930c-ffcb528eef1f\",\r\n \"TimeStamp\": \"2023-06-23T18:12:07.522503Z\",\r\n \"Url\": \"https://app.crelate.com/api3/jobs?tag_names=manager&offset=10&limit=5\",\r\n \"TotalRecords\": 30,\r\n \"MoreRecords\": false,\r\n \"Links\": {\r\n \"Self\": {\r\n\"Href\": \"https://app.crelate.com/api3/jobs?tag_names=manager&offset=10&limit=5\"\r\n },\r\n \"Prev\": {\r\n\"Href\": \"https://app.crelate.com/api3/jobs?tag_names=manager&offset=5&limit=5\"\r\n },\r\n \"Next\": {\r\n\"Href\": \"https://app.crelate.com/api3/jobs?tag_names=manager&offset=15&limit=5\"\r\n },\r\n \"First\": {\r\n\"Href\": \"https://app.crelate.com/api3/jobs?tag_names=manager&offset=0\"\r\n },\r\n \"Last\": {\r\n\"Href\": \"https://app.crelate.com/api3/jobs?tag_names=manager&offset=25&limit=5\"\r\n }\r\n }\r\n}\r\n```\r\n\r\n# Getting Started\r\n\r\n## How to generate client code\r\nSwagger is a document format for REST API service definitions.\r\nCrelate uses this format to describe our API services, including endpoints, models, and responses. To generate client\r\ncode in your language of choice:\r\n- Download the Swagger service definition.\r\n- Generate client code by visiting http://editor.swagger.io and uploading the Crelate service definition JSON. (File -> Import file)\r\n- Once the Crelate definition has been imported, select 'Generate Client' from the menu and select a language. A zip file will be created containing the client code library.\r\n- If you are using the .NET framework, NSwag can be used to generate a C# client library.\r\n- Other third-party tools may be used to generate client code from the Crelate API definition in more programming languages.\r\n\r\n__Disclaimer: Crelate provides this API definition as-is. Crelate makes no guarantees about the functionality or accuracy of\r\ncode generated by third-party tools.__\r\n\r\n## Tips and Tricks\r\n\r\nMost entity types in the Crelate API expose _metadata endpoints_. These endpoints provide cacheable data that does not\r\nchange often, and include valuable data such as what fields are available for different operations (create, read, update)\r\nand what kind of values they accept. For more complex fields, like Lookup-typed fields, the metadata endpoints include\r\neither a list of available values (with display-ready text values) or a reference to the entity type that can be queried\r\nto find available values.\r\n\r\n⚠️ __Warning:__ Entity metadata often differs slightly between Crelate tenants. If you are an integration partner, make sure\r\nnot to mix entity metadata between tenants as this can produce validation errors and unexpected results.\r\n\r\nIf it doesn't seem obvious what values can be entered for a field that has a constrained value set or type, these\r\nmetadata endpoints should be the first place to look for more information.\r\n\r\nFor example, the EntityStatus field is a simple integer, but the underlying status contains additional metadata like the\r\ndisplay name and how records with that status should behave within the platform. Calling `GET contact/info` contains an\r\nentry for EntityStatus like this sample:\r\n\r\n```json\r\n...\r\n\"EntityStatus\": {\r\n \"DisplayName\": \"Record Status\",\r\n \"ValidFor\": [\r\n \"read\"\r\n ],\r\n \"Type\": \"recordStatus\",\r\n \"IsEncrypted\": false,\r\n \"ValueMaskingMode\": 0,\r\n \"Statuses\": [\r\n {\r\n \"Name\": \"Active\",\r\n \"Value\": 1,\r\n \"AllowContactOption\": 2,\r\n \"VisibilityOption\": 2,\r\n \"IsSystemReservedStatus\": false\r\n },\r\n {\r\n \"Name\": \"Inactive\",\r\n \"Value\": 2,\r\n \"AllowContactOption\": 2,\r\n \"VisibilityOption\": 2,\r\n \"IsSystemReservedStatus\": false\r\n },\r\n {\r\n \"Name\": \"Do Not Use\",\r\n \"Value\": 3,\r\n \"AllowContactOption\": 2,\r\n \"VisibilityOption\": 2,\r\n \"IsSystemReservedStatus\": false\r\n },\r\n ...\r\n\t]\r\n}\r\n...\r\n```\r\n\r\n## Making Test Calls\r\n\r\nThird-party tools like Postman and\r\nInsomnia are useful to test Crelate API calls. If you're struggling\r\nto make an endpoint work, testing your request in one of these applications may help you identify the issue with your\r\nrequest.\r\n\r\n[\"Run](https://god.gw.postman.com/run-collection/18339486-bdd67bad-67f9-4480-8e64-f358b5a3c29b?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D18339486-bdd67bad-67f9-4480-8e64-f358b5a3c29b%26entityType%3Dcollection%26workspaceId%3Da08cff18-e53a-46e6-8874-7f465eaaf327#?env%5BProduction%5D=W3sia2V5IjoiIiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoiZGVmYXVsdCJ9LHsia2V5IjoiIiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoiZGVmYXVsdCJ9XQ==)", "termsOfService": "https://www.crelate.com/terms-of-service", "contact": { "name": "Crelate® API Support", "email": "integrations@crelate.com" }, "version": "v3", "x-logo": { "url": "/api3/assets/images/crelate-logo-horizontal.svg", "backgroundColor": "#FFFFFF", "altText": "Crelate®" } }, "servers": [ { "url": "https://app.crelate.com/api3" } ], "paths": { "/activities": { "get": { "tags": [ "Activities" ], "summary": "Retrieve Activities", "description": "Returns a paged list of activity records. Filter by parent record, verb type, date range, or other criteria.\r\n Content is in Html, Display or both. When Html is set it holds the full content, and Display, if also set, may be only a short preview. When Html is null the content is in Display, which may be plain text or JSON-wrapped text such as a JSON string array.", "operationId": "activitiesGetRecords", "parameters": [ { "name": "announced", "in": "query", "description": "The announcement status to filter on.", "schema": { "type": "boolean" } }, { "name": "external_primary_keys", "in": "query", "description": "External Primary Keys of Activities to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ids", "in": "query", "description": "List of comma-separated Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Activities that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Activities that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. Highly recommended to set a\tsort_by if setting this", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "owner_ids", "in": "query", "description": "List of comma-separated owner (user) Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "parent_ids", "in": "query", "description": "List of comma-separated Parent Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "pinned", "in": "query", "description": "The pinned status to filter on.", "schema": { "type": "boolean" } }, { "name": "recent", "in": "query", "description": "Activities that have been modified in the last recent minutes.", "schema": { "type": "integer", "format": "int32" } }, { "name": "regarding_ids", "in": "query", "description": "List of comma-separated Regarding Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute\twith an optional direction e.g. \"FirstName asc\". Default direction of ascending if not provided", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "verb_ids", "in": "query", "description": "List of comma-separated Verb Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "when_after", "in": "query", "description": "Activities whose own activity date is after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "when_before", "in": "query", "description": "Activities whose own activity date is before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveActivitiesListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveActivitiesListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "description": "Individual activities can include information defaulted by the activity type (VerbId). Check the activity type values instead of inferring intent from verb_ids or an activity type's name. Request both Html and Display. When Html is set it holds the full content and Display may be only a short preview; when Html is null the content is in Display.", "scope": "crelate.mcp.read.bulk" } }, "post": { "tags": [ "Activities" ], "summary": "Create an Activity", "description": "Creates a new Activities record and returns its generated ID.", "operationId": "activitiesCreate", "requestBody": { "description": "The record to create.", "content": { "application/json": { "schema": { "required": [ "entity" ], "properties": { "entity": { "$ref": "#/components/schemas/CreateActivities" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "409": { "description": "When duplicates are disabled or forbidden for the entity type(s) involved and completing the request would produce a duplicate record.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } } } } }, "/activities/{id}": { "get": { "tags": [ "Activities" ], "summary": "Retrieve an Activity", "description": "Returns a single Activities record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "activitiesGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveActivitiesCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } }, "patch": { "tags": [ "Activities" ], "summary": "Update an Activity", "description": "Partially updates an existing Activities record. Only fields included in the request body are modified; omitted fields are left unchanged.", "operationId": "activitiesUpdate", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to update.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The record to update.", "content": { "application/json": { "schema": { "required": [ "entity" ], "properties": { "entity": { "$ref": "#/components/schemas/UpdateActivities" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } }, "delete": { "tags": [ "Activities" ], "summary": "Delete an Activity", "description": "Permanently deletes an Activity record by its unique identifier.", "operationId": "activitiesDelete", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to delete.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/activities/count": { "get": { "tags": [ "Activities" ], "summary": "Retrieve count of Activities", "description": "Returns the total count of Activities records in the organization matching the current access context.", "operationId": "activitiesCount", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Int32CrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/activities/info": { "get": { "tags": [ "Activities" ], "summary": "Retrieve Activities metadata", "description": "Retrieves attribute information specific to the Activities type. This data changes rarely and Crelate recommends caching it.", "operationId": "activitiesGetInfo", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInfoCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/activitytypes": { "get": { "tags": [ "Activity Types" ], "summary": "Retrieve Activity Types", "description": "Retrieves all Activity Types available to the caller. Activity Types set default behavior for Activities created with that Activity Type via the `VerbId` field. Records must match all filters provided unless the OR filter operator is specified.\r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.\r\n If both recent and modified_after/modified_before are provided, recent will take precedence.", "operationId": "activityTypesGetRecords", "parameters": [ { "name": "ids", "in": "query", "description": "The primary keys of Activity Types to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Activity Types that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Activity Types that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "recent", "in": "query", "description": "Activity Types that have been modified in the last recent minutes", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"Name asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "valid_for_create", "in": "query", "description": "Whether to include Activity Types valid (`true`) or invalid (`false`) for creation. This filter may be omitted to include records from both categories.", "schema": { "type": "boolean" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveActivityTypesListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveActivityTypesListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/activitytypes/{id}": { "get": { "tags": [ "Activity Types" ], "summary": "Retrieve an Activity Type", "description": "Returns a single Activity Types record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "activityTypesGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveActivityTypesCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/activitytypes/info": { "get": { "tags": [ "Activity Types" ], "summary": "Retrieve Activity Types metadata", "description": "Retrieves attribute information specific to the Activity Types type. This data changes rarely and Crelate recommends caching it.", "operationId": "activityTypesGetInfo", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInfoCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/emails": { "get": { "tags": [ "Emails" ], "summary": "Retrieve Email activities", "description": "Returns a paged list of email activities. Filter by parent record, sender, recipient, date range, or other criteria.\r\n Content is in Html, Display or both. When Html is set it holds the full content, and Display, if also set, may be only a short preview. When Html is null the content is in Display, which may be plain text or JSON-wrapped text such as a JSON string array.\r\n RegardingId links an Email to a Job only when one was chosen: the Regarding Job picked when composing or supplied on create, inherited by a reply, set by an automation or sequence step, or named by a #crjob hashtag in the body. Journaled, BCC'd and add-in-logged mail usually has no RegardingId. To group by contact, use ParentId. To group by Job, filter with regarding_ids, or retrieve activities whose parent is one of the Job's contacts.", "operationId": "emailsGetRecords", "parameters": [ { "name": "announced", "in": "query", "description": "The announcement status to filter on.", "schema": { "type": "boolean" } }, { "name": "completed", "in": "query", "description": "Whether only incomplete or only complete Email should be retrieved.", "schema": { "type": "boolean" } }, { "name": "created_by_id", "in": "query", "description": "Filters to Email activities created by a user.", "schema": { "type": "string", "format": "uuid" } }, { "name": "external_primary_keys", "in": "query", "description": "External Primary Keys of Emails to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "from", "in": "query", "description": "The sender's email address to filter on.", "schema": { "type": "string" } }, { "name": "ids", "in": "query", "description": "List of comma-separated Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Email activities that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Email activities that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. Highly recommended to set a sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "owner_ids", "in": "query", "description": "List of comma-separated owner (user) Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "parent_id", "in": "query", "description": "The Id of the records this Email is parented to.", "schema": { "type": "string", "format": "uuid" } }, { "name": "pinned", "in": "query", "description": "The pinned status to filter on.", "schema": { "type": "boolean" } }, { "name": "recent", "in": "query", "description": "Email activities that have been modified in the last recent minutes.", "schema": { "type": "integer", "format": "int32" } }, { "name": "regarding_ids", "in": "query", "description": "List of comma-separated Ids the Email should be regarded by to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction, e.g. \"FirstName asc\". Default direction of ascending if not provided", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "to", "in": "query", "description": "The recipient's email address to filter on.", "schema": { "type": "string" } }, { "name": "when_after", "in": "query", "description": "Email activities whose own activity date is after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "when_before", "in": "query", "description": "Email activities whose own activity date is before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveEmailsListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveEmailsListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "description": "Request both Html and Display. When Html is set it holds the full content and Display may be only a short preview; when Html is null the content is in Display. RegardingId is set only when a job was linked (picked when composing, inherited by a reply, set by an automation or sequence step, or a #crjob hashtag in the body), so journaled, BCC'd and add-in-logged mail usually has none. Group by contact with ParentId. Group by job with regarding_ids, or pass the job's contacts (retrieve_contacts with job_ids) as parent_ids to retrieve_activities.", "scope": "crelate.mcp.read.bulk" } }, "post": { "tags": [ "Emails" ], "summary": "Create an Email activity", "description": "If the From field matches any of the parent Contact's email addresses, the activity is recorded as an Email Received. If the To field matches any of the parent Contact's email addresses, the activity is recorded as an Email Sent. If the From and To email are both emails of the parent Contact, From wins.", "operationId": "emailsCreate", "requestBody": { "description": "The entity to be created.", "content": { "application/json": { "schema": { "required": [ "entity" ], "properties": { "entity": { "$ref": "#/components/schemas/CreateEmails" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/emails/{id}": { "get": { "tags": [ "Emails" ], "summary": "Retrieve an Email activity", "description": "Returns a single email activity by its unique identifier.\r\n Content is in Html, Display or both. When Html is set it holds the full content, and Display, if also set, may be only a short preview. When Html is null the content is in Display, which may be plain text or JSON-wrapped text such as a JSON string array.", "operationId": "emailsGetById", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the Email activity to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveEmailsCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "description": "Request both Html and Display. When Html is set it holds the full content and Display may be only a short preview; when Html is null the content is in Display.", "scope": "crelate.mcp.read" } } }, "/notes": { "get": { "tags": [ "Notes" ], "summary": "Retrieve Note activities", "description": "Returns a paged list of note activities. Filter by parent record, date range, or other criteria.\r\n A note's content is in Display, which may be plain text or JSON-wrapped text such as a JSON string array. Notes have no Html field.", "operationId": "notesGetRecords", "parameters": [ { "name": "announced", "in": "query", "description": "The announcement status to filter on.", "schema": { "type": "boolean" } }, { "name": "completed", "in": "query", "description": "Whether only incomplete or only complete Notes should be retrieved.", "schema": { "type": "boolean" } }, { "name": "created_by_id", "in": "query", "description": "Filters to Notes created by a user.", "schema": { "type": "string", "format": "uuid" } }, { "name": "external_primary_keys", "in": "query", "description": "External Primary Keys of Notes to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ids", "in": "query", "description": "List of comma-separated Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Notes that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Notes that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. Highly recommended to set a sort_by if setting this", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "owner_ids", "in": "query", "description": "List of comma-separated owner (user) Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "parent_id", "in": "query", "description": "The Id of the parent record to retrieve Notes for.", "schema": { "type": "string", "format": "uuid" } }, { "name": "pinned", "in": "query", "description": "The pinned status to filter on.", "schema": { "type": "boolean" } }, { "name": "recent", "in": "query", "description": "Notes that have been modified in the last recent minutes.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute\twith an optional direction e.g. \"FirstName asc\". Default direction of ascending if not provided", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "when", "in": "query", "description": "The date and time when Notes are due or scheduled for.", "schema": { "type": "string", "format": "date-time" } }, { "name": "when_after", "in": "query", "description": "Notes whose own activity date is after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "when_before", "in": "query", "description": "Notes whose own activity date is before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveNotesListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveNotesListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "description": "A note's content is in Display, which may be plain text or JSON-wrapped text such as a JSON string array. Notes have no Html field.", "scope": "crelate.mcp.read.bulk" } }, "post": { "tags": [ "Notes" ], "summary": "Create a Note activity", "description": "Creates a new note activity on a parent record. A `ParentId` is required.", "operationId": "notesCreate", "requestBody": { "description": "The entity to be created.", "content": { "application/json": { "schema": { "required": [ "entity" ], "properties": { "entity": { "$ref": "#/components/schemas/CreateNotes" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.write" } } }, "/notes/{id}": { "get": { "tags": [ "Notes" ], "summary": "Retrieve a Note activity", "description": "Returns a single note activity by its unique identifier.\r\n A note's content is in Display, which may be plain text or JSON-wrapped text such as a JSON string array. Notes have no Html field.", "operationId": "notesGetById", "parameters": [ { "name": "id", "in": "path", "description": "The GUID of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveNotesCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "description": "A note's content is in Display, which may be plain text or JSON-wrapped text such as a JSON string array. Notes have no Html field.", "scope": "crelate.mcp.read" } }, "patch": { "tags": [ "Notes" ], "summary": "Update a Note activity", "description": "Partially updates a note activity. Only fields included in the request body are modified.", "operationId": "notesUpdate", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to update.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The record to update.", "content": { "application/json": { "schema": { "required": [ "entity" ], "properties": { "entity": { "$ref": "#/components/schemas/UpdateNotes" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } }, "delete": { "tags": [ "Notes" ], "summary": "Delete a Note activity", "description": "Permanently deletes a note activity by its unique identifier.", "operationId": "notesDelete", "parameters": [ { "name": "id", "in": "path", "description": "The GUID to delete.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/tasks": { "get": { "tags": [ "Tasks" ], "summary": "Retrieve Task activities", "description": "Returns a paged list of task activities. Filter by parent record, completion state, date range, or other criteria.", "operationId": "tasksGetRecords", "parameters": [ { "name": "announced", "in": "query", "description": "The announcement status to filter on.", "schema": { "type": "boolean" } }, { "name": "completed", "in": "query", "description": "Whether only incomplete or only complete Task should be retrieved.", "schema": { "type": "boolean" } }, { "name": "external_primary_keys", "in": "query", "description": "External Primary Keys of Tasks to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ids", "in": "query", "description": "List of comma-separated Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Tasks that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Tasks that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. Highly recommended to set a sort_by if setting this", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "owner_id", "in": "query", "description": "The owner of the Tasks.", "schema": { "type": "string", "format": "uuid" } }, { "name": "owner_ids", "in": "query", "description": "List of comma-separated owner (user) Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "owner_is_primary", "in": "query", "description": "Whether the owner is the primary owner of the Tasks. When provided, owner_id must also be provided.", "schema": { "type": "boolean" } }, { "name": "parent_id", "in": "query", "description": "The Id of the parent record to retrieve Tasks for.", "schema": { "type": "string", "format": "uuid" } }, { "name": "pinned", "in": "query", "description": "The pinned status to filter on.", "schema": { "type": "boolean" } }, { "name": "recent", "in": "query", "description": "Tasks that have been modified in the last recent minutes.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute\twith an optional direction e.g. \"FirstName asc\". Default direction of ascending if not provided", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "when", "in": "query", "description": "The date and time when Tasks are due or scheduled for.", "schema": { "type": "string", "format": "date-time" } }, { "name": "when_after", "in": "query", "description": "Tasks whose own activity date is after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "when_before", "in": "query", "description": "Tasks whose own activity date is before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveTasksListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveTasksListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } }, "post": { "tags": [ "Tasks" ], "summary": "Create a Task activity", "description": "Tasks will default to being incomplete (Completed = false) unless a value is provided.", "operationId": "tasksCreate", "requestBody": { "description": "The entity to create.", "content": { "application/json": { "schema": { "required": [ "entity" ], "properties": { "entity": { "$ref": "#/components/schemas/CreateTasks" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/tasks/{id}": { "get": { "tags": [ "Tasks" ], "summary": "Retrieve a Task activity", "description": "Returns a single task activity by its unique identifier.", "operationId": "tasksGetById", "parameters": [ { "name": "id", "in": "path", "description": "The GUID of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveTasksCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } }, "patch": { "tags": [ "Tasks" ], "summary": "Update a Task activity", "description": "Partially updates a task activity. Only fields included in the request body are modified.", "operationId": "tasksUpdate", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the Task to update.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The Task to update.", "content": { "application/json": { "schema": { "required": [ "entity" ], "properties": { "entity": { "$ref": "#/components/schemas/UpdateTasks" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } }, "delete": { "tags": [ "Tasks" ], "summary": "Delete a Task activity", "description": "Permanently deletes a task activity by its unique identifier.", "operationId": "tasksDelete", "parameters": [ { "name": "id", "in": "path", "description": "The GUID to delete.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/backups": { "get": { "tags": [ "Backups" ], "summary": "Retrieve Backups", "description": "Records must match all filters provided unless the OR filter operator is specified.\r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.\r\n If both recent and modified_after/modified_before are provided, recent will take precedence.", "operationId": "backupsGetRecords", "parameters": [ { "name": "ids", "in": "query", "description": "The primary keys of Backups to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Backups that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Backups that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "recent", "in": "query", "description": "Backups that have been modified in the last recent minutes", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"FirstName asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveBackupsListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveBackupsListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } }, "post": { "tags": [ "Backups" ], "summary": "Create a Backup", "description": "Creates a new Backups record and returns its generated ID.", "operationId": "backupsCreate", "requestBody": { "description": "The record to create.", "content": { "application/json": { "schema": { "required": [ "entity" ], "properties": { "entity": { "$ref": "#/components/schemas/BackupEntity" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/backups/{backupId}/content": { "get": { "tags": [ "Backups" ], "summary": "Retrieve backup zip file contents", "description": "Downloads the backup archive as a zip stream. The archive is password-protected; the password is stored on the backup record.", "operationId": "backupsDownloadFile", "parameters": [ { "name": "backupId", "in": "path", "description": "ID of the backup entity", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fileName", "in": "query", "description": "File name of the file to get content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamResponseCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/backups/{id}": { "get": { "tags": [ "Backups" ], "summary": "Retrieve a Backup", "description": "Returns a single Backups record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "backupsGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveBackupsCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/backups/info": { "get": { "tags": [ "Backups" ], "summary": "Retrieve Backups metadata", "description": "Retrieves attribute information specific to the Backups type. This data changes rarely and Crelate recommends caching it.", "operationId": "backupsGetInfo", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInfoCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/backups/recent": { "get": { "tags": [ "Backups" ], "summary": "Retrieve most recent backup", "description": "Returns the most recently created backup record for the organization.", "operationId": "backupsGetMostRecent", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveBackupsCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/organizations/self": { "get": { "tags": [ "Organizations" ], "summary": "Retrieve current Organization", "description": "Provides access to information about an Organization such as the unique name, display name, default time zone, and limited other information. Some fields are only available to Organization administrator users.", "operationId": "organizationsGetSelfOrganization", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveOrganizationsCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/users": { "get": { "tags": [ "Users" ], "summary": "Retrieve Users", "description": "Records must match all filters provided unless the OR filter operator is specified. \r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.", "operationId": "usersGetRecords", "parameters": [ { "name": "emails", "in": "query", "description": "List of comma-separated email addresses to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ids", "in": "query", "description": "List of comma-separated Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "phone_numbers", "in": "query", "description": "List of comma-separated phone numbers to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"FirstName asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "states", "in": "query", "description": "List of comma-separated states to filter on. Possible values are: \n * `Active`: An active that can log in.\n * `Disabled`: A disabled User that cannot log in.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveUsersListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveUsersListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/users/{id}": { "get": { "tags": [ "Users" ], "summary": "Retrieve a User", "description": "Returns a single Users record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "usersGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveUsersCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/users/count": { "get": { "tags": [ "Users" ], "summary": "Retrieve count of Users", "description": "Returns the total count of Users records in the organization matching the current access context.", "operationId": "usersCount", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Int32CrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/users/info": { "get": { "tags": [ "Users" ], "summary": "Retrieve Users metadata", "description": "Retrieves attribute information specific to the Users type. This data changes rarely and Crelate recommends caching it.", "operationId": "usersGetInfo", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInfoCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/users/self": { "get": { "tags": [ "Users" ], "summary": "Retrieve current User", "description": "Detail level is limited by the privileges of the requesting User.", "operationId": "usersGetSelf", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveUsersCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/webhooks": { "get": { "tags": [ "Webhooks" ], "summary": "Retrieve Webhooks", "operationId": "webhooksGetRecords", "parameters": [ { "name": "userId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveWebhooksListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveWebhooksListCrelateResponse" } } } } } }, "post": { "tags": [ "Webhooks" ], "summary": "Create a Webhook", "description": "Creates a new Webhook record and returns its generated ID.", "operationId": "webhooksCreate", "requestBody": { "content": { "application/json": { "schema": { "required": [ "entityName", "name", "operationName", "status", "url" ], "properties": { "entityName": { "type": "string", "description": " " }, "eventName": { "type": "string", "description": "Optional. Narrows the webhook to one named event of the entity and operation. Omit it to fire on every matching operation. \t" }, "name": { "type": "string", "description": "The name of your Webhook for easy identification." }, "operationName": { "type": "string", "description": " " }, "status": { "type": "integer", "description": " ", "format": "int32" }, "url": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/webhooks/{id}": { "get": { "tags": [ "Webhooks" ], "summary": "Retrieve a Webhook", "description": "Returns a single Webhooks record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "webhooksGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveWebhooksCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } }, "delete": { "tags": [ "Webhooks" ], "summary": "Delete a Webhook", "description": "Permanently deletes a Webhook record by its unique identifier.", "operationId": "webhooksDelete", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to delete.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/webhooks/bulk": { "delete": { "tags": [ "Webhooks" ], "summary": "Delete Webhooks in bulk", "description": "This operation is all or nothing; partial success scenarios, where some records are deleted and some fail, are not supported.", "operationId": "webhooksDeleteBulk", "requestBody": { "content": { "application/json": { "schema": { "required": [ "ids" ], "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The primary keys of the records to delete. Up to 50 may be provided." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/webhooks/count": { "get": { "tags": [ "Webhooks" ], "summary": "Retrieve count of Webhooks", "description": "Returns the total count of Webhooks records in the organization matching the current access context.", "operationId": "webhooksCount", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Int32CrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/webhooks/definitions": { "get": { "tags": [ "Webhooks" ], "summary": "Retrieve Webhook definitions", "description": "Each entry is a valid `entityName`, `operationName`, and `eventName` for creating a webhook. An entry with no `eventName` fires on every matching operation.", "operationId": "webhooksGetDefinitions", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDefinitionListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/webhooks/info": { "get": { "tags": [ "Webhooks" ], "summary": "Retrieve Webhooks metadata", "description": "Retrieves attribute information specific to the Webhooks type. This data changes rarely and Crelate recommends caching it.", "operationId": "webhooksGetInfo", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInfoCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/academichonors": { "get": { "tags": [ "Academic Honors" ], "summary": "Retrieve Academic Honors", "description": "Records must match all filters provided unless the OR filter operator is specified.\r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.\r\n If both recent and modified_after/modified_before are provided, recent will take precedence.", "operationId": "academicHonorsGetRecords", "parameters": [ { "name": "ids", "in": "query", "description": "The primary keys of Academic Honors to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Academic Honors that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Academic Honors that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "names", "in": "query", "description": "Filter the results by the following Academic Honors names.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. Highly recommended to set a sort_by if setting this", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "recent", "in": "query", "description": "Academic Honors that have been modified in the last recent minutes", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute\twith an optional direction e.g. \"CreatedOn asc\". Default direction of ascending if not provided", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAcademicHonorsListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAcademicHonorsListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } }, "post": { "tags": [ "Academic Honors" ], "summary": "Create an Academic Honor", "description": "Creates a new Academic Honors record and returns its generated ID.", "operationId": "academicHonorsCreate", "requestBody": { "description": "The record to create.", "content": { "application/json": { "schema": { "required": [ "entity" ], "properties": { "entity": { "$ref": "#/components/schemas/CreateAcademicHonors" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "409": { "description": "When duplicates are disabled or forbidden for the entity type(s) involved and completing the request would produce a duplicate record.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } } } } }, "/academichonors/{id}": { "get": { "tags": [ "Academic Honors" ], "summary": "Retrieve an Academic Honor", "description": "Returns a single Academic Honors record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "academicHonorsGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAcademicHonorsCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/academichonors/count": { "get": { "tags": [ "Academic Honors" ], "summary": "Retrieve count of Academic Honors", "description": "Returns the total count of Academic Honors records in the organization matching the current access context.", "operationId": "academicHonorsCount", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Int32CrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/academichonors/info": { "get": { "tags": [ "Academic Honors" ], "summary": "Retrieve Academic Honors metadata", "description": "Retrieves attribute information specific to the Academic Honors type. This data changes rarely and Crelate recommends caching it.", "operationId": "academicHonorsGetInfo", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInfoCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/accreditations": { "get": { "tags": [ "Accreditations" ], "summary": "Retrieve Accreditations", "description": "Records must match all filters provided unless the OR filter operator is specified.\r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.\r\n If both recent and modified_after/modified_before are provided, recent will take precedence.", "operationId": "accreditationsGetRecords", "parameters": [ { "name": "ids", "in": "query", "description": "The primary keys of Accreditations to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Accreditations that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Accreditations that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. Highly recommended to set a sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "recent", "in": "query", "description": "Accreditations that have been modified in the last recent minutes.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute\twith an optional direction e.g. \"CreatedOn asc\". Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "values", "in": "query", "description": "Filter the results by the following Accreditation values.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAccreditationsListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAccreditationsListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } }, "post": { "tags": [ "Accreditations" ], "summary": "Create an Accreditation", "description": "Creates a new Accreditations record and returns its generated ID.", "operationId": "accreditationsCreate", "requestBody": { "description": "The record to create.", "content": { "application/json": { "schema": { "required": [ "entity" ], "properties": { "entity": { "$ref": "#/components/schemas/CreateAccreditations" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "409": { "description": "When duplicates are disabled or forbidden for the entity type(s) involved and completing the request would produce a duplicate record.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } } } } }, "/accreditations/{id}": { "get": { "tags": [ "Accreditations" ], "summary": "Retrieve an Accreditation", "description": "Returns a single Accreditations record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "accreditationsGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAccreditationsCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/accreditations/count": { "get": { "tags": [ "Accreditations" ], "summary": "Retrieve count of Accreditations", "description": "Returns the total count of Accreditations records in the organization matching the current access context.", "operationId": "accreditationsCount", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Int32CrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/accreditations/info": { "get": { "tags": [ "Accreditations" ], "summary": "Retrieve Accreditations metadata", "description": "Retrieves attribute information specific to the Accreditations type. This data changes rarely and Crelate recommends caching it.", "operationId": "accreditationsGetInfo", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInfoCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/accreditinginstitutions": { "get": { "tags": [ "Accrediting Institutions" ], "summary": "Retrieve Accrediting Institutions", "description": "Records must match all filters provided unless the OR filter operator is specified.\r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.\r\n If both recent and modified_after/modified_before are provided, recent will take precedence.", "operationId": "accreditingInstitutionsGetRecords", "parameters": [ { "name": "ids", "in": "query", "description": "The primary keys of Accrediting Institutions to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Accrediting Institutions that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Accrediting Institutions that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "names", "in": "query", "description": "Filter the results by the following Accrediting Institution names.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. Highly recommended to set a sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "recent", "in": "query", "description": "Accrediting Institutions that have been modified in the last recent minutes.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute\twith an optional direction e.g. \"CreatedOn asc\". Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAccreditingInstitutionsListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAccreditingInstitutionsListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } }, "post": { "tags": [ "Accrediting Institutions" ], "summary": "Create an Accrediting Institution", "description": "Creates a new Accrediting Institutions record and returns its generated ID.", "operationId": "accreditingInstitutionsCreate", "requestBody": { "description": "The record to create.", "content": { "application/json": { "schema": { "required": [ "entity" ], "properties": { "entity": { "$ref": "#/components/schemas/CreateAccreditingInstitutions" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "409": { "description": "When duplicates are disabled or forbidden for the entity type(s) involved and completing the request would produce a duplicate record.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } } } } }, "/accreditinginstitutions/{id}": { "get": { "tags": [ "Accrediting Institutions" ], "summary": "Retrieve an Accrediting Institution", "description": "Returns a single Accrediting Institutions record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "accreditingInstitutionsGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAccreditingInstitutionsCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/accreditinginstitutions/count": { "get": { "tags": [ "Accrediting Institutions" ], "summary": "Retrieve count of Accrediting Institutions", "description": "Returns the total count of Accrediting Institutions records in the organization matching the current access context.", "operationId": "accreditingInstitutionsCount", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Int32CrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/accreditinginstitutions/info": { "get": { "tags": [ "Accrediting Institutions" ], "summary": "Retrieve Accrediting Institutions metadata", "description": "Retrieves attribute information specific to the Accrediting Institutions type. This data changes rarely and Crelate recommends caching it.", "operationId": "accreditingInstitutionsGetInfo", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInfoCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/activities/withattachments": { "post": { "tags": [ "Activities" ], "summary": "Create an Activity with Attachments", "description": "This endpoint allows creating a new Activity record and simultaneously uploading and linking one or more filesas Artifacts. Attachments included do not need to have any particular names; all files on the multi-part form aspart of a request will be saved.\r\nAdditionally, note that:\n* Only Email Activity Types and custom Activity Types that specifically allow attachments may be used.\n* Each attachment cannot be larger than 5MB.\n* The total size of all attachments may not exceed 10MB.\n* Up to 20 attachments may be included for Email Activity Types, providing they follow the aforementioned constraints.\n* All non-Email Activity Types that allow attachments may only have one attachment.", "operationId": "activitiesCreateWithAttachment", "requestBody": { "description": "An optional map of file names and Artifact Types indicating which files should use which Artifact Type. When omitted, the attached files will have no Artifact Type assigned.\n`entity`: The Activity record to create.\n`files`: File contents to add as attachments linked to the Activity being created.", "content": { "multipart/form-data": { "schema": { "required": [ "entity", "files" ], "properties": { "artifactTypeIdMap": { "type": "object", "additionalProperties": { "type": "string", "format": "uuid" } }, "entity": { "$ref": "#/components/schemas/CreateActivities" }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateFileStream" } } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiCreateOperationResponseCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/companies": { "get": { "tags": [ "Companies" ], "summary": "Retrieve Companies", "description": "Records must match all filters provided unless the OR filter operator is specified. \r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending \r\n If both recent and modified_after/modified_before are provided, recent will take precedence.", "operationId": "companiesGetRecords", "parameters": [ { "name": "created_after", "in": "query", "description": "Companies created after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "created_before", "in": "query", "description": "Companies created before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "departments", "in": "query", "description": "List of comma-separated departments to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "emails", "in": "query", "description": "List of comma-separated email addresses to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "external_primary_keys", "in": "query", "description": "External Primary Keys of Companies to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ids", "in": "query", "description": "The primary keys of Companies to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "last_activity_or_modified_after", "in": "query", "description": "Companies that have been modified or had activity after this date. Only one \"after\" date filter may be provided.", "schema": { "type": "string", "format": "date-time" } }, { "name": "last_activity_or_modified_before", "in": "query", "description": "Companies that have been modified or had activity before this date. Only one \"before\" date filter may be provided.", "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Companies that have been modified after this date. Only one \"after\" date filter may be provided.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Companies that have been modified before this date. Only one \"before\" date filter may be provided.", "schema": { "type": "string", "format": "date-time" } }, { "name": "names", "in": "query", "description": "List of comma-separated Company names to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. Highly recommended to set a sort_by if setting this", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "owner_ids", "in": "query", "description": "List of comma-separated owner (user) Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "parent_ids", "in": "query", "description": "List of comma-separated parent comapny Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "phone_numbers", "in": "query", "description": "List of comma-separated phone numbers to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "recent", "in": "query", "description": "Companies that have been modified in the last recent minutes.", "schema": { "type": "integer", "format": "int32" } }, { "name": "record_types", "in": "query", "description": "List of comma-separated record types to filter on. Possible values are: \n * `none`: No type\n * `customer`: Customer\n * `potential`: Potential Customer\n * `department`: Department", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute\twith an optional direction e.g. \"FirstName asc\". Default direction of ascending if not provided", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "statuses", "in": "query", "description": "List of comma-separated status Ids to filter on.", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "tag_ids", "in": "query", "description": "List of comma-separated tag Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "tag_names", "in": "query", "description": "List of comma-separated tag names to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveCompaniesListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveCompaniesListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } }, "post": { "tags": [ "Companies" ], "summary": "Create a Company", "description": "Creates a new Companies record and returns its generated ID.", "operationId": "companiesCreate", "requestBody": { "description": "The record to create.", "content": { "application/json": { "schema": { "required": [ "entity" ], "properties": { "entity": { "$ref": "#/components/schemas/CreateCompanies" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "409": { "description": "When duplicates are disabled or forbidden for the entity type(s) involved and completing the request would produce a duplicate record.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } } } } }, "/companies/{companyId}/contacts": { "get": { "tags": [ "Companies" ], "summary": "Retrieve Contacts related to a Company", "description": "Retrieves Contacts related to a Company through their employment history.\r\n By default, only returns Contacts with current employment status at the specified Company. The `include_former` parameter is part of the Company relationship itself and is never affected by the filter operator used for optional parameters like `statuses`.", "operationId": "companiesGetCompanyContacts", "parameters": [ { "name": "companyId", "in": "path", "description": "The ID of the Company whose contacts to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "include_former", "in": "query", "description": "If true, contacts who previously (but no longer) worked at the Company are included. Defaults to false, which returns only contacts currently working there.", "schema": { "type": "boolean", "default": false } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "owner_ids", "in": "query", "description": "List of Crelate User Ids to filter Contacts by owner.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "record_types", "in": "query", "description": "List of comma-separated record types to filter on. Possible values are: \n * `candidate`: Candidate\n * `sales`: Sales/Client Contact\n * `lead`: Lead Contact\n * `employee`: Employee\n * `time_approver`: Time Approver", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"FirstName asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "statuses", "in": "query", "description": "List of comma-separated record status values to filter on.", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "tag_ids", "in": "query", "description": "List of comma-separated tag Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveContactsListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveContactsListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/companies/{id}": { "get": { "tags": [ "Companies" ], "summary": "Retrieve a Company", "description": "Returns a single Companies record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "companiesGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveCompaniesCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } }, "patch": { "tags": [ "Companies" ], "summary": "Update a Company", "description": "Partially updates an existing Companies record. Only fields included in the request body are modified; omitted fields are left unchanged.", "operationId": "companiesUpdate", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to update.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The record to update.", "content": { "application/json": { "schema": { "required": [ "entity" ], "properties": { "entity": { "$ref": "#/components/schemas/UpdateCompanies" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } }, "delete": { "tags": [ "Companies" ], "summary": "Delete a Company", "description": "Permanently deletes a Company record by its unique identifier.", "operationId": "companiesDelete", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to delete.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/companies/bulk": { "post": { "tags": [ "Companies" ], "summary": "Create Companies in bulk", "description": "The IDs of the created records will be returned in the order the records were provided in the request. This operation is all or nothing; partial success scenarios, where some records are created and some fail, are not supported.", "operationId": "companiesCreateBulk", "requestBody": { "content": { "application/json": { "schema": { "required": [ "entities" ], "properties": { "entities": { "type": "array", "items": { "$ref": "#/components/schemas/CreateCompanies" }, "description": "The records to create. Up to 50 may be provided." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidIEnumerableCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "409": { "description": "When duplicates are disabled or forbidden for the entity type(s) involved and completing the request would produce a duplicate record.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } } } }, "patch": { "tags": [ "Companies" ], "summary": "Update Companies in bulk", "description": "This operation is all or nothing; partial success scenarios, where some records are updated and some fail, are not supported.", "operationId": "companiesUpdateBulk", "requestBody": { "content": { "application/json": { "schema": { "required": [ "entities" ], "properties": { "entities": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateCompanies" }, "description": "The records to update. Up to 50 may be provided." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } }, "delete": { "tags": [ "Companies" ], "summary": "Delete Companies in bulk", "description": "This operation is all or nothing; partial success scenarios, where some records are deleted and some fail, are not supported.", "operationId": "companiesDeleteBulk", "requestBody": { "content": { "application/json": { "schema": { "required": [ "ids" ], "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The primary keys of the records to delete. Up to 50 may be provided." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/companies/changeStatus/{id}": { "patch": { "tags": [ "Companies" ], "summary": "Update Company record status", "description": "Available statuses can be retrieved by inspecting the results of the Companies metadata endpoint under the `EntityStatus` field.", "operationId": "companiesChangeCompanyEntityStatus", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to update.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "newStatus": { "type": "integer", "description": "The new record status value to set. One of newStatus or newStatusName must be provided.", "format": "int32" }, "newStatusName": { "type": "string", "description": "The new record status name to set the value to. One of newStatus or newStatusName must be provided." }, "statusReason": { "type": "string", "description": "An optional reason or explanation for the status change." } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/companies/changeStatus/bulk": { "patch": { "tags": [ "Companies" ], "summary": "Update Company record status in bulk", "description": "Available statuses can be retrieved by inspecting the results of the Companies metadata endpoint under the `EntityStatus` field.", "operationId": "companiesChangeCompanyEntityStatusBulk", "requestBody": { "content": { "application/json": { "schema": { "required": [ "ids" ], "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The primary key(s) of the record(s) to update." }, "newStatus": { "type": "integer", "description": "The new record status value to set. One of newStatus or newStatusName must be provided.", "format": "int32" }, "newStatusName": { "type": "string", "description": "The new record status name to set the value to. One of newStatus or newStatusName must be provided." }, "statusReason": { "type": "string", "description": "An optional reason or explanation for the status change." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/companies/count": { "get": { "tags": [ "Companies" ], "summary": "Retrieve count of Companies", "description": "Returns the total count of Companies records in the organization matching the current access context.", "operationId": "companiesCount", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Int32CrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/companies/info": { "get": { "tags": [ "Companies" ], "summary": "Retrieve Companies metadata", "description": "Retrieves attribute information specific to the Companies type. This data changes rarely and Crelate recommends caching it.", "operationId": "companiesGetInfo", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInfoCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/companies/list/{listId}": { "get": { "tags": [ "Companies" ], "summary": "Retrieve Companies by list", "description": "Returns Companies records that belong to the specified saved list.", "operationId": "companiesGetByList", "parameters": [ { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "listId", "in": "path", "description": "ID of the static list.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"Name asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveCompaniesListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveCompaniesListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/companies/search": { "get": { "tags": [ "Companies" ], "summary": "Search all Companies", "description": "Performs a keyword search against all Company records, returning any matches. A Company matches when every word of the query matches the start of a word in its name, when the query is the start of one of its phone numbers (at least 3 digits), when the query equals one of its email addresses, when the query equals the city or city and state (such as \"Harrisburg PA\") of any of its addresses, or when the query contains the ZIP or postal code of any of its addresses. City matching ignores case, treats a hyphen and a space between words the same, and compares the whole query, so \"Winston Salem\" matches \"Winston-Salem\" and \"Salt Lake\" matches a city of \"Salt Lake\" but not \"Salt Lake City\". Name matches are weighted above address matches. Website and other fields are not searched. The returned record information is intentionally limited with the intent of full data retrieval being used with a more specific query, such as a collection of GUID Id values.", "operationId": "companiesSearchCompanies", "parameters": [ { "name": "limit", "in": "query", "description": "The maximum number of results to return.", "schema": { "maximum": 200, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } }, { "name": "query", "in": "query", "description": "The keyword query to search against Companies with.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalSearchResultListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/companysources": { "get": { "tags": [ "Company Sources" ], "summary": "Retrieve Company Sources", "description": "Records must match all filters provided unless the OR filter operator is specified.\r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.", "operationId": "companySourcesGetRecords", "parameters": [ { "name": "ids", "in": "query", "description": "The primary keys of Company Sources to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"FirstName asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveCompanySourcesListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveCompanySourcesListCrelateResponse" } } } } } } }, "/companysources/{id}": { "get": { "tags": [ "Company Sources" ], "summary": "Retrieve a Company Source", "description": "Returns a single Company Sources record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "companySourcesGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveCompanySourcesCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/contactsources": { "get": { "tags": [ "Contact Sources" ], "summary": "Retrieve Contact Sources", "description": "Records must match all filters provided unless the OR filter operator is specified. \r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending \r\n If both recent and modified_after/modified_before are provided, recent will take precedence.", "operationId": "contactSourcesGetRecords", "parameters": [ { "name": "external_primary_keys", "in": "query", "description": "External Primary Keys of Contact Sources to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ids", "in": "query", "description": "The primary keys of Contact Sources to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Contact Sources that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Contact Sources that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "names", "in": "query", "description": "List of comma-separated Contact Source names to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. Highly recommended to set a sort_by if setting this", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "recent", "in": "query", "description": "Contact Sources that have been modified in the last recent minutes.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute\twith an optional direction e.g. \"FirstName asc\". Default direction of ascending if not provided", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveContactSourcesListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveContactSourcesListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/contactsources/{id}": { "get": { "tags": [ "Contact Sources" ], "summary": "Retrieve a Contact Source", "description": "Returns a single Contact Sources record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "contactSourcesGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveContactSourcesCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/contacts": { "get": { "tags": [ "Contacts" ], "summary": "Retrieve Contacts", "description": "Records must match all filters provided unless the OR filter operator is specified.\r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.\r\n If both recent and modified_after/modified_before are provided, recent will take precedence.\r\ncities, states and zip_codes match any of a Contact's addresses, and when combined they must all match the same address.\r\nnear matches Contacts with any address within radius_miles of the place. Distance is measured from each address's stored coordinates, or from the center of its ZIP code or city when it has none, so treat results as approximate to within a ZIP code. An address saved moments ago may take a short time to be found. A radius that matches more than 100,000 Contacts is rejected; use a smaller radius.", "operationId": "contactsGetRecords", "parameters": [ { "name": "cities", "in": "query", "description": "List of comma-separated cities to filter on. Matches exactly, ignoring case.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "created_after", "in": "query", "description": "Contacts created after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "created_before", "in": "query", "description": "Contacts created before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "emails", "in": "query", "description": "List of comma-separated email addresses to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "external_primary_keys", "in": "query", "description": "External Primary Keys of Contacts to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ids", "in": "query", "description": "The primary keys of Contacts to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "job_ids", "in": "query", "description": "List of comma-separated job Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "last_activity_or_modified_after", "in": "query", "description": "Contacts that have been modified or had activity after this date. Only one \"after\" date filter may be provided.", "schema": { "type": "string", "format": "date-time" } }, { "name": "last_activity_or_modified_before", "in": "query", "description": "Contacts that have been modified or had activity before this date. Only one \"before\" date filter may be provided.", "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Contacts that have been modified after this date. Only one \"after\" date filter may be provided.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Contacts that have been modified before this date. Only one \"before\" date filter may be provided.", "schema": { "type": "string", "format": "date-time" } }, { "name": "near", "in": "query", "description": "A ZIP or postal code, or a city and state such as \"Racine, WI\". Matches Contacts with any address within radius_miles of it. A place that cannot be found is rejected.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. Highly recommended to set a sort_by if setting this", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "owner_ids", "in": "query", "description": "List of comma-separated owner (user) Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "phone_numbers", "in": "query", "description": "List of comma-separated phone numbers to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "radius_miles", "in": "query", "description": "Radius around near, in miles, from 1 to 500. Defaults to 25. Requires near.", "schema": { "maximum": 500, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "recent", "in": "query", "description": "Contacts that have been modified in the last recent minutes.", "schema": { "type": "integer", "format": "int32" } }, { "name": "record_types", "in": "query", "description": "List of comma-separated record types to filter on. Possible values are: \n * `candidate`: Candidate\n * `sales`: Sales/Client Contact\n * `lead`: Lead Contact\n * `employee`: Employee\n * `time_approver`: Time Approver", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute\twith an optional direction e.g. \"FirstName asc\". Default direction of ascending if not provided", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "states", "in": "query", "description": "List of comma-separated states or provinces to filter on, as a two-letter abbreviation or full name. Either form matches addresses saved with the other.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "statuses", "in": "query", "description": "List of comma-separated status Ids to filter on.", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "tag_ids", "in": "query", "description": "List of comma-separated tag Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "tag_names", "in": "query", "description": "List of comma-separated tag names to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "zip_codes", "in": "query", "description": "List of comma-separated ZIP or postal codes to filter on. Matches exactly.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveContactsListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveContactsListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } }, "post": { "tags": [ "Contacts" ], "summary": "Create a Contact", "description": "Creates a new Contacts record and returns its generated ID.", "operationId": "contactsCreate", "requestBody": { "description": "The record to create.", "content": { "application/json": { "schema": { "required": [ "entity" ], "properties": { "entity": { "$ref": "#/components/schemas/CreateContacts" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "409": { "description": "When duplicates are disabled or forbidden for the entity type(s) involved and completing the request would produce a duplicate record.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } } } } }, "/contacts/{id}": { "get": { "tags": [ "Contacts" ], "summary": "Retrieve a Contact", "description": "Returns a single Contacts record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "contactsGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveContactsCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } }, "patch": { "tags": [ "Contacts" ], "summary": "Update a Contact", "description": "Partially updates an existing Contacts record. Only fields included in the request body are modified; omitted fields are left unchanged.", "operationId": "contactsUpdate", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to update.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The record to update.", "content": { "application/json": { "schema": { "required": [ "entity" ], "properties": { "entity": { "$ref": "#/components/schemas/UpdateContacts" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } }, "delete": { "tags": [ "Contacts" ], "summary": "Delete a Contact", "description": "Permanently deletes a Contact record by its unique identifier.", "operationId": "contactsDelete", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to delete.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/contacts/bulk": { "post": { "tags": [ "Contacts" ], "summary": "Create Contacts in bulk", "description": "The IDs of the created records will be returned in the order the records were provided in the request. This operation is all or nothing; partial success scenarios, where some records are created and some fail, are not supported.", "operationId": "contactsCreateBulk", "requestBody": { "content": { "application/json": { "schema": { "required": [ "entities" ], "properties": { "entities": { "type": "array", "items": { "$ref": "#/components/schemas/CreateContacts" }, "description": "The records to create. Up to 50 may be provided." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidIEnumerableCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "409": { "description": "When duplicates are disabled or forbidden for the entity type(s) involved and completing the request would produce a duplicate record.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } } } }, "patch": { "tags": [ "Contacts" ], "summary": "Update Contacts in bulk", "description": "This operation is all or nothing; partial success scenarios, where some records are updated and some fail, are not supported.", "operationId": "contactsUpdateBulk", "requestBody": { "content": { "application/json": { "schema": { "required": [ "entities" ], "properties": { "entities": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateContacts" }, "description": "The records to update. Up to 50 may be provided." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } }, "delete": { "tags": [ "Contacts" ], "summary": "Delete Contacts in bulk", "description": "This operation is all or nothing; partial success scenarios, where some records are deleted and some fail, are not supported.", "operationId": "contactsDeleteBulk", "requestBody": { "content": { "application/json": { "schema": { "required": [ "ids" ], "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The primary keys of the records to delete. Up to 50 may be provided." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/contacts/changeStatus/{id}": { "patch": { "tags": [ "Contacts" ], "summary": "Update Contact record status", "description": "Available statuses can be retrieved by inspecting the results of the Contacts metadata endpoint under the `EntityStatus` field.", "operationId": "contactsChangeContactEntityStatus", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to update.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "newStatus": { "type": "integer", "description": "The new record status value to set. One of newStatus or newStatusName must be provided.", "format": "int32" }, "newStatusName": { "type": "string", "description": "The new record status name to set the value to. One of newStatus or newStatusName must be provided." }, "statusReason": { "type": "string", "description": "An optional reason or explanation for the status change." } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/contacts/changeStatus/bulk": { "patch": { "tags": [ "Contacts" ], "summary": "Update Contact record status in bulk", "description": "Available statuses can be retrieved by inspecting the results of the Contacts metadata endpoint under the `EntityStatus` field.", "operationId": "contactsChangeContactEntityStatusBulk", "requestBody": { "content": { "application/json": { "schema": { "required": [ "ids" ], "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The primary key(s) of the record(s) to update." }, "newStatus": { "type": "integer", "description": "The new record status value to set. One of newStatus or newStatusName must be provided.", "format": "int32" }, "newStatusName": { "type": "string", "description": "The new record status name to set the value to. One of newStatus or newStatusName must be provided." }, "statusReason": { "type": "string", "description": "An optional reason or explanation for the status change." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/contacts/count": { "get": { "tags": [ "Contacts" ], "summary": "Retrieve count of Contacts", "description": "Returns the total count of Contacts records in the organization matching the current access context.", "operationId": "contactsCount", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Int32CrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/contacts/history": { "get": { "tags": [ "Contacts" ], "summary": "Retrieve stage change history", "description": "As contacts move through workflows, snapshots of each stage they pass through are recorded. This operation retrieves stage change history for Contacts, and can optionally be filtered down to one or more Contacts and/or Jobs.", "operationId": "contactsGetContactWorkflowHistory", "parameters": [ { "name": "contact_ids", "in": "query", "description": "An optional comma-separated list of Contacts to get stage change history for.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "created_after", "in": "query", "description": "Stage change history records for a stage change that occurred after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "created_before", "in": "query", "description": "Stage change history records for a stage change that occurred before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "include_pass_reasons", "in": "query", "description": "Whether to include pass reason details on stage changes that resulted in a pass.", "schema": { "type": "boolean", "default": false } }, { "name": "job_ids", "in": "query", "description": "An optional comma-separated list of Jobs to get stage change history for.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Stage change history records that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Stage change history records that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "recent", "in": "query", "description": "Stage change history records that have been modified in the last recent minutes", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"FirstName asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactWorkflowHistoryDetailPagedListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactWorkflowHistoryDetailPagedListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/contacts/info": { "get": { "tags": [ "Contacts" ], "summary": "Retrieve Contacts metadata", "description": "Retrieves attribute information specific to the Contacts type. This data changes rarely and Crelate recommends caching it.", "operationId": "contactsGetInfo", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInfoCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/contacts/list/{listId}": { "get": { "tags": [ "Contacts" ], "summary": "Retrieve Contacts by list", "description": "Returns Contacts records that belong to the specified saved list.", "operationId": "contactsGetByList", "parameters": [ { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "listId", "in": "path", "description": "ID of the static list.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"Name asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveContactsListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveContactsListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/contacts/search": { "get": { "tags": [ "Contacts" ], "summary": "Search all Contacts", "description": "Performs a keyword search against all Contact records, returning any matches. A Contact matches when every word of the query matches the start of a word in its name, when the query equals its Contact number, when the query is the start of one of its phone numbers (at least 3 digits), when the query equals one of its email addresses, when the query equals the city or city and state (such as \"Harrisburg PA\") of any of its addresses, or when the query contains the ZIP or postal code of any of its addresses. City matching ignores case, treats a hyphen and a space between words the same, and compares the whole query, so \"Winston Salem\" matches \"Winston-Salem\" and \"Salt Lake\" matches a city of \"Salt Lake\" but not \"Salt Lake City\". Name matches are weighted above address matches. Website and other fields are not searched. The returned record information is intentionally limited with the intent of full data retrieval being used with a more specific query, such as a collection of GUID Id values.", "operationId": "contactsSearchContacts", "parameters": [ { "name": "limit", "in": "query", "description": "The maximum number of results to return.", "schema": { "maximum": 200, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } }, { "name": "query", "in": "query", "description": "The keyword query to search against Contacts with.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalSearchResultListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/countries": { "get": { "tags": [ "Countries" ], "summary": "Retrieve Countries", "description": "Records must match all filters provided unless the OR filter operator is specified.\r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.", "operationId": "countriesGetRecords", "parameters": [ { "name": "ids", "in": "query", "description": "The primary keys of Countries to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "name", "in": "query", "description": "A name or partial match of country names to filter to.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"FirstName asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveCountriesListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveCountriesListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/countries/{id}": { "get": { "tags": [ "Countries" ], "summary": "Retrieve a Country", "description": "Returns a single Countries record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "countriesGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveCountriesCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/custompicklistitems": { "get": { "tags": [ "Custom Picklist Items" ], "summary": "Retrieve Custom Picklist Items", "description": "Records must match all filters provided unless the OR filter operator is specified.\r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.\r\n If both recent and modified_after/modified_before are provided, recent will take precedence.", "operationId": "customPicklistItemsGetRecords", "parameters": [ { "name": "custom_picklist_set_id", "in": "query", "description": "The custom picklist set to get picklist items for.", "schema": { "type": "string", "format": "uuid" } }, { "name": "external_primary_keys", "in": "query", "description": "External Primary Keys of Custom Picklist Items to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ids", "in": "query", "description": "The primary keys of Custom Picklist Items to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Custom picklist items that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Custom picklist items that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "recent", "in": "query", "description": "Custom picklist items that have been modified in the last recent minutes", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"FirstName asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveCustomPicklistItemsListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveCustomPicklistItemsListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/custompicklistsets": { "get": { "tags": [ "Custom Picklist Sets" ], "summary": "Retrieve Custom Picklist Sets", "description": "Records must match all filters provided unless the OR filter operator is specified.\r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.\r\n If both recent and modified_after/modified_before are provided, recent will take precedence.", "operationId": "customPicklistSetsGetRecords", "parameters": [ { "name": "external_primary_keys", "in": "query", "description": "External Primary Keys of Custom Picklist Sets to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ids", "in": "query", "description": "The primary keys of Custom Picklist Sets to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Custom Picklist Sets that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Custom Picklist Sets that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "recent", "in": "query", "description": "Custom Picklist Sets that have been modified in the last recent minutes", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"FirstName asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveCustomPicklistSetsListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveCustomPicklistSetsListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/custompicklistsets/{id}": { "get": { "tags": [ "Custom Picklist Sets" ], "summary": "Retrieve a Custom Picklist Set", "description": "Returns a single Custom Picklist Sets record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "customPicklistSetsGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveCustomPicklistSetsCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/jobtitles": { "get": { "tags": [ "Job Titles" ], "summary": "Retrieve Job Titles", "description": "Records must match all filters provided unless the OR filter operator is specified.\r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.\r\n If both recent and modified_after/modified_before are provided, recent will take precedence.", "operationId": "jobTitlesGetRecords", "parameters": [ { "name": "ids", "in": "query", "description": "The primary keys of Job Titles to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Job Titles that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Job Titles that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "recent", "in": "query", "description": "Job Titles that have been modified in the last recent minutes", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"FirstName asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveJobTitlesListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveJobTitlesListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/jobtitles/{id}": { "get": { "tags": [ "Job Titles" ], "summary": "Retrieve a Job Title", "description": "Returns a single Job Titles record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "jobTitlesGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveJobTitlesCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/jobtypes": { "get": { "tags": [ "Job Types" ], "summary": "Retrieve Job Types", "description": "Records must match all filters provided unless the OR filter operator is specified.\r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.\r\n If both recent and modified_after/modified_before are provided, recent will take precedence.", "operationId": "jobTypesGetRecords", "parameters": [ { "name": "ids", "in": "query", "description": "The primary keys of Job Types to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Job Types that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Job Types that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "recent", "in": "query", "description": "Job Types that have been modified in the last recent minutes", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"FirstName asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveJobTypesListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveJobTypesListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/jobs": { "get": { "tags": [ "Jobs" ], "summary": "Retrieve Jobs", "description": "Returns a paged, filterable list of job records. Supports filtering by stage, company, tags, candidates, and more.\r\n Whether a Job is open comes from the MeaningId of its sales stage, not the stage name: \"New\" and \"In Progress\" are open; \"Done\", \"Done, Positive Outcome\" and \"Done, Negative Outcome\" are closed. published = true returns only open Jobs that are also published to the job portal.\r\n Fee, ActualValue, PotentialValue and ExpectedValue are not reconciled with Placement Value or Fee. The server never derives ActualValue from placements, but when a Placement is created the app offers to add its Value to the Job's ActualValue, so ActualValue often already includes Placement Values; do not add them together. ExpectedValue is PotentialValue * Probability / 100 unless it is set directly. For a parent Job whose opportunity type sums its child Jobs, ActualValue, PotentialValue and ExpectedValue are the sums of the child Jobs.", "operationId": "jobsGetRecords", "parameters": [ { "name": "assignment_ids", "in": "query", "description": "Filter jobs to those that have active assignments matching these IDs.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "candidate_ids", "in": "query", "description": "List of comma-separated contact Ids to filter on where returned Jobs have any of the provided contacts as candidates.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "closed_after", "in": "query", "description": "Jobs whose user-set close date is after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "closed_before", "in": "query", "description": "Jobs whose user-set close date is before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "company_ids", "in": "query", "description": "List of comma-separated Company Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "external_primary_keys", "in": "query", "description": "External Primary Keys of Jobs to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ids", "in": "query", "description": "List of comma-separated Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "job_codes", "in": "query", "description": "List of comma-separated Job codes to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "job_numbers", "in": "query", "description": "List of comma-separated Job Numbers to filter on.", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "last_activity_or_modified_after", "in": "query", "description": "JobEntity that have been modified or had activity after this date. Only one \"after\" date filter may be provided.", "schema": { "type": "string", "format": "date-time" } }, { "name": "last_activity_or_modified_before", "in": "query", "description": "JobEntity that have been modified or had activity before this date. Only one \"before\" date filter may be provided.", "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "JobEntity that have been modified after this date. Only one \"after\" date filter may be provided.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "JobEntity that have been modified before this date. Only one \"before\" date filter may be provided.", "schema": { "type": "string", "format": "date-time" } }, { "name": "name", "in": "query", "description": "A loosely-matched (like/contains) string to filter by Job name.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. Highly recommended to set a sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "open", "in": "query", "description": "If true, only Jobs whose sales stage has an open meaning (\"New\" or \"In Progress\"). If false, only Jobs whose sales stage has a closed meaning (\"Done\", \"Done, Positive Outcome\" or \"Done, Negative Outcome\"). Jobs in a stage whose meaning is \"Related\", or with no sales stage, match neither true nor false. Leads are not excluded.", "schema": { "type": "boolean" } }, { "name": "opened_after", "in": "query", "description": "Jobs whose user-set open date is after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "opened_before", "in": "query", "description": "Jobs whose user-set open date is before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "opportunity_type_ids", "in": "query", "description": "List of comma-separated Opportunity Type Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "owner_ids", "in": "query", "description": "List of comma-separated owner (user) Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "published", "in": "query", "description": "If the filtered records are published. If filtering to published Jobs, they must also not be hidden from the portal, not in a workflow status with a closed meaning, and have a portal title and description.", "schema": { "type": "boolean" } }, { "name": "recent", "in": "query", "description": "Jobs that have been modified in the last recent minutes.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma-separated sort options. Each option is a field name with an optional direction, e.g. \"UserOpenDate desc\". Default direction of ascending if not provided. A field can be sorted on when its ValidFor list in the jobs metadata (GET /jobs/info) includes \"sort\". When paging with offset, end with JobNum so jobs sharing a sort value are less likely to be repeated or skipped between pages, e.g. \"UserOpenDate desc,JobNum\". JobNum can be blank or duplicated, so this does not fully prevent it.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "statuses", "in": "query", "description": "List of comma-separated Sales Workflow Status Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "tag_ids", "in": "query", "description": "List of comma-separated tag Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "tag_names", "in": "query", "description": "List of comma-separated tag names to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "zip_codes", "in": "query", "description": "List of comma-separated ZIP codes to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "The set of RetrieveOptions to use.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveJobsListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveJobsListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "description": "Tell open jobs from closed ones by the MeaningId of the sales stage, not the stage name. published=true returns only open jobs that are also published to the job portal. The server does not reconcile job Fee or ActualValue with placement Value or Fee, but when a placement is created the app offers to add its Value to the job's ActualValue, so ActualValue often already includes placement Values; do not add them together. ExpectedValue is PotentialValue * Probability / 100 unless set directly. When a parent job's opportunity type sums its child jobs, its ActualValue, PotentialValue and ExpectedValue already total the children, so do not add parent and child values.", "scope": "crelate.mcp.read.bulk" } }, "post": { "tags": [ "Jobs" ], "summary": "Create a Job", "description": "Creates a new Jobs record and returns its generated ID.", "operationId": "jobsCreate", "requestBody": { "description": "The record to create.", "content": { "application/json": { "schema": { "required": [ "entity" ], "properties": { "entity": { "$ref": "#/components/schemas/CreateJobs" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "409": { "description": "When duplicates are disabled or forbidden for the entity type(s) involved and completing the request would produce a duplicate record.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } } } } }, "/jobs/{id}": { "get": { "tags": [ "Jobs" ], "summary": "Retrieve a Job", "description": "Returns a single Jobs record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "jobsGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveJobsCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } }, "patch": { "tags": [ "Jobs" ], "summary": "Update a Job", "description": "Partially updates an existing Jobs record. Only fields included in the request body are modified; omitted fields are left unchanged.", "operationId": "jobsUpdate", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to update.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The record to update.", "content": { "application/json": { "schema": { "required": [ "entity" ], "properties": { "entity": { "$ref": "#/components/schemas/UpdateJobs" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } }, "delete": { "tags": [ "Jobs" ], "summary": "Delete a Job", "description": "Permanently deletes a Job record by its unique identifier.", "operationId": "jobsDelete", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to delete.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/jobs/{jobId}/contact/{contactId}": { "post": { "tags": [ "Jobs" ], "summary": "Add Contact to a Job", "description": "Adds a single contact to the specified job's recruiting pipeline at the given workflow stage.", "operationId": "jobsAddContactToJob", "parameters": [ { "name": "contactId", "in": "path", "description": "The Id of the Contact to add to the Job.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "jobId", "in": "path", "description": "The Id of the Job to add the Contact to.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "statusId": { "type": "string", "description": "The primary key of the status to set for the Contact on the Job. Either this or statusName must be provided.", "format": "uuid" }, "statusName": { "type": "string", "description": "The name of the status to set for the Contact on the Job. Either this or statusId must be provided." } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/jobs/{jobId}/contacts": { "post": { "tags": [ "Jobs" ], "summary": "Add Contacts to a Job", "description": "Adds one or more contacts to the specified job's recruiting pipeline at the given workflow stage.", "operationId": "jobsAddContactsToJob", "parameters": [ { "name": "contact_ids", "in": "query", "description": "List of comma-separated Contact ids to add to the Job.", "required": true, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "jobId", "in": "path", "description": "The Id of the Job to add the Contact to.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "statusId": { "type": "string", "description": "The primary key of the status to set for the Contact on the Job. Either this or statusName must be provided.", "format": "uuid" }, "statusName": { "type": "string", "description": "The name of the status to set for the Contact on the Job. Either this or statusId must be provided." } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "409": { "description": "When duplicates are disabled or forbidden for the entity type(s) involved and completing the request would produce a duplicate record.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } } } } }, "/jobs/{jobId}/contacts/{contactId}": { "patch": { "tags": [ "Jobs" ], "summary": "Update Contact status on a Job", "description": "This endpoint does not support handling workflow rules. Consider migrating to the [Workflow Stage](#tag/Workflow-Stages) endpoints for API-supported workflow rule interactions.", "operationId": "jobsUpdateContactWorkflowStatus", "parameters": [ { "name": "contactId", "in": "path", "description": "The Id of the Contact.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "jobId", "in": "path", "description": "The Id of the Job.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "comment": { "type": "string", "description": "An optional comment for the stage change to include in the activity stream. This comment is ignored if the destination stage does not prompt for notes or does not create an activity." }, "statusId": { "type": "string", "description": "The Id of the status.", "format": "uuid" }, "statusName": { "type": "string", "description": "The name of the status." } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "409": { "description": "When duplicates are disabled or forbidden for the entity type(s) involved and completing the request would produce a duplicate record.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } } } }, "delete": { "tags": [ "Jobs" ], "summary": "Remove Contact from a Job", "description": "Removes a contact from the specified job's recruiting pipeline.", "operationId": "jobsRemoveContact", "parameters": [ { "name": "contactId", "in": "path", "description": "Id of the Contact.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "jobId", "in": "path", "description": "Id of the Job.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/jobs/{jobId}/contacts/history": { "get": { "tags": [ "Jobs" ], "summary": "Retrieve candidate stage change history", "description": "As candidates (contacts) move through workflows, snapshots of each stage they pass through are recorded. This operation retrieves candidate stage change history for a given Job and can optionally be filtered down to one particular contact's history on a Job.", "operationId": "jobsGetContactWorkflowHistory", "parameters": [ { "name": "contact_id", "in": "query", "description": "An optional contact to filter stage change history on the Job to.", "schema": { "type": "string", "format": "uuid" } }, { "name": "created_after", "in": "query", "description": "Stage change history records for a stage change that occurred after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "created_before", "in": "query", "description": "Stage change history records for a stage change that occurred before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "include_pass_reasons", "in": "query", "description": "Whether to include pass reason details on stage changes that resulted in a pass.", "schema": { "type": "boolean", "default": false } }, { "name": "jobId", "in": "path", "description": "The Job to get stage change history for.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Stage change history records that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Stage change history records that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "recent", "in": "query", "description": "Stage change history records that have been modified in the last recent minutes", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"FirstName asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactWorkflowHistoryDetailPagedListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactWorkflowHistoryDetailPagedListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/jobs/{jobId}/posting": { "patch": { "tags": [ "Jobs" ], "summary": "Update a Job posting", "description": "Updates the public-facing portal posting details for a job, such as title, description, location, and compensation. Only posting-specific fields are accepted; other job fields are ignored.", "operationId": "jobsUpdateJobPosting", "parameters": [ { "name": "jobId", "in": "path", "description": "The Id of the Job.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The job posting fields to update. Only portal-specific fields are accepted.", "content": { "application/json": { "schema": { "required": [ "entity" ], "properties": { "entity": { "$ref": "#/components/schemas/UpdateJobPostings" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } }, "delete": { "tags": [ "Jobs" ], "summary": "Disable a Job posting", "description": "Disables the job's portal posting and removes it from any free job boards it was published to. The job record itself is not deleted.", "operationId": "jobsDisableJobPosting", "parameters": [ { "name": "jobId", "in": "path", "description": "The Id of the Job.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/jobs/{jobId}/posting/applylink": { "post": { "tags": [ "Jobs" ], "summary": "Create a Job posting apply link for a Contact", "description": "Returns a Job's portal URL with a secure token. When the Contact applies from it, the apply form is prefilled with their first name, last name, primary email and primary phone, and the submitted application is linked to them. The Job must be posted to the portal. Identify the Contact by its Crelate Id or by its External Primary Key; the Id is used when both are given, and the key must match exactly one Contact you can read.", "operationId": "jobsCreateApplyLink", "parameters": [ { "name": "jobId", "in": "path", "description": "The Id of the Job.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "contactId": { "type": "string", "description": "The Crelate Id of the Contact. Used in preference to externalPrimaryKey.", "format": "uuid" }, "contactSource": { "type": "string", "description": "Optional Contact Source to record on the application, added to the URL. It is matched to one of your Contact Sources by name, ignoring case, with spaces treated as underscores and any other character outside letters, digits, `.`, `_`, `~` and `-` treated as a hyphen." }, "externalPrimaryKey": { "type": "string", "description": "The External Primary Key stored on the Contact, used when contactId is not given." } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/jobs/bulk": { "post": { "tags": [ "Jobs" ], "summary": "Create Jobs in bulk", "description": "The IDs of the created records will be returned in the order the records were provided in the request. This operation is all or nothing; partial success scenarios, where some records are created and some fail, are not supported.", "operationId": "jobsCreateBulk", "requestBody": { "content": { "application/json": { "schema": { "required": [ "entities" ], "properties": { "entities": { "type": "array", "items": { "$ref": "#/components/schemas/CreateJobs" }, "description": "The records to create. Up to 50 may be provided." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidIEnumerableCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "409": { "description": "When duplicates are disabled or forbidden for the entity type(s) involved and completing the request would produce a duplicate record.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } } } }, "patch": { "tags": [ "Jobs" ], "summary": "Update Jobs in bulk", "description": "This operation is all or nothing; partial success scenarios, where some records are updated and some fail, are not supported.", "operationId": "jobsUpdateBulk", "requestBody": { "content": { "application/json": { "schema": { "required": [ "entities" ], "properties": { "entities": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateJobs" }, "description": "The records to update. Up to 50 may be provided." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } }, "delete": { "tags": [ "Jobs" ], "summary": "Delete Jobs in bulk", "description": "This operation is all or nothing; partial success scenarios, where some records are deleted and some fail, are not supported.", "operationId": "jobsDeleteBulk", "requestBody": { "content": { "application/json": { "schema": { "required": [ "ids" ], "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The primary keys of the records to delete. Up to 50 may be provided." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/jobs/count": { "get": { "tags": [ "Jobs" ], "summary": "Retrieve count of Jobs", "description": "Returns the total count of Jobs records in the organization matching the current access context.", "operationId": "jobsCount", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Int32CrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/jobs/history": { "get": { "tags": [ "Jobs" ], "summary": "Retrieve Job stage change history", "description": "Returns a paged history of stage changes for jobs in the organization's sales pipeline.", "operationId": "jobsGetJobWorkflowHistory", "parameters": [ { "name": "created_after", "in": "query", "description": "Stage change history records for a stage change that occurred after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "created_before", "in": "query", "description": "Stage change history records for a stage change that occurred before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "include_loss_reasons", "in": "query", "description": "Whether to include loss reason details on stage changes that resulted in a loss.", "schema": { "type": "boolean", "default": false } }, { "name": "job_id", "in": "query", "description": "The Job to get stage change history for.", "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Stage change history records that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Stage change history records that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "recent", "in": "query", "description": "Stage change history records that have been modified in the last recent minutes", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"FirstName asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobWorkflowHistoryDetailPagedListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobWorkflowHistoryDetailPagedListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/jobs/info": { "get": { "tags": [ "Jobs" ], "summary": "Retrieve Jobs metadata", "description": "Retrieves attribute information specific to the Jobs type. This data changes rarely and Crelate recommends caching it.", "operationId": "jobsGetInfo", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInfoCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/jobs/list/{listId}": { "get": { "tags": [ "Jobs" ], "summary": "Retrieve Jobs by list", "description": "Returns Jobs records that belong to the specified saved list.", "operationId": "jobsGetByList", "parameters": [ { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "listId", "in": "path", "description": "ID of the static list.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"Name asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveJobsListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveJobsListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/jobs/postings/search": { "get": { "tags": [ "Jobs" ], "summary": "Search Job postings", "description": "Searches only Jobs published to the job portal: the posting is enabled, it is not hidden, and the Job's stage has a New or In Progress meaning. Any other Job is never returned. To find one, use Search all Jobs (`GET /jobs/search`) with a keyword such as its name or number, or Retrieve Jobs (`GET /jobs`), which also filters on `published`. Results are ordered by relevance to the query.", "operationId": "jobsSearchJobPostings", "parameters": [ { "name": "fields", "in": "query", "description": "Attributes to return for each Job posting: Id, JobCode, JobNum, Name, Owners, PortalCity, PortalCompanyName, PortalCompensation, PortalCountryId, PortalDescription, PortalLastPostedOn, PortalState, PortalTitle, or PortalZip. Any other attribute is rejected. Id and Name are always returned. When omitted, every attribute in this list is returned.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "limit", "in": "query", "description": "Maximum number of Job postings to return, from 1 to 200. Defaults to 200.", "schema": { "maximum": 200, "minimum": 1, "type": "integer", "format": "int32", "default": 200 } }, { "name": "offset", "in": "query", "description": "Number of matching Job postings to skip. Offset plus limit cannot exceed 10,000.", "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "query", "in": "query", "description": "Search terms, matched against the posting's title, description, company name, compensation, city, state, zip, and country (PortalTitle, PortalDescription, PortalCompanyName, PortalCompensation, PortalCity, PortalState, PortalZip, and PortalCountryId). The Job's Name and JobNum are not searched.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveJobsListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveJobsListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "description": "Covers only Jobs published to the job portal; use search_all_jobs or retrieve_jobs for any other Job. Pass a small limit and only the fields you need, since PortalDescription holds the full posting text.", "scope": "crelate.mcp.read.bulk" } } }, "/jobs/search": { "get": { "tags": [ "Jobs" ], "summary": "Search all Jobs", "description": "Performs a keyword search against all Job records, returning any matches. A Job matches when every word of the query matches the start of a word in its name, or when the query equals its Job number. Location, website, and other fields are not searched. The returned record information is intentionally limited with the intent of full data retrieval being used with a more specific query, such as a collection of GUID Id values.", "operationId": "jobsSearchJobs", "parameters": [ { "name": "limit", "in": "query", "description": "The maximum number of results to return.", "schema": { "maximum": 200, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } }, { "name": "query", "in": "query", "description": "The keyword query to search against Jobs with.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalSearchResultListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/lossreasontypes": { "get": { "tags": [ "Loss Reason Types" ], "summary": "Retrieve Loss Reason Types", "description": "Records must match all filters provided unless the OR filter operator is specified.\r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.\r\n If both recent and modified_after/modified_before are provided, recent will take precedence.\r\n The display text of a Loss Reason Type is its Value field; there is no Name or Title field. Job stage change history returns the reason for a loss as LossReason, with this text as its Title, when include_loss_reasons is true.", "operationId": "lossReasonTypesGetRecords", "parameters": [ { "name": "ids", "in": "query", "description": "The primary keys of Loss Reason Types to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Loss Reason Types that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Loss Reason Types that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "recent", "in": "query", "description": "Loss Reason Types that have been modified in the last recent minutes", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"FirstName asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "values", "in": "query", "description": "Filter the results by the following Loss Reason Type values.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveLossReasonTypesListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveLossReasonTypesListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "description": "The display text is Value; there is no Name or Title field to request or sort by. Job stage change history returns this text as LossReason.Title when include_loss_reasons is true.", "scope": "crelate.mcp.read.bulk" } } }, "/lossreasontypes/{id}": { "get": { "tags": [ "Loss Reason Types" ], "summary": "Retrieve a Loss Reason Type", "description": "Returns a single Loss Reason Types record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "lossReasonTypesGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveLossReasonTypesCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "description": "The display text is Value; there is no Name or Title field to request or sort by. Job stage change history returns this text as LossReason.Title when include_loss_reasons is true.", "scope": "crelate.mcp.read" } } }, "/opportunitytypes": { "get": { "tags": [ "Opportunity Types" ], "summary": "Retrieve Opportunity Types", "description": "Records must match all filters provided unless the OR filter operator is specified.\r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.\r\n If both recent and modified_after/modified_before are provided, recent will take precedence.", "operationId": "opportunityTypesGetRecords", "parameters": [ { "name": "ids", "in": "query", "description": "The primary keys of Opportunity Types to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Opportunity Types that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Opportunity Types that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "recent", "in": "query", "description": "Opportunity Types that have been modified in the last recent minutes", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"FirstName asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveOpportunityTypesListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveOpportunityTypesListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/opportunitytypes/{id}": { "get": { "tags": [ "Opportunity Types" ], "summary": "Retrieve an Opportunity Type", "description": "Returns a single Opportunity Types record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "opportunityTypesGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveOpportunityTypesCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/opportunitytypes/info": { "get": { "tags": [ "Opportunity Types" ], "summary": "Retrieve Opportunity Types metadata", "description": "Retrieves attribute information specific to the Opportunity Types type. This data changes rarely and Crelate recommends caching it.", "operationId": "opportunityTypesGetInfo", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInfoCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/passreasontypes": { "get": { "tags": [ "Pass Reason Types" ], "summary": "Retrieve Pass Reason Types", "description": "Records must match all filters provided unless the OR filter operator is specified.\r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.\r\n If both recent and modified_after/modified_before are provided, recent will take precedence.\r\n The display text of a Pass Reason Type is its Value field; there is no Name or Title field. Candidate stage change history returns the reason for a pass as PassReason, with this text as its Title, when include_pass_reasons is true.", "operationId": "passReasonTypesGetRecords", "parameters": [ { "name": "ids", "in": "query", "description": "The primary keys of Pass Reason Types to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "maximum": 200, "minimum": 1, "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Pass Reason Types that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Pass Reason Types that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "recent", "in": "query", "description": "Pass Reason Types that have been modified in the last recent minutes", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"FirstName asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "values", "in": "query", "description": "Filter the results by the following Pass Reason Type values.", "schema": { "maxItems": 10, "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievePassReasonTypesListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievePassReasonTypesListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "description": "The display text is Value; there is no Name or Title field to request or sort by. Candidate stage change history returns this text as PassReason.Title when include_pass_reasons is true.", "scope": "crelate.mcp.read.bulk" } } }, "/passreasontypes/{id}": { "get": { "tags": [ "Pass Reason Types" ], "summary": "Retrieve a Pass Reason Type", "description": "Returns a single Pass Reason Types record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "passReasonTypesGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievePassReasonTypesCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "description": "The display text is Value; there is no Name or Title field to request or sort by. Candidate stage change history returns this text as PassReason.Title when include_pass_reasons is true.", "scope": "crelate.mcp.read" } } }, "/placements": { "get": { "tags": [ "Placements" ], "summary": "Retrieve Placements", "description": "Records must match all filters provided unless the OR filter operator is specified.\r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.\r\n If both recent and modified_after/modified_before are provided, recent will take precedence.\r\n Each Placement belongs to one placement-type activity, identified by ExperienceId, and VerbId is that activity's type. An organization can have several placement-type activity types, so one hire can have several Placements. Which Placements a caller sees can depend on their access to each placement activity type.\r\n Value and Fee are separate amounts, and neither is reconciled with the Job's Fee or ActualValue. By default Value is Salary * FeePercent / 100 for direct hire and Margin * TotalHours for temporary placements, but each organization can change its placement forms.", "operationId": "placementsGetRecords", "parameters": [ { "name": "candidate_source_ids", "in": "query", "description": "List of comma-separated Candidate Source Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "company_ids", "in": "query", "description": "List of comma-separated Company Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "contact_ids", "in": "query", "description": "List of comma-separated Contact Ids to filter on", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "external_primary_keys", "in": "query", "description": "External Primary Keys of Placements to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ids", "in": "query", "description": "The primary keys of Placements to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "job_ids", "in": "query", "description": "List of comma-separated Job Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "lead_source_ids", "in": "query", "description": "List of comma-separated Lead Source Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Placements that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Placements that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "owner_ids", "in": "query", "description": "List of comma-separated owner (user) Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "recent", "in": "query", "description": "Placements that have been modified in the last\trecent minutes.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is a field name with an optional direction (e.g., `\"When desc\"`). Default direction of ascending if not provided. A field can be sorted on when its ValidFor list in the placements metadata (GET /placements/info) includes \"sort\". When paging with offset, end with PlacementNum so placements sharing a sort value are less likely to be repeated or skipped between pages (e.g., `\"When desc,PlacementNum\"`). PlacementNum can be blank or duplicated, so this does not fully prevent it.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "statuses", "in": "query", "description": "List of comma-separated statuses to filter on.", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "verb_ids", "in": "query", "description": "List of comma-separated Verb (activity type) Ids to filter on. Each placement-type activity creates its own placement, so one hire can have several placements. To count hires, filter to the activity type the organization counts as the hire.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "when_after", "in": "query", "description": "Placements whose own placement date is after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "when_before", "in": "query", "description": "Placements whose own placement date is before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievePlacementsListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievePlacementsListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "description": "Each placement belongs to one placement-type activity (ExperienceId), and VerbId is that activity's type. An organization can have several placement-type activity types, so one hire can have several placements. To count hires, count only the placements whose VerbId is the activity type the organization counts as the hire. Value and Fee are separate amounts that the server does not reconcile with each other or with the job's Fee or ActualValue, so do not add them together.", "scope": "crelate.mcp.read.bulk" } } }, "/placements/{id}": { "get": { "tags": [ "Placements" ], "summary": "Retrieve a Placement", "description": "Returns a single Placements record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "placementsGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievePlacementsCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "description": "Value and Fee are separate amounts that the server does not reconcile with each other or with the job's Fee or ActualValue, so do not add them together.", "scope": "crelate.mcp.read" } } }, "/placements/changeStatus/{id}": { "patch": { "tags": [ "Placements" ], "summary": "Update Placement record status", "description": "Available statuses can be retrieved by inspecting the results of the Placements metadata endpoint under the `EntityStatus` field.", "operationId": "placementsChangePlacementEntityStatus", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to update.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "newStatus": { "type": "integer", "description": "The new record status value to set. One of newStatus or newStatusName must be provided.", "format": "int32" }, "newStatusName": { "type": "string", "description": "The new record status name to set the value to. One of newStatus or newStatusName must be provided." }, "statusReason": { "type": "string", "description": "An optional reason or explanation for the status change." } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/placements/changeStatus/bulk": { "patch": { "tags": [ "Placements" ], "summary": "Update Placement record status in bulk", "description": "Available statuses can be retrieved by inspecting the results of the Placements metadata endpoint under the `EntityStatus` field.", "operationId": "placementsChangePlacementEntityStatusBulk", "requestBody": { "content": { "application/json": { "schema": { "required": [ "ids" ], "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The primary key(s) of the record(s) to update." }, "newStatus": { "type": "integer", "description": "The new record status value to set. One of newStatus or newStatusName must be provided.", "format": "int32" }, "newStatusName": { "type": "string", "description": "The new record status name to set the value to. One of newStatus or newStatusName must be provided." }, "statusReason": { "type": "string", "description": "An optional reason or explanation for the status change." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/placements/info": { "get": { "tags": [ "Placements" ], "summary": "Retrieve Placements metadata", "description": "Retrieves attribute information specific to the Placements type. This data changes rarely and Crelate recommends caching it.", "operationId": "placementsGetInfo", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInfoCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/relationships": { "get": { "tags": [ "Relationships" ], "summary": "Retrieve relationships", "description": "Returns a paged list of relationships. Use the optional filters to narrow results to a specific parent (owning) record, target (referenced) record, relationship group, or relationship type. Each relationship exposes its parent and target as polymorphic lookups (id, entity name, and title) along with the friendly names of its relationship group and type.", "operationId": "relationshipsGetRelationships", "parameters": [ { "name": "group_code", "in": "query", "description": "Optional. Only return relationships in this relationship group.", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "The maximum number of records to return.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "offset", "in": "query", "description": "The number of records to skip, for paging.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "parent_id", "in": "query", "description": "Optional. Only return relationships whose parent (owning) record matches this id.", "schema": { "type": "string", "format": "uuid" } }, { "name": "sort_by", "in": "query", "description": "Optional. The field to sort by (descending); falls back to ModifiedOn for unknown values.", "schema": { "type": "string" } }, { "name": "target_id", "in": "query", "description": "Optional. Only return relationships whose target (referenced) record matches this id.", "schema": { "type": "string", "format": "uuid" } }, { "name": "type_code", "in": "query", "description": "Optional. Only return relationships of this relationship type.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelationshipInfoRecordCollectionCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/relationships/{relationshipId}": { "get": { "tags": [ "Relationships" ], "summary": "Retrieve a relationship", "description": "Returns a single relationship by its unique identifier. The parent and target records are returned as polymorphic lookups (id, entity name, and title), and the numeric relationship group and type codes are accompanied by their friendly names.", "operationId": "relationshipsGetRelationship", "parameters": [ { "name": "relationshipId", "in": "path", "description": "The unique identifier of the relationship.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelationshipInfoCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/relationships/definitions": { "get": { "tags": [ "Relationships" ], "summary": "Retrieve available relationship groups and types", "description": "Returns the relationship groups and types configured for the org. Each entry includes the numeric code to supply when retrieving or filtering relationships, its friendly name, and the record types it applies to. Each type also lists the group codes it belongs to.", "operationId": "relationshipsGetRelationshipDefinitions", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelationshipDefinitionsCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/artifacttypes": { "get": { "tags": [ "Artifact Types" ], "summary": "Retrieve Artifact Types", "description": "Records must match all filters provided unless the OR filter operator is specified.\r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.", "operationId": "artifactTypesGetRecords", "parameters": [ { "name": "allowed_entity_names", "in": "query", "description": "A whitelist of entity types allowed as parents for the returned Artifact Types.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ids", "in": "query", "description": "The primary keys of AttachmentTypeEntity to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "AttachmentTypeEntity that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "AttachmentTypeEntity that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"Name asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "system_managed", "in": "query", "description": "Whether to retrieve system managed or user managed Artifact Types.", "schema": { "type": "boolean" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveArtifactTypesListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveArtifactTypesListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/artifacttypes/{id}": { "get": { "tags": [ "Artifact Types" ], "summary": "Retrieve an Artifact Type", "description": "Returns a single Artifact Types record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "artifactTypesGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveArtifactTypesCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/artifacttypes/count": { "get": { "tags": [ "Artifact Types" ], "summary": "Retrieve count of Artifact Types", "description": "Returns the total count of Artifact Types records in the organization matching the current access context.", "operationId": "artifactTypesCount", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Int32CrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/artifacttypes/info": { "get": { "tags": [ "Artifact Types" ], "summary": "Retrieve Artifact Types metadata", "description": "Retrieves attribute information specific to the Artifact Types type. This data changes rarely and Crelate recommends caching it.", "operationId": "artifactTypesGetInfo", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInfoCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/artifacts": { "post": { "tags": [ "Artifacts" ], "summary": "Create an Artifact", "description": "An Artifact can have an AttachmentTypeId (retrieved from Artifact Types endpoints) of null if there is not a suitable type.", "operationId": "artifactsCreate", "parameters": [ { "name": "target_entity_name", "in": "query", "description": "The name of the type of entity the artifact belongs to; the parent record.", "required": true, "schema": { "type": "string" } }, { "name": "target_record_id", "in": "query", "description": "The primary key of the entity the artifact belongs to; the parent record.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The artifact being created.\n`file`: The artifact file contents.\n`options`: Options to guide creation of the artifact.", "content": { "multipart/form-data": { "schema": { "properties": { "entity": { "$ref": "#/components/schemas/CreateArtifacts" }, "file": { "$ref": "#/components/schemas/CrelateFileStream" }, "options": { "allOf": [ { "$ref": "#/components/schemas/AttachmentCreateOptions" } ], "description": "Options for creating an attachment record." } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } }, "get": { "tags": [ "Artifacts" ], "summary": "Retrieve Artifacts", "description": "Returns a paged list of artifact records. Filter by artifact type, parent record, content type, or other criteria.", "operationId": "artifactsGetRecords", "parameters": [ { "name": "artifact_type_ids", "in": "query", "description": "Filter Artifacts by the specified Artifact types.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "content_types", "in": "query", "description": "Artifacts with matching content types.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "file_names", "in": "query", "description": "Artifacts with matching file names.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "form_ids", "in": "query", "description": "Filter Artifacts by completed form IDs.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "ids", "in": "query", "description": "The primary keys of Artifacts to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "is_document", "in": "query", "description": "Artifacts that are documents. One of is_document or is_image may be provided.", "schema": { "type": "boolean" } }, { "name": "is_image", "in": "query", "description": "Artifacts that are images. One of is_image or is_document may be provided.", "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Artifacts that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Artifacts that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "owners_ids", "in": "query", "description": "Artifacts owned by the specified users.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "parent_ids", "in": "query", "description": "Artifacts for the specified parents.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "recent", "in": "query", "description": "Artifacts that have been modified in the last recent minutes.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"FirstName asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveArtifactsListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveArtifactsListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/artifacts/{id}": { "get": { "tags": [ "Artifacts" ], "summary": "Retrieve an Artifact", "description": "Returns a single Artifacts record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "artifactsGetById", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveArtifactsCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } }, "delete": { "tags": [ "Artifacts" ], "summary": "Delete an Artifact", "description": "Permanently deletes an Artifact record by its unique identifier.", "operationId": "artifactsDelete", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to delete.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/artifacts/{id}/content": { "get": { "tags": [ "Artifacts" ], "summary": "Retrieve file contents", "description": "Downloads the file content associated with an artifact record. Returns the raw binary stream.", "operationId": "artifactsGetContent", "parameters": [ { "name": "content_mode", "in": "query", "description": "Which version of the file to return, given by name or by integer value: `Original` (0) is the uploaded file, `Preview` (1) the generated PDF, `Thumbnail` (2) a JPEG thumbnail image, and `PreviewText` (4) the text of the document. `Preview` and `PreviewText` are produced only for document files, and `Thumbnail` only for document and image files.\n\n0 = Original\n\n1 = Preview\n\n2 = Thumbnail\n\n4 = PreviewText", "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachmentContentMode" } ], "description": "Describes the type of file to return.", "default": 0, "x-enumNames": [ "Original", "Preview", "Thumbnail", "PreviewText" ], "x-enumDescriptions": [ "", "", "", "" ] }, "x-enumNames": [ "Original", "Preview", "Thumbnail", "PreviewText" ], "x-enumDescriptions": [ "", "", "", "" ] }, { "name": "id", "in": "path", "description": "Id of the Artifact record.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for controlling which fields are returned on the retrieved record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamResponseCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/artifacts/image/primary": { "post": { "tags": [ "Artifacts" ], "summary": "Create a primary image Artifact", "description": "The AttachmentTypeId (Artifact Type) may be omitted and the system will assign the primary Artifact Type automatically.", "operationId": "artifactsCreatePrimaryImage", "parameters": [ { "name": "target_entity_name", "in": "query", "description": "The name of the type of entity the artifact belongs to; the parent record.", "required": true, "schema": { "type": "string" } }, { "name": "target_record_id", "in": "query", "description": "The primary key of the entity the artifact belongs to; the parent record.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The artifact being created.\n`file`: The artifact file contents.\n`options`: Options to guide creation of the artifact.", "content": { "multipart/form-data": { "schema": { "properties": { "entity": { "$ref": "#/components/schemas/CreateArtifacts" }, "file": { "$ref": "#/components/schemas/CrelateFileStream" }, "options": { "$ref": "#/components/schemas/AttachmentCreateOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/artifacts/primary": { "post": { "tags": [ "Artifacts" ], "summary": "Create a primary Artifact", "description": "The AttachmentTypeId (Artifact Type) may be omitted and the system will assign the primary Artifact Type automatically.", "operationId": "artifactsCreatePrimary", "parameters": [ { "name": "target_entity_name", "in": "query", "description": "The name of the type of entity the artifact belongs to; the parent record.", "required": true, "schema": { "type": "string" } }, { "name": "target_record_id", "in": "query", "description": "The primary key of the entity the artifact belongs to; the parent record.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The artifact being created.\n`file`: The artifact file contents.\n`options`: Options to guide creation of the artifact.", "content": { "multipart/form-data": { "schema": { "properties": { "entity": { "$ref": "#/components/schemas/CreateArtifacts" }, "file": { "$ref": "#/components/schemas/CrelateFileStream" }, "options": { "$ref": "#/components/schemas/AttachmentCreateOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/billableitems": { "get": { "tags": [ "Billable Items" ], "summary": "Retrieve Billable Items", "description": "Records must match all filters provided unless the OR filter operator is specified. \r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending \r\n If both recent and modified_after/modified_before are provided, recent will take precedence.", "operationId": "billableItemsGetRecords", "parameters": [ { "name": "amount", "in": "query", "description": "The amount of the Billable Item.", "schema": { "type": "string" } }, { "name": "company_ids", "in": "query", "description": "List of comma-separated company Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "delivery_type_ids", "in": "query", "description": "List of comma-separated delivery type Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "ids", "in": "query", "description": "The primary keys of BillableItemEntity to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "invoice_numbers", "in": "query", "description": "List of comma-separated invoice numbers (not Ids) to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "job_ids", "in": "query", "description": "List of comma-separated job Ids to filter on..", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "BillableItemEntity that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "BillableItemEntity that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "name", "in": "query", "description": "The title of the Billable Item.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. Highly recommended to set a sort_by if setting this", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "quantity", "in": "query", "description": "The quantity of the Billable Item.", "schema": { "type": "string" } }, { "name": "recent", "in": "query", "description": "Companies that have been modified in the last recent minutes.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute\twith an optional direction e.g. \"FirstName asc\". Default direction of ascending if not provided", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total", "in": "query", "description": "The total of the Billable Item.", "schema": { "type": "string" } }, { "name": "transaction_date", "in": "query", "description": "The date and time of when this transaction occurred.", "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveBillableItemsListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveBillableItemsListCrelateResponse" } } } } } } }, "/expensetypes": { "get": { "tags": [ "Expense Types" ], "summary": "Retrieve Expense Types", "description": "Records must match all filters provided unless the OR filter operator is specified.\r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.\r\n If both recent and modified_after/modified_before are provided, recent will take precedence.", "operationId": "expenseTypesGetRecords", "parameters": [ { "name": "ids", "in": "query", "description": "The primary keys of Expense Types to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Expense Types that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Expense Types that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "recent", "in": "query", "description": "Expense Types that have been modified in the last recent minutes", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"FirstName asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveExpenseTypesListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveExpenseTypesListCrelateResponse" } } } } } } }, "/expensetypes/{id}": { "get": { "tags": [ "Expense Types" ], "summary": "Retrieve an Expense Type", "description": "Returns a single Expense Types record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "expenseTypesGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveExpenseTypesCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/expensetypes/assignments/{assignmentId}": { "get": { "tags": [ "Expense Types" ], "summary": "Retrieve available Expense Types for an assignment", "description": "Returns the expense types available for the specified assignment, optionally filtered to those not yet claimed in a given pay period.", "operationId": "expenseTypesAvailableExpenseTypes", "parameters": [ { "name": "assignmentId", "in": "path", "description": "The assignment to get available Expense Types for.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pay_period_id", "in": "query", "description": "The pay period to filter claimed Expense Types to. When omitted or specified explicitly as false, claimed Expense Types will be included.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignmentDeliveryTypeInfoListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/expensetypes/count": { "get": { "tags": [ "Expense Types" ], "summary": "Retrieve count of Expense Types", "description": "Returns the total count of Expense Types records in the organization matching the current access context.", "operationId": "expenseTypesCount", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Int32CrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/expensetypes/employees/{employeeId}": { "get": { "tags": [ "Expense Types" ], "summary": "Retrieve available Expense Types for an employee", "description": "Returns the expense types available for all of the specified employee's active assignments, optionally filtered to those not yet claimed in a given pay period.", "operationId": "expenseTypesAvailableExpenseTypesByAssignment", "parameters": [ { "name": "employeeId", "in": "path", "description": "The employee user to retrieve available Expense Types for.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pay_period_id", "in": "query", "description": "The pay period to filter claimed Expense Types to. When omitted or specified explicitly as false, claimed Expense Types will be included.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignmentDeliveryTypesListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/expensetypes/info": { "get": { "tags": [ "Expense Types" ], "summary": "Retrieve Expense Types metadata", "description": "Retrieves attribute information specific to the Expense Types type. This data changes rarely and Crelate recommends caching it.", "operationId": "expenseTypesGetInfo", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInfoCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/expensetypes/meanings": { "get": { "tags": [ "Expense Types" ], "summary": "Retrieve Expense Type meanings", "description": "Returns the available meaning categories for Expense Types. Use meaning values when creating or filtering Expense Type records.", "operationId": "expenseTypesGetMeanings", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveMeaningsListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveMeaningsListCrelateResponse" } } } } } } }, "/invoices": { "get": { "tags": [ "Invoices" ], "summary": "Retrieve Invoices", "description": "Records must match all filters provided unless the OR filter operator is specified. \r\n If no sort_by is provided, the resulting list will be sorted by \tModifiedOn descending. \r\n If both recent and \tmodified_after/modified_before are provided, \trecent will take precedence.", "operationId": "invoicesGetRecords", "parameters": [ { "name": "company_ids", "in": "query", "description": "List of comma-separated job Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "due_after", "in": "query", "description": "Filter invoices that are due after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "due_before", "in": "query", "description": "Filter invoices that are due before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "ids", "in": "query", "description": "The primary keys of InvoiceEntity to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "invoiced_after", "in": "query", "description": "Filter invoices that are invoiced after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "invoiced_before", "in": "query", "description": "Filter invoices that are invoiced before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "invoice_numbers", "in": "query", "description": "List of comma-separated Invoice Numbers/InvoiceId Titles to retrieve records for (Not the PrimaryId).", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "is_late", "in": "query", "description": "Filter invoices are/are not late.", "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "InvoiceEntity that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "InvoiceEntity that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "recent", "in": "query", "description": "InvoiceEntity that have been modified in the lastrecent minutes.", "schema": { "type": "integer", "format": "int32" } }, { "name": "recipient_ids", "in": "query", "description": "List of comma-separated Recipient Contact Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "sent_after", "in": "query", "description": "Filter invoices that are first sent after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "sent_before", "in": "query", "description": "Filter invoices that are first sent before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"FirstName asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "statuses", "in": "query", "description": "List of comma-separated status Ids to filter on.", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveInvoicesListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveInvoicesListCrelateResponse" } } } } } } }, "/invoices/{id}": { "get": { "tags": [ "Invoices" ], "summary": "Retrieve an Invoice", "description": "Returns a single Invoices record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "invoicesGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveInvoicesCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/invoices/count": { "get": { "tags": [ "Invoices" ], "summary": "Retrieve count of Invoices", "description": "Returns the total count of Invoices records in the organization matching the current access context.", "operationId": "invoicesCount", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Int32CrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/invoices/info": { "get": { "tags": [ "Invoices" ], "summary": "Retrieve Invoices metadata", "description": "Retrieves attribute information specific to the Invoices type. This data changes rarely and Crelate recommends caching it.", "operationId": "invoicesGetInfo", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInfoCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/ledgeraccounts": { "get": { "tags": [ "Ledger Accounts" ], "summary": "Retrieve Ledger Accounts", "description": "Records must match all filters provided unless the OR filter operator is specified. \r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending \r\n If both recent and modified_after/modified_before are provided, recent will take precedence.", "operationId": "ledgerAccountsGetRecords", "parameters": [ { "name": "account_types", "in": "query", "description": "List of comma-separated account types to filter on.\"/>", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerAccountTypeOption" } }, "x-enumNames": [ "Asset", "Liability", "Equity", "Revenue", "Expense", "CostofGoodsSold", "ContraAccount" ], "x-enumDescriptions": [ "", "", "", "", "", "", "" ] }, { "name": "codes", "in": "query", "description": "List of comma-separated codes to filter on. Generally a number, but could include other alpha characters.\"/>", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "contra_account_types", "in": "query", "description": "List of comma-separated contra accounts types to filter on.\"/>", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerAccountTypeOption" } }, "x-enumNames": [ "Asset", "Liability", "Equity", "Revenue", "Expense", "CostofGoodsSold", "ContraAccount" ], "x-enumDescriptions": [ "", "", "", "", "", "", "" ] }, { "name": "ids", "in": "query", "description": "The primary keys of Ledger Accounts to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Ledger Accounts that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Ledger Accounts that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "names", "in": "query", "description": "List of comma-separated names to filter on.\"/>", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. Highly recommended to set a sort_by if setting this", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "recent", "in": "query", "description": "Ledger Accounts that have been modified in the last recent minutes.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute\twith an optional direction e.g. \"FirstName asc\". Default direction of ascending if not provided", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveLedgerAccountsListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveLedgerAccountsListCrelateResponse" } } } } } } }, "/ledgers": { "get": { "tags": [ "Ledgers" ], "summary": "Retrieve Ledger Items", "description": "Records must match all filters provided unless the OR filter operator is specified. If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending. If both recent and modified_after/modified_before are provided, recent will take precedence.", "operationId": "ledgersGetRecords", "parameters": [ { "name": "company_ids", "in": "query", "description": "List of comma-separated compoany Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "credit_amount", "in": "query", "description": "The credit amount for the record.", "schema": { "type": "string" } }, { "name": "debit_amount", "in": "query", "description": "The debit amount for the record.", "schema": { "type": "string" } }, { "name": "ids", "in": "query", "description": "List of comma-separated Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "invoice_numbers", "in": "query", "description": "List of comma-separated Invoice Numbers/InvoiceId Titles to retrieve records for (Not the PrimaryId).", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "job_ids", "in": "query", "description": "List of comma-separated Job Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "ledger_date", "in": "query", "description": "The date and time for ledger event.", "schema": { "type": "string", "format": "date-time" } }, { "name": "ledger_event", "in": "query", "description": "The LedgerEventOption for the record.\n\n0 = Unknown\n\n1 = InvoiceSent\n\n2 = MemoCreated\n\n3 = InvoiceVoided\n\n4 = PaymentRecognized", "schema": { "allOf": [ { "$ref": "#/components/schemas/LedgerEventOption" } ] }, "x-enumNames": [ "Unknown", "InvoiceSent", "MemoCreated", "InvoiceVoided", "PaymentRecognized" ], "x-enumDescriptions": [ "", "", "", "", "" ] }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Ledger Items that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Ledger Items that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. Highly recommended to set a sort_by if setting this", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "recent", "in": "query", "description": "Companies that have been modified in the last recent minutes.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute\twith an optional direction e.g. \"FirstName asc\". Default direction of ascending if not provided", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "transaction_date", "in": "query", "description": "The date and time of when this transaction occurred.", "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveLedgersListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveLedgersListCrelateResponse" } } } } } } }, "/payments": { "get": { "tags": [ "Payments" ], "summary": "Retrieve Payments", "description": "Records must match all filters provided unless the OR filter operator is specified. \r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending \r\n If both recent and modified_after/modified_before are provided, recent will take precedence.", "operationId": "paymentsGetRecords", "parameters": [ { "name": "company_ids", "in": "query", "description": "List of comma-separated compoany Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "debit_account_ids", "in": "query", "description": "List of comma-separated debit account Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "ids", "in": "query", "description": "The primary keys of Payments to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Payments that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Payments that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. Highly recommended to set a sort_by if setting this", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "payment_methods", "in": "query", "description": "List of comma-separated PaymentMethodOption to filter on.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodOption" } }, "x-enumNames": [ "Unknown", "ACH", "Cash", "Check", "CreditCard", "ZeroAmount", "Other" ], "x-enumDescriptions": [ "", "", "", "", "", "", "" ] }, { "name": "payment_types", "in": "query", "description": "List of comma-separated PaymentTypeOption to filter on.", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentTypeOption" } }, "x-enumNames": [ "Normal", "ZeroAmount" ], "x-enumDescriptions": [ "", "" ] }, { "name": "recent", "in": "query", "description": "Payments that have been modified in the last recent minutes.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute\twith an optional direction e.g. \"FirstName asc\". Default direction of ascending if not provided", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievePaymentsListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievePaymentsListCrelateResponse" } } } } } } }, "/payments/recognize": { "post": { "tags": [ "Payments" ], "summary": "Recognize a Payment", "description": "Records a payment against one or more invoices and updates their balances and statuses accordingly.", "operationId": "paymentsRecognizePayment", "requestBody": { "description": "All the information needed to reconize a Payment.", "content": { "application/json": { "schema": { "required": [ "options" ], "properties": { "options": { "$ref": "#/components/schemas/RecognizePaymentOptions" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/payments/zeroamount": { "post": { "tags": [ "Payments" ], "summary": "Recognize a zero-amount Payment", "description": "Records a zero-amount balancing payment across exactly two invoices whose amounts net to zero.", "operationId": "paymentsRecognizeZeroAmountPayment", "requestBody": { "description": "All the information needed to reconize a Payment.", "content": { "application/json": { "schema": { "required": [ "options" ], "properties": { "options": { "$ref": "#/components/schemas/RecognizePaymentOptions" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/timetypes": { "get": { "tags": [ "Time Types" ], "summary": "Retrieve Time Types", "description": "Records must match all filters provided unless the OR filter operator is specified.\r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.\r\n If both recent and modified_after/modified_before are provided, recent will take precedence.", "operationId": "timeTypesGetRecords", "parameters": [ { "name": "ids", "in": "query", "description": "The primary keys of Time Types to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Time Types that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Time Types that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "recent", "in": "query", "description": "Time Types that have been modified in the last recent minutes", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"FirstName asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveTimeTypesListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveTimeTypesListCrelateResponse" } } } } } } }, "/timetypes/{id}": { "get": { "tags": [ "Time Types" ], "summary": "Retrieve a Time Type", "description": "Returns a single Time Types record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "timeTypesGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveTimeTypesCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/timetypes/assignments/{assignmentId}": { "get": { "tags": [ "Time Types" ], "summary": "Retrieve available Time Types for an assignment", "description": "Returns the time types available for the specified assignment, optionally filtered to those not yet claimed in a given time submission period.", "operationId": "timeTypesAvailableTimeTypes", "parameters": [ { "name": "assignmentId", "in": "path", "description": "The assignment to get available Time Types for.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "time_submission_period_id", "in": "query", "description": "The pay period to filter claimed Time Types to. When omitted or specified explicitly as false, claimed Time Types will be included.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignmentDeliveryTypeInfoListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/timetypes/count": { "get": { "tags": [ "Time Types" ], "summary": "Retrieve count of Time Types", "description": "Returns the total count of Time Types records in the organization matching the current access context.", "operationId": "timeTypesCount", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Int32CrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/timetypes/employees/{employeeId}": { "get": { "tags": [ "Time Types" ], "summary": "Retrieve available Time Types for an employee", "description": "Returns the time types available for all of the specified employee's active assignments, optionally filtered to those not yet claimed in a given time submission period.", "operationId": "timeTypesAvailableTimeTypesByAssignment", "parameters": [ { "name": "employeeId", "in": "path", "description": "The employee user to retrieve available Time Types for.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "time_submission_period_id", "in": "query", "description": "The time submission period to filter claimed Time Types to. When omitted or specified explicitly as false, claimed Time Types will be included.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignmentDeliveryTypesListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/timetypes/info": { "get": { "tags": [ "Time Types" ], "summary": "Retrieve Time Types metadata", "description": "Retrieves attribute information specific to the Time Types type. This data changes rarely and Crelate recommends caching it.", "operationId": "timeTypesGetInfo", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInfoCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/timetypes/meanings": { "get": { "tags": [ "Time Types" ], "summary": "Retrieve Time Type meanings", "description": "Returns the available meaning categories for Time Types. Use meaning values when creating or filtering Time Type records.", "operationId": "timeTypesGetMeanings", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveMeaningsListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveMeaningsListCrelateResponse" } } } } } } }, "/formrequests": { "get": { "tags": [ "Form Requests" ], "summary": "Retrieve Form Request info", "description": "Includes who it was sent to, who requested it, when, and what was requested. If desired, the form layout can be included via include_layout.", "operationId": "formRequestsGetFormInfo", "parameters": [ { "name": "form_request_id", "in": "query", "description": "The primary key of the Form Request.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "include_layout", "in": "query", "description": "Whether the form layout should be included in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for controlling which fields are returned.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetFormResultCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/formrequests/resend": { "post": { "tags": [ "Form Requests" ], "summary": "Resend a Form Request", "description": "Resends an existing incomplete Form Request via email with a new shared link.", "operationId": "formRequestsResendFormRequest", "parameters": [ { "name": "form_request_id", "in": "query", "description": "The identifier of the Form Request.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendEmailResponseCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/formrequests/revoke": { "patch": { "tags": [ "Form Requests" ], "summary": "Revoke a Form Request", "description": "Revokes an outstanding Form Request so it can no longer be completed by the recipient.", "operationId": "formRequestsRevokeFormRequest", "parameters": [ { "name": "form_request_id", "in": "query", "description": "The identifier of the Form Request.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/formrequests/send": { "post": { "tags": [ "Form Requests" ], "summary": "Send a Form Request", "description": "Creates a Form Request to be completed by the Contact specified by contactId and sends them an email with an embedded link to complete the requested form or upload the specified document. Additionally, an activity will be added to the Contact's activity stream showing the status of the form request that can be clicked to show the completed form or uploaded document when the Form Request has been completed by the requested Contact.", "operationId": "formRequestsSendFormRequest", "requestBody": { "content": { "application/json": { "schema": { "required": [ "contactId" ], "properties": { "activityFormId": { "type": "string", "description": "The activity form for a form type Form Request. Providing this value will prompt the target to fill out the specified activity form. This value is mutually exclusive with artifactTypeId and only one of the two may be provided.", "format": "uuid" }, "artifactTypeId": { "type": "string", "description": "The artifact type for an artifact-type Form Request. Providing this value will prompt the target Contact to upload a document of this type when the email-embedded link is clicked. This value is mutually exclusive with activityFormId and only one of the two may be provided.", "format": "uuid" }, "contactId": { "type": "string", "description": "The Contact to send a Form Request to. This Contact must have a primary email address.", "format": "uuid" }, "message": { "type": "string", "description": "An optional personalized message to include in the standard Form Request email." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/forms/templates": { "get": { "tags": [ "Form Requests" ], "summary": "Retrieve Form Request Templates", "description": "Retrieves available artifact types and activity forms that are valid for use with Form Requests. Not all artifact types and forms are valid; only templates returned from this endpoint should be provided when creating a Form Request. This endpoint is designed specifically for working with Form Requests. See the available Form Templates endpoints for working more generally with Form Templates.", "operationId": "formRequestsGetTemplates", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormRequestTemplatesCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/forms/responses": { "get": { "tags": [ "Form Responses" ], "summary": "Retrieve Form Responses", "description": "* If the form corresponds to an incomplete Form Request, responses cannot be retrieved.\n* Form Request completion status can be checked via the retrieve form info endpoint.\n* Only one of the following should be provided for each request: `artifact_id`, `form_id`, or `activity_id`.", "operationId": "formResponsesGetFormResponses", "parameters": [ { "name": "activity_id", "in": "query", "description": "The identifier of the associated activity.If provided, `artifact_id` and `form_id` should not be provided.", "schema": { "type": "string", "format": "uuid" } }, { "name": "artifact_id", "in": "query", "description": "The identifier of the Form Request.If provided, `form_id` and `activity_id` should not be provided.", "schema": { "type": "string", "format": "uuid" } }, { "name": "form_id", "in": "query", "description": "The identifier of the form.If provided, `artifact_id` and `activity_id` should not be provided.", "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for controlling which fields are returned.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormResponseListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/forms/templates/{id}/layout": { "get": { "tags": [ "Form Templates" ], "summary": "Retrieve Form Template Layout", "description": "Retrieves the presentation structure of a form, used to instruct rendering of separately retrieved form responses to a form instance.", "operationId": "formTemplatesGetFormDefinitionLayout", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the form template to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/forms": { "get": { "tags": [ "Forms" ], "summary": "Retrieve Forms", "description": "Records must match all filters provided unless the OR filter operator is specified.\r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.\r\n If both recent and modified_after/modified_before are provided, recent will take precedence.", "operationId": "formsGetRecords", "parameters": [ { "name": "completed", "in": "query", "description": "Forms that are completed.", "schema": { "type": "boolean" } }, { "name": "form_definition_ids", "in": "query", "description": "Forms that use these Form definitions.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "form_type_ids", "in": "query", "description": "Forms that use Form definitions of these types.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "ids", "in": "query", "description": "The primary keys of Forms to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Forms that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Forms that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "parent_ids", "in": "query", "description": "Forms that are parented by these records.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "recent", "in": "query", "description": "Forms that have been modified in the last recent minutes.", "schema": { "type": "integer", "format": "int32" } }, { "name": "regarding_ids", "in": "query", "description": "Forms that regard these records.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"FirstName asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveFormsListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveFormsListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/forms/info": { "get": { "tags": [ "Forms" ], "summary": "Retrieve Forms metadata", "description": "Retrieves attribute information specific to the Forms type. This data changes rarely and Crelate recommends caching it.", "operationId": "formsGetInfo", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInfoCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/worksites": { "get": { "tags": [ "Worksites" ], "summary": "Retrieve work sites", "description": "Records must match all filters provided unless the OR filter operator is specified.\r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.\r\n If both recent and modified_after/modified_before are provided, recent will take precedence.", "operationId": "worksitesGetRecords", "parameters": [ { "name": "account_id", "in": "query", "description": "Work sites for the specified account.", "schema": { "type": "string", "format": "uuid" } }, { "name": "external_primary_keys", "in": "query", "description": "External Primary Keys of Work sites to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ids", "in": "query", "description": "The primary keys of work sites to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "is_address_verified", "in": "query", "description": "Work sites that have their address verified for payroll.", "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Work sites that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Work sites that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "recent", "in": "query", "description": "Work sites that have been modified in the last recent minutes", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"FirstName asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveWorksitesListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveWorksitesListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } }, "post": { "tags": [ "Worksites" ], "summary": "Create a Worksite", "description": "Creates a new Worksites record and returns its generated ID.", "operationId": "worksitesCreate", "requestBody": { "description": "The record to create.", "content": { "application/json": { "schema": { "required": [ "entity" ], "properties": { "entity": { "$ref": "#/components/schemas/CreateWorksites" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "409": { "description": "When duplicates are disabled or forbidden for the entity type(s) involved and completing the request would produce a duplicate record.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } } } } }, "/worksites/{id}": { "get": { "tags": [ "Worksites" ], "summary": "Retrieve a Worksite", "description": "Returns a single Worksites record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "worksitesGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveWorksitesCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } }, "patch": { "tags": [ "Worksites" ], "summary": "Update a Worksite", "description": "Partially updates an existing Worksites record. Only fields included in the request body are modified; omitted fields are left unchanged.", "operationId": "worksitesUpdate", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to update.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The record to update.", "content": { "application/json": { "schema": { "required": [ "entity" ], "properties": { "entity": { "$ref": "#/components/schemas/UpdateWorksites" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/worksites/count": { "get": { "tags": [ "Worksites" ], "summary": "Retrieve count of Worksites", "description": "Returns the total count of Worksites records in the organization matching the current access context.", "operationId": "worksitesCount", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Int32CrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/worksites/info": { "get": { "tags": [ "Worksites" ], "summary": "Retrieve Worksites metadata", "description": "Retrieves attribute information specific to the Worksites type. This data changes rarely and Crelate recommends caching it.", "operationId": "worksitesGetInfo", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInfoCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/lists": { "get": { "tags": [ "Lists" ], "summary": "Retrieve static Lists", "description": "Records must match all filters provided unless the OR filter operator is specified.\r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.\r\n If both recent and modified_after/modified_before are provided, recent will take precedence.", "operationId": "listsGetRecords", "parameters": [ { "name": "entity_names", "in": "query", "description": "Lists that contains records of the requested types.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ids", "in": "query", "description": "The primary keys of Lists to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Lists that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Lists that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "owner_ids", "in": "query", "description": "List of comma-separated owner (user) Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "recent", "in": "query", "description": "Lists that have been modified in the last recent minutes", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"Name asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveViewsListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveViewsListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/teams": { "get": { "tags": [ "Entity" ], "summary": "Get teams", "description": "Returns all teams and their associated users defined in the organization.", "operationId": "entityGetTeams", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllTeamsCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/applications": { "get": { "tags": [ "Applications" ], "summary": "Retrieve Applications", "description": "Records must match all filters provided unless the OR filter operator is specified.\r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.\r\n If both recent and modified_after/modified_before are provided, recent will take precedence.", "operationId": "applicationsGetRecords", "parameters": [ { "name": "contact_ids", "in": "query", "description": "List of comma-separated contact Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "emails", "in": "query", "description": "List of comma-separated email addresses to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ids", "in": "query", "description": "List of Application Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "job_ids", "in": "query", "description": "List of comma-separated job Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Total number of records to return for this page. Defaults to 100.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Only select changes that occurred after the given DateTime UTC.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Only select changes that occurred before the given DateTime UTC.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to skip for this page before sending back the following records. Defaults to 0.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "phone_numbers", "in": "query", "description": "List of comma-separated phone numbers to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "recent", "in": "query", "description": "Only select changes that occurred in the number of minutes prior to UtcNow. This is ignored if either modified_before or modified_after(or both) are specified.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma-sepoarated list of sort fields and their optional sort direction. The sort direction, if present, is separated by a space from its field,and defaults to asc. If no sort_by is specified, then \"ModifiedOn desc\" is used.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "status_ids", "in": "query", "description": "List of comma-separated status Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "The RetrieveOptions for this call, including the optional field setto return.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveApplicationsListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveApplicationsListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/applications/{applicationId}/approve": { "post": { "tags": [ "Applications" ], "summary": "Approve an Application", "description": "Approved applicants will be moved to the next workflow stage, typically with a meaning of \"in progress\".", "operationId": "applicationsApproveApplication", "parameters": [ { "name": "applicationId", "in": "path", "description": "The primary key of the application to approve.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "Information about the applicant being approved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveApplicantWorkflowAction" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationProcessResultCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/applications/{applicationId}/block": { "post": { "tags": [ "Applications" ], "summary": "Block an Application", "description": "When an applicant is blocked, they are no longer visible and any future applications from that applicant will be discarded.", "operationId": "applicationsBlockApplication", "parameters": [ { "name": "applicationId", "in": "path", "description": "The primary key of the application to block.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "Information about the applicant being blocked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockApplicantWorkflowAction" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationProcessResultCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/applications/{applicationId}/reject": { "post": { "tags": [ "Applications" ], "summary": "Reject an Application", "description": "Rejected applicants will be moved to a closed negative workflow stage.", "operationId": "applicationsRejectApplication", "parameters": [ { "name": "applicationId", "in": "path", "description": "The primary key of the application to reject.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "Information about the applicant being rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectApplicantWorkflowAction" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationProcessResultCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/applications/{id}": { "get": { "tags": [ "Applications" ], "summary": "Retrieve an Application", "description": "Returns a single Applications record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "applicationsGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveApplicationsCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/applications/count": { "get": { "tags": [ "Applications" ], "summary": "Retrieve count of Applications", "description": "Returns the total count of Applications records in the organization matching the current access context.", "operationId": "applicationsCount", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Int32CrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/applications/info": { "get": { "tags": [ "Applications" ], "summary": "Retrieve Applications metadata", "description": "Retrieves attribute information specific to the Applications type. This data changes rarely and Crelate recommends caching it.", "operationId": "applicationsGetInfo", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInfoCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/jobs/{jobId}/apply": { "post": { "tags": [ "Applications" ], "summary": "Apply to a Job", "description": "Returns the ID of the created application.\r\n Depending on settings, applicants may either route to the Recruiting Intake dashboard or auto-approve and convert to a Contact. If auto-approved, the Contact may be determined by retrieving the Application using the returned Id and inspecting the `ContactId` field.\r\n Depending on Job Portal settings, a resume file may or may not be required. If you are an integration partner, consult with each customer to confirm their settings or request them to change it.", "operationId": "applicationsApplyToJob", "parameters": [ { "name": "jobId", "in": "path", "description": "The job to apply to.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "Information about the applicant.\n`resumeFile`: The resume of the applicant.", "content": { "multipart/form-data": { "schema": { "required": [ "applicant" ], "properties": { "applicant": { "$ref": "#/components/schemas/ApplicantInfo" }, "resumeFile": { "$ref": "#/components/schemas/CrelateFileStream" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/losses": { "get": { "tags": [ "Losses" ], "summary": "Retrieve Losses", "description": "Returns a paged list of loss records. Filter by company, job, activity, or loss reason.", "operationId": "lossesGetRecords", "parameters": [ { "name": "activity_ids", "in": "query", "description": "List of comma-separated Activity Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "company_ids", "in": "query", "description": "List of comma-separated compoany Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "ids", "in": "query", "description": "List of comma-separated Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "job_ids", "in": "query", "description": "List of comma-separated job Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "loss_reason_ids", "in": "query", "description": "List of comma-separated Loss Reason Type Ids to filter on.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "modified_after", "in": "query", "description": "Losses that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Losses that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. Highly recommended to set a sort_by if setting this", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "recent", "in": "query", "description": "Losses that have been modified in the last recent minutes.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute\twith an optional direction e.g. \"FirstName asc\". Default direction of ascending if not provided", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "when", "in": "query", "description": "The date/time this Loss has occured.", "schema": { "type": "string", "format": "date-time" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveLossesListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveLossesListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } } }, "/losses/{id}": { "get": { "tags": [ "Losses" ], "summary": "Retrieve a Loss", "description": "Returns a single Losses record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "lossesGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveLossesCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/tagcategories": { "get": { "tags": [ "Tag Categories" ], "summary": "Retrieve Tag Categories", "description": "Records must match all filters provided unless the OR filter operator is specified.\r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.\r\n If both recent and modified_after/modified_before are provided, recent will take precedence.", "operationId": "tagCategoriesGetRecords", "parameters": [ { "name": "entity_names", "in": "query", "description": "Tag Categories that are available for these entity types.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ids", "in": "query", "description": "The primary keys of Tag Categories to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Tag Categories that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Tag Categories that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "recent", "in": "query", "description": "Tag Categories that have been modified in the last recent minutes", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"Name asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveTagCategoriesListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveTagCategoriesListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } }, "post": { "tags": [ "Tag Categories" ], "summary": "Create a Tag Category", "description": "Creates a new Tag Categories record and returns its generated ID.", "operationId": "tagCategoriesCreate", "requestBody": { "description": "The record to create.", "content": { "application/json": { "schema": { "required": [ "entity" ], "properties": { "entity": { "$ref": "#/components/schemas/CreateTagCategories" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "409": { "description": "When duplicates are disabled or forbidden for the entity type(s) involved and completing the request would produce a duplicate record.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } } } } }, "/tagcategories/{id}": { "get": { "tags": [ "Tag Categories" ], "summary": "Retrieve a Tag Category", "description": "Returns a single Tag Categories record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "tagCategoriesGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveTagCategoriesCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/tagcategories/count": { "get": { "tags": [ "Tag Categories" ], "summary": "Retrieve count of Tag Categories", "description": "Returns the total count of Tag Categories records in the organization matching the current access context.", "operationId": "tagCategoriesCount", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Int32CrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/tagcategories/info": { "get": { "tags": [ "Tag Categories" ], "summary": "Retrieve Tag Categories metadata", "description": "Retrieves attribute information specific to the Tag Categories type. This data changes rarely and Crelate recommends caching it.", "operationId": "tagCategoriesGetInfo", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInfoCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/tags": { "get": { "tags": [ "Tags" ], "summary": "Retrieve Tags", "description": "Records must match all filters provided unless the OR filter operator is specified.\r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.\r\n If both recent and modified_after/modified_before are provided, recent will take precedence.", "operationId": "tagsGetRecords", "parameters": [ { "name": "category_ids", "in": "query", "description": "Tags that belong to the requested categories. To specify Tags without a category,provide an empty GUID (00000000-0000-0000-0000-000000000000).", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "ids", "in": "query", "description": "The primary keys of Tags to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Tags that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Tags that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "name", "in": "query", "description": "Tags whose name contains this text (case-insensitive substring match).", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "recent", "in": "query", "description": "Tags that have been modified in the last recent minutes", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"Name asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveTagsListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveTagsListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read.bulk" } }, "post": { "tags": [ "Tags" ], "summary": "Create a Tag", "description": "Creates a new Tags record and returns its generated ID.", "operationId": "tagsCreate", "requestBody": { "description": "The record to create.", "content": { "application/json": { "schema": { "required": [ "entity" ], "properties": { "entity": { "$ref": "#/components/schemas/CreateTags" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "409": { "description": "When duplicates are disabled or forbidden for the entity type(s) involved and completing the request would produce a duplicate record.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } } } } }, "/tags/{id}": { "get": { "tags": [ "Tags" ], "summary": "Retrieve a Tag", "description": "Returns a single Tags record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "tagsGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveTagsCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } }, "patch": { "tags": [ "Tags" ], "summary": "Update a Tag", "description": "Partially updates an existing Tags record. Only fields included in the request body are modified; omitted fields are left unchanged.", "operationId": "tagsUpdate", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to update.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The record to update.", "content": { "application/json": { "schema": { "required": [ "entity" ], "properties": { "entity": { "$ref": "#/components/schemas/UpdateTags" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/tags/count": { "get": { "tags": [ "Tags" ], "summary": "Retrieve count of Tags", "description": "Returns the total count of Tags records in the organization matching the current access context.", "operationId": "tagsCount", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Int32CrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } } } }, "/tags/info": { "get": { "tags": [ "Tags" ], "summary": "Retrieve Tags metadata", "description": "Retrieves attribute information specific to the Tags type. This data changes rarely and Crelate recommends caching it.", "operationId": "tagsGetInfo", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInfoCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/workflows/businessDevelopment/stages/{workflowStageId}/rules": { "get": { "tags": [ "Workflow Actions" ], "summary": "Retrieve Business Development workflow stage rules", "description": "Each Workflow Stage in Crelate can be customized with individual rules that influence behavior when changing the stage of a target record to a new stage. This endpoint exposes the rules for each workflow stage to inform behavior when making a stage change via the API.", "operationId": "workflowActionsGetBusinessDevelopmentStageRules", "parameters": [ { "name": "workflowStageId", "in": "path", "description": "The ID of the Business Development Workflow Stage to retrieve rules for.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessDevelopmentWorkflowStageRulesCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/workflows/businessDevelopment/stages/change": { "post": { "tags": [ "Workflow Actions" ], "summary": "Change Business Development workflow stage", "description": "Moves a target record to a new Business Development Workflow Stage. The rules for the destination stage (retrieved via the Retrieve Business Development workflow stage rules endpoint) determine which fields are required or optional.", "operationId": "workflowActionsChangeBusinessDevelopmentStage", "requestBody": { "description": "An optional file to attach to the activity created on stage change when `CreateActivity` is true.\n`changeStageRequest`: The stage change request describing the target record, destination stage, and any optional fields.", "content": { "multipart/form-data": { "schema": { "required": [ "changeStageRequest" ], "properties": { "activityAttachment": { "$ref": "#/components/schemas/CrelateFileStream" }, "changeStageRequest": { "allOf": [ { "$ref": "#/components/schemas/ChangeStageRequest" } ], "description": "Contains information necessary to perform a Workflow Stage change operation. What values must be provided depend on the rules defined for the target Workflow Stage as well as the Workflow Type." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.write" } } }, "/workflows/employmentSearch/stages/{workflowStageId}/rules": { "get": { "tags": [ "Workflow Actions" ], "summary": "Retrieve Employment Search workflow stage rules", "description": "Each Workflow Stage in Crelate can be customized with individual rules that influence behavior when changing the stage of a target record to a new stage. This endpoint exposes the rules for each workflow stage to inform behavior when making a stage change via the API.", "operationId": "workflowActionsGetEmploymentSearchStageRules", "parameters": [ { "name": "workflowStageId", "in": "path", "description": "The ID of the Employment Search Workflow Stage to retrieve rules for.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmploymentSearchWorkflowStageRulesCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/workflows/employmentSearch/stages/change": { "post": { "tags": [ "Workflow Actions" ], "summary": "Change Employment Search workflow stage", "description": "Moves a target record to a new Employment Search Workflow Stage. The rules for the destination stage (retrieved via the Retrieve Employment Search workflow stage rules endpoint) determine which fields are required or optional.", "operationId": "workflowActionsChangeEmploymentSearchStage", "requestBody": { "description": "An optional file to attach to the activity created on stage change when `CreateActivity` is true.\n`changeStageRequest`: The stage change request describing the target record, destination stage, and any optional fields.", "content": { "multipart/form-data": { "schema": { "required": [ "changeStageRequest" ], "properties": { "activityAttachment": { "$ref": "#/components/schemas/CrelateFileStream" }, "changeStageRequest": { "$ref": "#/components/schemas/ChangeStageRequest" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.write" } } }, "/workflows/recruiting/stages/{workflowStageId}/rules": { "get": { "tags": [ "Workflow Actions" ], "summary": "Retrieve Recruiting workflow stage rules", "description": "Each Workflow Stage in Crelate can be customized with individual rules that influence behavior when changing the stage of a target record (such as a Contact or Job) to a new stage. This endpoint exposes the rules for each workflow stage to inform behavior when making a stage change via the API.", "operationId": "workflowActionsGetRecruitingStageRules", "parameters": [ { "name": "workflowStageId", "in": "path", "description": "The ID of the Recruiting Workflow Stage to retrieve rules for.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecruitingWorkflowStageRulesCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/workflows/recruiting/stages/change": { "post": { "tags": [ "Workflow Actions" ], "summary": "Change Recruiting workflow stage", "description": "Moves a target record to a new Recruiting Workflow Stage. The rules for the destination stage (retrieved via the Retrieve Recruiting workflow stage rules endpoint) determine which fields are required or optional.", "operationId": "workflowActionsChangeRecruitingStage", "requestBody": { "description": "An optional file to attach to the activity created on stage change when `CreateActivity` is true.\n`changeStageRequest`: The stage change request describing the target record, destination stage, and any optional fields.", "content": { "multipart/form-data": { "schema": { "required": [ "changeStageRequest" ], "properties": { "activityAttachment": { "$ref": "#/components/schemas/CrelateFileStream" }, "changeStageRequest": { "$ref": "#/components/schemas/ChangeStageRequest" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.write" } } }, "/workflows/sales/stages/{workflowStageId}/rules": { "get": { "tags": [ "Workflow Actions" ], "summary": "Retrieve Sales workflow stage rules", "description": "Each Workflow Stage in Crelate can be customized with individual rules that influence behavior when changing the stage of a target record to a new stage. This endpoint exposes the rules for each workflow stage to inform behavior when making a stage change via the API.", "operationId": "workflowActionsGetSalesStageRules", "parameters": [ { "name": "workflowStageId", "in": "path", "description": "The ID of the Sales Workflow Stage to retrieve rules for.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesWorkflowStageRulesCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.read" } } }, "/workflows/sales/stages/change": { "post": { "tags": [ "Workflow Actions" ], "summary": "Change Sales workflow stage", "description": "Moves a target record to a new Sales Workflow Stage. The rules for the destination stage (retrieved via the Retrieve Sales workflow stage rules endpoint) determine which fields are required or optional.", "operationId": "workflowActionsChangeSalesStage", "requestBody": { "description": "An optional file to attach to the activity created on stage change when `CreateActivity` is true.\n`changeStageRequest`: The stage change request describing the target record, destination stage, and any optional fields.", "content": { "multipart/form-data": { "schema": { "required": [ "changeStageRequest" ], "properties": { "activityAttachment": { "$ref": "#/components/schemas/CrelateFileStream" }, "changeStageRequest": { "$ref": "#/components/schemas/ChangeStageRequest" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "scope": "crelate.mcp.write" } } }, "/workflowstatuses": { "get": { "tags": [ "Workflow Statuses" ], "summary": "Retrieve Workflow Statuses", "description": "Records must match all filters provided unless the OR filter operator is specified.\r\n If no sort_by is provided, the resulting list will be sorted by ModifiedOn descending.\r\n If both recent and modified_after/modified_before are provided, recent will take precedence.\r\n Whether a Workflow Status is open comes from its MeaningId, not its Name: \"New\" and \"In Progress\" are open; \"Done\", \"Done, Positive Outcome\" and \"Done, Negative Outcome\" are closed; \"Related\" is neither.", "operationId": "workflowStatusesGetRecords", "parameters": [ { "name": "external_primary_keys", "in": "query", "description": "External Primary Keys of Workflow Statuses to filter on.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "ids", "in": "query", "description": "The primary keys of Workflow Statuses to retrieve.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "limit", "in": "query", "description": "Maximum number of records to retrieve.", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "modified_after", "in": "query", "description": "Workflow Statuses that have been modified after this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "modified_before", "in": "query", "description": "Workflow Statuses that have been modified before this date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "offset", "in": "query", "description": "Number of records to offset the retrieve by. It is highly recommended to set sort_by if setting this.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "recent", "in": "query", "description": "Workflow Statuses that have been modified in the last recent minutes", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort_by", "in": "query", "description": "Comma separated sort options. Each option is an attribute with an optional direction (e.g., `\"FirstName asc\"`). Default direction of ascending if not provided.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "workflow_type_ids", "in": "query", "description": "The Workflow type to limit results to.Possible values are:\n * Recruiting = `F6EF012F-998D-4132-B38B-A17A00B2B958`c>\n * EmploymentSearch = `07DF70FE-C56E-4EC5-B656-A22000D149EF`\n * Sales = `56544447-B7A1-40D9-BAAF-A6B000FACCC7`\n * BusinessDevelopment = `0027E210-1E59-4715-A19C-B13B00EB4FB0`", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving records.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveWorkflowStatusesListCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } }, "206": { "description": "One or more of the requested records were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveWorkflowStatusesListCrelateResponse" } } } } }, "x-crelate-mcp": { "expose": true, "description": "Decide whether a stage is open from MeaningId, never from Name: \"New\" and \"In Progress\" are open; \"Done\", \"Done, Positive Outcome\" and \"Done, Negative Outcome\" are closed; \"Related\" is neither.", "scope": "crelate.mcp.read.bulk" } } }, "/workflowstatuses/{id}": { "get": { "tags": [ "Workflow Statuses" ], "summary": "Retrieve a Workflow Status", "description": "Returns a single Workflow Statuses record by its unique identifier. Returns a 404 if the record does not exist.", "operationId": "workflowStatusesGetById", "parameters": [ { "name": "id", "in": "path", "description": "The primary key of the record to retrieve.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fields", "in": "query", "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "total_count", "in": "query", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "unmask_values", "in": "query", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body.", "schema": { "type": "boolean" } }, { "name": "filter_operator", "in": "query", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "schema": { "type": "string" } } ], "requestBody": { "description": "Options for modifying behavior when retrieving a record.", "content": { "application/json": { "schema": { "properties": { "options": { "$ref": "#/components/schemas/RetrieveOptions" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveWorkflowStatusesCrelateResponse" } } } }, "500": { "description": "An internal error occurred while processing a request.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "400": { "description": "The request contains one or more invalid parameters or data.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "401": { "description": "The request lacks an authorization scheme.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "403": { "description": "The provided authorization scheme yielded insufficient privilege to perform the requested operation.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "404": { "description": "The requested resource(s) was/were not found.\n\nThe `errors` array provides more specific details when this status code is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCrelateResponse" } } } }, "429": { "description": "The rate limit has been exceeded. This response does not use the standard response envelope. Wait `retry_after_seconds` seconds before retrying; no `Retry-After` header is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitErrorResponse" } } } } }, "x-crelate-mcp": { "expose": true, "description": "Decide whether a stage is open from MeaningId, never from Name: \"New\" and \"In Progress\" are open; \"Done\", \"Done, Positive Outcome\" and \"Done, Negative Outcome\" are closed; \"Related\" is neither.", "scope": "crelate.mcp.read" } } } }, "components": { "schemas": { "AcademicHonorsBase": { "type": "object", "properties": { "Name": { "type": "string", "description": "The name of the academic honor.", "nullable": true } }, "additionalProperties": false, "description": "Base class containing properties shared across all operation models for Academic Honors." }, "AccreditationsBase": { "type": "object", "properties": { "Value": { "type": "string", "description": "The name of the accreditation.", "nullable": true } }, "additionalProperties": false, "description": "Base class containing properties shared across all operation models for Accreditations." }, "AccreditingInstitutionsBase": { "type": "object", "properties": { "Name": { "type": "string", "description": "The name of the accrediting institution.", "nullable": true } }, "additionalProperties": false, "description": "Base class containing properties shared across all operation models for Accrediting Institutions." }, "ActivitiesBase": { "type": "object", "properties": { "Announced": { "type": "boolean", "description": "Whether the Activity is announced within Crelate.", "nullable": true }, "Completed": { "type": "boolean", "description": "Whether the Activity is completed.", "nullable": true }, "CompletedOn": { "type": "string", "description": "The date the Activity was completed on.", "format": "date-time", "nullable": true }, "Display": { "type": "string", "description": "The plain text to display with the Activity. This is always returned wrapped in a JSON string array (ex: [\"Follow up tomorrow\"]). Mutually exclusive with the Html field.", "nullable": true }, "ExternalPrimaryKey": { "type": "string", "description": "The external primary key of a record. Not guaranteed to be globally unique.", "nullable": true }, "Pinned": { "type": "boolean", "description": "Whether the Activity is pinned to the top of its parent record's activity stream.", "nullable": true }, "When": { "type": "string", "description": "Records the date and time an event occured.", "format": "date-time", "nullable": true }, "WhenEnd": { "type": "string", "description": "The date and time when the Activity ends.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Base class containing properties shared across all operation models for Activities." }, "AddressEntity": { "required": [ "Count", "EntityName", "IsReadOnly", "Keys", "Values" ], "type": "object", "properties": { "EntityName": { "type": "string" }, "EntityStatus": { "type": "integer", "format": "int32", "nullable": true }, "Id": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "AddressesBase": { "type": "object", "properties": { "City": { "type": "string", "description": "The city of the address.", "nullable": true }, "IsPrimary": { "type": "boolean", "description": "Whether the address is the primary address of the parent record.", "nullable": true }, "Line1": { "type": "string", "description": "The first line of the address.", "nullable": true }, "Line2": { "type": "string", "description": "The second line of the address.", "nullable": true }, "Location": { "allOf": [ { "$ref": "#/components/schemas/GeoLocation" } ], "description": "Describes a geographic location by decimal degree latitude and longitude values. Domain model representation of the Location Metabase attribute type.", "nullable": true }, "State": { "type": "string", "description": "The state or province of the address.", "nullable": true }, "ZipCode": { "type": "string", "description": "The ZIP or postal code of the address.", "nullable": true } }, "additionalProperties": false, "description": "Base class containing properties shared across all operation models for Addresses." }, "AllTeams": { "required": [ "Teams", "Users" ], "type": "object", "properties": { "Teams": { "type": "array", "items": { "$ref": "#/components/schemas/TeamEntity" }, "description": "Teams in this org" }, "Users": { "type": "array", "items": { "$ref": "#/components/schemas/UserEntity" }, "description": "Users who belong to teams in this org" } }, "additionalProperties": false }, "AllTeamsCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/AllTeams" } ], "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "AllowContactOptionTypes": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "Describes how a record status enforces contact options for associated records.\n\n0 = Unknown\n\n1 = No\n\n2 = Yes\n\n3 = Limited", "format": "int32", "x-enumNames": [ "Unknown", "No", "Yes", "Limited" ], "x-enumDescriptions": [ "", "", "", "" ] }, "ApplicantInfo": { "required": [ "Email_Personal", "FirstName", "LastName" ], "type": "object", "properties": { "Address_Home": { "allOf": [ { "$ref": "#/components/schemas/AddressEntity" } ], "description": "The home address of the applicant.", "nullable": true }, "ContactSourceId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Contact Source of the applicant. This will be transferred to the Contact when the application is processed and converted to a Contact record.", "nullable": true }, "Email_Personal": { "minLength": 1, "type": "string", "description": "The personal email address of the applicant." }, "FirstName": { "minLength": 1, "type": "string", "description": "The first name of the applicant." }, "LastName": { "minLength": 1, "type": "string", "description": "The last name of the applicant." }, "MiddleName": { "type": "string", "description": "The middle name of the applicant.", "nullable": true }, "Phone_Mobile": { "type": "string", "description": "The personal phone number of the applicant.", "nullable": true }, "RefererUrl": { "type": "string", "description": "This field does not provide any functionality and is only maintained for backwards compatibility purposes. It may be removed in a future release.", "nullable": true } }, "additionalProperties": false, "description": "Basic information about a person who has applied for a job in Crelate." }, "ApplicationProcessResult": { "required": [ "ApplicationId", "ContactMatches" ], "type": "object", "properties": { "ApplicationId": { "type": "string", "description": "The primary key of the application processed.", "format": "uuid" }, "ContactId": { "type": "string", "description": "If the processed application was approved, the primary key of the contact record created or merged with.", "format": "uuid", "nullable": true }, "ContactMatches": { "type": "array", "items": { "$ref": "#/components/schemas/ContactEntity" }, "description": "Any contact records found that may possibly match the applicant. Matches may be approximate (fuzzy) or perfect matches." } }, "additionalProperties": false, "description": "Represents successful processing of an application for a job, containing information about the outcome, like any conflicts with existing records." }, "ApplicationProcessResultCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/ApplicationProcessResult" } ], "description": "Represents successful processing of an application for a job, containing information about the outcome, like any conflicts with existing records.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "ApproveApplicantWorkflowAction": { "required": [ "ApplicationId", "IgnorePossibleMatches" ], "type": "object", "properties": { "ApplicationId": { "type": "string", "description": "The primary key of the application.", "format": "uuid" }, "IgnorePossibleMatches": { "type": "boolean", "description": "If true, any matching contact found is ignored and a new, duplicate contact is created. If false (this is default), duplicate detection rules apply and MatchedContactId is required if a match is found." }, "MatchedContactId": { "type": "string", "description": "The primary key of an existing contact that an application corresponds to. Providing this value will merge the applicant's information with the linked contact.", "format": "uuid", "nullable": true }, "Note": { "type": "string", "description": "A note to be added to the contact when they are approved. This may be required depending on your account settings.", "nullable": true } }, "additionalProperties": false }, "ArtifactsBase": { "type": "object", "properties": { "ExternalPrimaryKey": { "type": "string", "description": "The external primary key of a record. Not guaranteed to be globally unique.", "nullable": true }, "FileName": { "type": "string", "description": "The raw file name of the binary file data of the Artifact. Null for Artifacts without a file.", "nullable": true } }, "additionalProperties": false, "description": "Base class containing properties shared across all operation models for Attachments." }, "AssignmentDeliveryTypeInfo": { "required": [ "DeliveryTypeId", "DeliveryTypeName", "EntityType" ], "type": "object", "properties": { "DeliveryTypeId": { "type": "string", "format": "uuid" }, "DeliveryTypeName": { "type": "string" }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] } }, "additionalProperties": false }, "AssignmentDeliveryTypeInfoListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/AssignmentDeliveryTypeInfo" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "AssignmentDeliveryTypes": { "required": [ "AssignmentCreatedOn", "AssignmentId", "AssignmentName", "ContactId", "ContactName", "DeliveryTypes", "JobTitle", "PlacementWorksite", "TimeEntryFormat" ], "type": "object", "properties": { "AssignmentCreatedOn": { "type": "string", "format": "date-time" }, "AssignmentId": { "type": "string", "format": "uuid" }, "AssignmentName": { "type": "string" }, "ContactId": { "type": "string", "format": "uuid" }, "ContactName": { "type": "string" }, "DeliveryTypes": { "type": "array", "items": { "$ref": "#/components/schemas/AssignmentDeliveryTypeInfo" } }, "GeofencingOption": { "allOf": [ { "$ref": "#/components/schemas/GeofencingOptions" } ], "description": "\n\n0 = None (Geofencing is disabled.)\n\n1 = Log (Geofencing is Enabled. Time Recorder location will be captured when submitting time.)\n\n2 = Warning (Geofencing is Enabled. Time Recorders will be warned when entering time manually or outside the geofence. Time entered manually or outside the geofence will be flagged on approvals.)\n\n3 = Restrict (Geofencing is Enabled. Time Recorders must be within the geofence bounds to submit time.)", "nullable": true }, "JobId": { "type": "string", "format": "uuid", "nullable": true }, "JobTitle": { "type": "string" }, "PlacementEntityStatus": { "type": "integer", "format": "int32", "nullable": true }, "PlacementWorksite": { "allOf": [ { "$ref": "#/components/schemas/WorksitesLookup" } ] }, "TimeEntryFormat": { "allOf": [ { "$ref": "#/components/schemas/TimeEntryFormat" } ], "description": "Describes the time entry type. This is a System Picklist enum and will be generated in the future.\n\n0 = None\n\n1 = Straight (Straight Time)\n\n2 = Pipo (Punch In/Punch Out)", "x-enumNames": [ "None", "Straight", "Pipo" ], "x-enumDescriptions": [ "", "Straight Time", "Punch In/Punch Out" ] }, "TimePeriodGroupId": { "type": "string", "format": "uuid", "nullable": true }, "UserId": { "allOf": [ { "$ref": "#/components/schemas/UsersLookup" } ], "nullable": true } }, "additionalProperties": false }, "AssignmentDeliveryTypesListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/AssignmentDeliveryTypes" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "AttachmentContentMode": { "enum": [ 0, 1, 2, 4 ], "type": "integer", "description": "Describes the type of file to return.\n\n0 = Original\n\n1 = Preview\n\n2 = Thumbnail\n\n4 = PreviewText", "format": "int32", "x-enumNames": [ "Original", "Preview", "Thumbnail", "PreviewText" ], "x-enumDescriptions": [ "", "", "", "" ] }, "AttachmentCreateOptions": { "required": [ "DisableIndexingOptions", "IgnoreTinyImages", "OverwriteExisting", "OverwriteLockedFile" ], "type": "object", "properties": { "IgnoreTinyImages": { "type": "boolean", "description": "If true, ignore images that are narrower than 5px in either dimension." }, "OverwriteExisting": { "type": "boolean", "description": "If true, overwrite any existing file with the same file name on the same parent record." }, "OverwriteLockedFile": { "type": "boolean", "description": "If true, overwrite any existing file that is currently being edited." } }, "additionalProperties": false, "description": "Options for creating an attachment record." }, "AttachmentsLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BackupEntity": { "required": [ "Count", "EntityName", "IsReadOnly", "Keys", "Values" ], "type": "object", "properties": { "AttachmentStatusDetails": { "type": "string", "description": "Status progress details of attachments including attachment entity records and attachment files", "nullable": true }, "BackupDetails": { "type": "string", "description": "Include all of the package info like the zips, ids, etc", "nullable": true }, "BackupVersion": { "type": "integer", "description": "This is used to indicate which backup service version this backup created by to help for logging and tracing.", "format": "int32", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/UsersLookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "EntityName": { "type": "string" }, "EntityStatus": { "type": "integer", "format": "int32", "nullable": true }, "ExternalPrimaryKey": { "type": "string", "description": "The external primary key of a record. Not guaranteed to be globally unique.", "nullable": true }, "Id": { "type": "string", "format": "uuid", "nullable": true }, "IncludeAttachments": { "type": "boolean", "description": "Whether the Backup includes Artifact file attachments.", "nullable": true }, "IncludeModifiedAfter": { "type": "string", "description": "The timestamp only after which to include records in the Backup.", "format": "date-time", "nullable": true }, "IncludeRestrictedAttachments": { "type": "boolean", "description": "Whether the Backup includes Artifact file attachments from restricted storage.", "nullable": true }, "Name": { "maxLength": 255, "type": "string", "description": "The name of the Backup.", "nullable": true }, "Password": { "maxLength": 255, "type": "string", "description": "The password to unlock the Backup.", "nullable": true }, "SourceId": { "allOf": [ { "$ref": "#/components/schemas/SourcesLookup" } ], "description": "The source of a record.", "nullable": true }, "Status": { "maxLength": 255, "type": "string", "description": "The current status of the Backup.", "nullable": true }, "StatusDetails": { "type": "string", "description": "Detailed status information about the Backup.", "nullable": true } }, "additionalProperties": false }, "BillableItemTypeOption": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "\n\n0 = Unknown\n\n1 = ServiceOrGoods\n\n2 = Expense", "format": "int32", "x-enumNames": [ "Unknown", "ServiceOrGoods", "Expense" ], "x-enumDescriptions": [ "", "", "" ] }, "BlockApplicantWorkflowAction": { "required": [ "ApplicationId", "IgnorePossibleMatches" ], "type": "object", "properties": { "ApplicationId": { "type": "string", "description": "The primary key of the application.", "format": "uuid" }, "IgnorePossibleMatches": { "type": "boolean", "description": "If true, any matching contact found is ignored and a new, duplicate contact is created. If false (this is default), duplicate detection rules apply and MatchedContactId is required if a match is found." }, "MatchedContactId": { "type": "string", "description": "The primary key of an existing contact that an application corresponds to. Providing this value will merge the applicant's information with the linked contact.", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "BooleanCrelateResponse": { "required": [ "Data", "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "boolean", "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time." }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "BusinessDevelopmentWorkflowStageRules": { "required": [ "CreateActivity", "CreateActivityOptional", "CreateActivityPrompt", "CreateLead", "MoveWhenActivityCreated", "MoveWhenSubmittalCreated", "SendEmail" ], "type": "object", "properties": { "CreateActivity": { "type": "boolean", "description": "Whether an activity should be created upon stage change." }, "CreateActivityOptional": { "type": "boolean", "description": "When CreateActivity is true, whether creating an activity on stage change is optional." }, "CreateActivityPrompt": { "type": "boolean", "description": "When CreateActivity is true, whether to prompt for activity notes and details. When false, the activity would be created without any notes or details." }, "CreateActivityType": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "When CreateActivity is true, the type of activity to create.", "nullable": true }, "CreateLead": { "type": "boolean", "description": "Whether to create a Lead." }, "LinkedSequence": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The sequence (automation) linked to this stage, if any. When set, moving items into this stage may prompt to add them to the linked sequence.", "nullable": true }, "MoveActivityType": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "When MoveWhenActivityCreated is true, the activity type that will trigger the automatic stage change.", "nullable": true }, "MoveWhenActivityCreated": { "type": "boolean", "description": "Whether a Workflow Stage change is automatically triggered by the creation of an activity.\r\n Warning: Candidates that are moved by creating this activity type will not prompt users for a submission. Additionally, users will not be prompted for notes for the above selected activity under \"Create a new activity\"." }, "MoveWhenSubmittalCreated": { "type": "boolean", "description": "Whether a Workflow Stage change is automatically triggered by the creation of a Submittal." }, "SendEmail": { "type": "boolean", "description": "Whether to optionally send an email on stage change. Stage transitions that send email must be made manually from within Crelate as the API does not accept them." }, "SendEmailTemplate": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "When SendEmail is true, an optional email template to begin forming an email from. Depending on the workflow type, the context of the email may differ: for Sales, only Jobs, but for Recruiting, Employment Search, and Business Development, Contacts and Jobs. Stage transitions that send email must be made manually from within Crelate as the API does not accept them.", "nullable": true } }, "additionalProperties": false, "description": "Rules to apply when changing Business Development Workflow stages. Each stage has separate rules." }, "BusinessDevelopmentWorkflowStageRulesCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/BusinessDevelopmentWorkflowStageRules" } ], "description": "Rules to apply when changing Business Development Workflow stages. Each stage has separate rules.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "ChangeStageRequest": { "required": [ "TargetId" ], "type": "object", "properties": { "Activity": { "allOf": [ { "$ref": "#/components/schemas/CreateActivities" } ], "description": "The Activity to create alongside the stage change.\r\n Whether this field is accepted, required, or rejected depends on the destination stage's rules (retrievable via the `GET …/stages/{id}/rules` endpoint): \n * `CreateActivity = false`: the stage does not create any activity.Providing `Activity` here will result in a validation error.\n * `CreateActivity = true`, `CreateActivityPrompt = false`: the platformautomatically generates a stage change activity via an internal pipeline event.Providing `Activity` here will result in a validation error because accepting itwould create a duplicate activity.\n * `CreateActivity = true`, `CreateActivityPrompt = true`, `CreateActivityOptional = false`:an activity is required. `Activity` must be provided.If `CreateActivityType` is set, the activity's verb must match that type.\n * `CreateActivity = true`, `CreateActivityPrompt = true`, `CreateActivityOptional = true`:an activity is optional. `Activity` may be omitted or provided.", "nullable": true }, "JobId": { "type": "string", "description": "When the target record is not a Job, the related Job. Required for the Recruiting workflow.", "format": "uuid", "nullable": true }, "LossReason": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Loss Reason for Sales Workflow Stage changes that result in a Loss.", "nullable": true }, "TargetId": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "The record being moved in the Workflow. For the Recruiting workflow, this will be a Contact; for the Sales workflow, this will be a Lead or Job; for the Employment Search workflow, this will be a Job or Company; for the Business Development workflow, this will be a Lead or Job." }, "WorkflowStageId": { "type": "string", "description": "The Workflow Stage to move the target record to. Provide either WorkflowStageId or WorkflowStageName — one is required.", "format": "uuid", "nullable": true }, "WorkflowStageName": { "type": "string", "description": "The name of the Workflow Stage to move the target record to. Provide either WorkflowStageName or WorkflowStageId — one is required. Name matching is case-insensitive.", "nullable": true } }, "additionalProperties": false, "description": "Contains information necessary to perform a Workflow Stage change operation. What values must be provided depend on the rules defined for the target Workflow Stage as well as the Workflow Type." }, "CompaniesBase": { "type": "object", "properties": { "CustomField1": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField10": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField11": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField12": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField13": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField14": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField15": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField16": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField17": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField18": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField19": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField2": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField20": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField21": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField22": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField23": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField24": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField25": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField26": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField27": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField28": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField29": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField3": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField30": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField4": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField41": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField42": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField43": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField44": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField45": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField46": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField47": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField48": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField49": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField5": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField50": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField51": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField52": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField53": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField54": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField55": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField56": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField57": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField58": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField59": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField6": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField60": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField61": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField62": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField63": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField64": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField65": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField66": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField67": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField68": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField69": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField7": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField70": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField8": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField9": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomFields": { "type": "object", "additionalProperties": { }, "description": "A property bag for custom fields, keyed by logical name.", "nullable": true }, "Department": { "type": "string", "description": "Name or description of the department or division of the company.", "nullable": true }, "Description": { "type": "string", "description": "A full description of the Company. (This field allows formatted text)", "nullable": true }, "Domain": { "type": "string", "description": "Stores the canonical domain name for the company", "nullable": true }, "EBITDA": { "type": "number", "description": "Earnings Before Interest, Taxes, Depreciation and Amortization", "format": "double", "nullable": true }, "EstimatedRevenue": { "type": "number", "description": "Estimated Revenue", "format": "double", "nullable": true }, "ExternalPrimaryKey": { "type": "string", "description": "The external primary key of a record. Not guaranteed to be globally unique.", "nullable": true }, "Name": { "type": "string", "description": "The name of the Company.", "nullable": true }, "RecordType": { "type": "integer", "description": "Allows categorizing a Company with values such as \"Customer\".", "format": "int32", "nullable": true }, "Revenue": { "type": "number", "description": "Revenue from this Company.", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "Base class containing properties shared across all operation models for Companies." }, "ContactEntity": { "required": [ "Count", "EntityName", "IsReadOnly", "Keys", "Values" ], "type": "object", "properties": { "Addresses": { "allOf": [ { "$ref": "#/components/schemas/MultiPass" } ], "description": "A collection of addresses (Home address, Work Address, etc.)", "nullable": true }, "AssignmentStatus": { "type": "integer", "description": "Calculated field that described the Contact's current Assignment status.", "format": "int32", "nullable": true }, "AverageRating": { "type": "number", "description": "The average rating of all completed scorecards for this Contact", "format": "float", "nullable": true }, "ConsentStatus": { "type": "integer", "description": "", "format": "int32", "nullable": true }, "ContactNum": { "type": "integer", "description": "If auto-numbering on Contacts is enabled, then an incrementing unique Id number will be assigned to each Contact. Note: This field will NOT appear on the \"New Contact\" form.", "format": "int32", "nullable": true }, "ContactNumber": { "maxLength": 255, "type": "string", "description": "A user-customizable number representing a contact.", "nullable": true }, "ContactSourceId": { "allOf": [ { "$ref": "#/components/schemas/ContactSourcesLookup" } ], "description": "Tracks the original source of a candidate. i.e., which job board the candidate came from or who referred them", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/UsersLookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "CurrentJobLevel": { "maxLength": 255, "type": "string", "description": "General categorization level for the Contact's Job Title.", "nullable": true }, "CurrentJobTitle": { "maxLength": 255, "type": "string", "description": "This Contact's Current Job Title", "nullable": true }, "CurrentPosition": { "allOf": [ { "$ref": "#/components/schemas/MultiPass" } ], "description": "The Contact's current company and job title (and optionally, the start date and end date).", "nullable": true }, "CustomField1": { "type": "string", "description": "This is a Custom Field", "nullable": true }, "CustomField10": { "type": "string", "description": "This is a Custom Field", "nullable": true }, "CustomField11": { "type": "number", "description": "This is a Custom Field", "format": "double", "nullable": true }, "CustomField12": { "type": "number", "description": "This is a Custom Field", "format": "double", "nullable": true }, "CustomField13": { "type": "number", "description": "This is a Custom Field", "format": "double", "nullable": true }, "CustomField14": { "type": "number", "description": "This is a Custom Field", "format": "double", "nullable": true }, "CustomField15": { "type": "number", "description": "This is a Custom Field", "format": "double", "nullable": true }, "CustomField16": { "type": "number", "description": "This is a Custom Field", "format": "double", "nullable": true }, "CustomField17": { "type": "number", "description": "This is a Custom Field", "format": "double", "nullable": true }, "CustomField18": { "type": "number", "description": "This is a Custom Field", "format": "double", "nullable": true }, "CustomField19": { "type": "number", "description": "This is a Custom Field", "format": "double", "nullable": true }, "CustomField2": { "type": "string", "description": "This is a Custom Field", "nullable": true }, "CustomField20": { "type": "number", "description": "This is a Custom Field", "format": "double", "nullable": true }, "CustomField21": { "type": "string", "description": "This is a Custom Field", "format": "date-time", "nullable": true }, "CustomField22": { "type": "string", "description": "This is a Custom Field", "format": "date-time", "nullable": true }, "CustomField23": { "type": "string", "description": "This is a Custom Field", "format": "date-time", "nullable": true }, "CustomField24": { "type": "string", "description": "This is a Custom Field", "format": "date-time", "nullable": true }, "CustomField25": { "type": "string", "description": "This is a Custom Field", "format": "date-time", "nullable": true }, "CustomField26": { "type": "string", "description": "This is a Custom Field", "format": "date-time", "nullable": true }, "CustomField27": { "type": "string", "description": "This is a Custom Field", "format": "date-time", "nullable": true }, "CustomField28": { "type": "string", "description": "This is a Custom Field", "format": "date-time", "nullable": true }, "CustomField29": { "type": "string", "description": "This is a Custom Field", "format": "date-time", "nullable": true }, "CustomField3": { "type": "string", "description": "This is a Custom Field", "nullable": true }, "CustomField30": { "type": "string", "description": "This is a Custom Field", "format": "date-time", "nullable": true }, "CustomField31": { "allOf": [ { "$ref": "#/components/schemas/CustomFieldMultiLookup" } ], "description": "This is a Custom Field", "nullable": true }, "CustomField32": { "allOf": [ { "$ref": "#/components/schemas/CustomFieldMultiLookup" } ], "description": "This is a Custom Field", "nullable": true }, "CustomField33": { "allOf": [ { "$ref": "#/components/schemas/CustomFieldMultiLookup" } ], "description": "This is a Custom Field", "nullable": true }, "CustomField34": { "allOf": [ { "$ref": "#/components/schemas/CustomFieldMultiLookup" } ], "description": "This is a Custom Field", "nullable": true }, "CustomField35": { "allOf": [ { "$ref": "#/components/schemas/CustomFieldMultiLookup" } ], "description": "This is a Custom Field", "nullable": true }, "CustomField36": { "allOf": [ { "$ref": "#/components/schemas/CustomFieldMultiLookup" } ], "description": "This is a Custom Field", "nullable": true }, "CustomField37": { "allOf": [ { "$ref": "#/components/schemas/CustomFieldMultiLookup" } ], "description": "This is a Custom Field", "nullable": true }, "CustomField38": { "allOf": [ { "$ref": "#/components/schemas/CustomFieldMultiLookup" } ], "description": "This is a Custom Field", "nullable": true }, "CustomField39": { "allOf": [ { "$ref": "#/components/schemas/CustomFieldMultiLookup" } ], "description": "This is a Custom Field", "nullable": true }, "CustomField4": { "type": "string", "description": "This is a Custom Field", "nullable": true }, "CustomField40": { "allOf": [ { "$ref": "#/components/schemas/CustomFieldMultiLookup" } ], "description": "This is a Custom Field", "nullable": true }, "CustomField41": { "type": "string", "description": "This is a Custom Field", "nullable": true }, "CustomField42": { "type": "string", "description": "This is a Custom Field", "nullable": true }, "CustomField43": { "type": "string", "description": "This is a Custom Field", "nullable": true }, "CustomField44": { "type": "string", "description": "This is a Custom Field", "nullable": true }, "CustomField45": { "type": "string", "description": "This is a Custom Field", "nullable": true }, "CustomField46": { "type": "string", "description": "This is a Custom Field", "nullable": true }, "CustomField47": { "type": "string", "description": "This is a Custom Field", "nullable": true }, "CustomField48": { "type": "string", "description": "This is a Custom Field", "nullable": true }, "CustomField49": { "type": "string", "description": "This is a Custom Field", "nullable": true }, "CustomField5": { "type": "string", "description": "This is a Custom Field", "nullable": true }, "CustomField50": { "type": "string", "description": "This is a Custom Field", "nullable": true }, "CustomField51": { "type": "number", "description": "This is a Custom Field", "format": "double", "nullable": true }, "CustomField52": { "type": "number", "description": "This is a Custom Field", "format": "double", "nullable": true }, "CustomField53": { "type": "number", "description": "This is a Custom Field", "format": "double", "nullable": true }, "CustomField54": { "type": "number", "description": "This is a Custom Field", "format": "double", "nullable": true }, "CustomField55": { "type": "number", "description": "This is a Custom Field", "format": "double", "nullable": true }, "CustomField56": { "type": "number", "description": "This is a Custom Field", "format": "double", "nullable": true }, "CustomField57": { "type": "number", "description": "This is a Custom Field", "format": "double", "nullable": true }, "CustomField58": { "type": "number", "description": "This is a Custom Field", "format": "double", "nullable": true }, "CustomField59": { "type": "number", "description": "This is a Custom Field", "format": "double", "nullable": true }, "CustomField6": { "type": "string", "description": "This is a Custom Field", "nullable": true }, "CustomField60": { "type": "number", "description": "This is a Custom Field", "format": "double", "nullable": true }, "CustomField61": { "type": "string", "description": "This is a Custom Field", "format": "date-time", "nullable": true }, "CustomField62": { "type": "string", "description": "This is a Custom Field", "format": "date-time", "nullable": true }, "CustomField63": { "type": "string", "description": "This is a Custom Field", "format": "date-time", "nullable": true }, "CustomField64": { "type": "string", "description": "This is a Custom Field", "format": "date-time", "nullable": true }, "CustomField65": { "type": "string", "description": "This is a Custom Field", "format": "date-time", "nullable": true }, "CustomField66": { "type": "string", "description": "This is a Custom Field", "format": "date-time", "nullable": true }, "CustomField67": { "type": "string", "description": "This is a Custom Field", "format": "date-time", "nullable": true }, "CustomField68": { "type": "string", "description": "This is a Custom Field", "format": "date-time", "nullable": true }, "CustomField69": { "type": "string", "description": "This is a Custom Field", "format": "date-time", "nullable": true }, "CustomField7": { "type": "string", "description": "This is a Custom Field", "nullable": true }, "CustomField70": { "type": "string", "description": "This is a Custom Field", "format": "date-time", "nullable": true }, "CustomField71": { "allOf": [ { "$ref": "#/components/schemas/CustomFieldMultiLookup" } ], "description": "This is a Custom Field", "nullable": true }, "CustomField72": { "allOf": [ { "$ref": "#/components/schemas/CustomFieldMultiLookup" } ], "description": "This is a Custom Field", "nullable": true }, "CustomField73": { "allOf": [ { "$ref": "#/components/schemas/CustomFieldMultiLookup" } ], "description": "This is a Custom Field", "nullable": true }, "CustomField74": { "allOf": [ { "$ref": "#/components/schemas/CustomFieldMultiLookup" } ], "description": "This is a Custom Field", "nullable": true }, "CustomField75": { "allOf": [ { "$ref": "#/components/schemas/CustomFieldMultiLookup" } ], "description": "This is a Custom Field", "nullable": true }, "CustomField76": { "allOf": [ { "$ref": "#/components/schemas/CustomFieldMultiLookup" } ], "description": "This is a Custom Field", "nullable": true }, "CustomField77": { "allOf": [ { "$ref": "#/components/schemas/CustomFieldMultiLookup" } ], "description": "This is a Custom Field", "nullable": true }, "CustomField78": { "allOf": [ { "$ref": "#/components/schemas/CustomFieldMultiLookup" } ], "description": "This is a Custom Field", "nullable": true }, "CustomField79": { "allOf": [ { "$ref": "#/components/schemas/CustomFieldMultiLookup" } ], "description": "This is a Custom Field", "nullable": true }, "CustomField8": { "type": "string", "description": "This is a Custom Field", "nullable": true }, "CustomField80": { "allOf": [ { "$ref": "#/components/schemas/CustomFieldMultiLookup" } ], "description": "This is a Custom Field", "nullable": true }, "CustomField9": { "type": "string", "description": "This is a Custom Field", "nullable": true }, "Description": { "type": "string", "description": "A general description of the Contact. This can include formatted text.", "nullable": true }, "DesiredSalaryMax": { "type": "number", "description": "Maximum Desired Salary", "format": "double", "nullable": true }, "DesiredSalaryMin": { "type": "number", "description": "Minimum Desired Salary", "format": "double", "nullable": true }, "Disability": { "allOf": [ { "$ref": "#/components/schemas/DisabilityStatusType" } ], "description": "Appropriately casts the DisabilityStatus as the enum\n\n0 = None\n\n1 = Declined\n\n2 = NotQualified\n\n3 = Qualified", "nullable": true }, "DisabilityStatus": { "type": "integer", "description": "The OFCCP field for this Contact's disability status.", "format": "int32", "nullable": true }, "Education": { "allOf": [ { "$ref": "#/components/schemas/MultiPass" } ], "description": "The Contact's education info (School, Degree, Graduation Year, etc.)", "nullable": true }, "EeoEthnicity": { "type": "integer", "description": "The EEO field for this Contact's ethnicity.", "format": "int32", "nullable": true }, "EeoGender": { "type": "integer", "description": "The EEO field for this Contact's gender.", "format": "int32", "nullable": true }, "EmailAddresses": { "allOf": [ { "$ref": "#/components/schemas/MultiPass" } ], "description": "A collection of email addresses (Personal Email, Work Email, etc.)", "nullable": true }, "EntityName": { "type": "string" }, "EntityStatus": { "type": "integer", "format": "int32", "nullable": true }, "EthnicityId": { "allOf": [ { "$ref": "#/components/schemas/EEO_EthnicityLookup" } ], "description": "The Contact's ethnicity", "nullable": true }, "ExternalPrimaryKey": { "type": "string", "description": "The external primary key of a record. Not guaranteed to be globally unique.", "nullable": true }, "FirstName": { "maxLength": 255, "type": "string", "description": "The Contact's first name or given name.", "nullable": true }, "FullName": { "type": "string", "description": "The Contact' Full Name (First Last)", "nullable": true }, "GenderId": { "allOf": [ { "$ref": "#/components/schemas/EEO_GenderLookup" } ], "description": "The Contact's gender", "nullable": true }, "HRAddressLine1": { "maxLength": 255, "type": "string", "description": "Address Line 1 of the Contact's legal address.", "nullable": true }, "HRAddressLine2": { "maxLength": 255, "type": "string", "description": "Address Line 2 of the Contact's legal address.", "nullable": true }, "HRCity": { "maxLength": 100, "type": "string", "description": "City of the Contact's legal address.", "nullable": true }, "HRCountryId": { "allOf": [ { "$ref": "#/components/schemas/CountriesLookup" } ], "description": "Country of the Contact's legal address.", "nullable": true }, "HRDateOfBirth": { "type": "string", "description": "The Contact's legal birth date.", "format": "date-time", "nullable": true }, "HREmergencyContactFirstName": { "maxLength": 255, "type": "string", "description": "First Name of the Contact's Emergency Contact.", "nullable": true }, "HREmergencyContactLastName": { "maxLength": 255, "type": "string", "description": "Last Name of the Contact's Emergency Contact.", "nullable": true }, "HREmergencyContactPhoneNumber": { "maxLength": 100, "type": "string", "description": "Phone Number of the Contact's Emergency Contact.", "nullable": true }, "HRFirstName": { "maxLength": 255, "type": "string", "description": "The Contact's legal first name or given name used for HR purposes.", "nullable": true }, "HRHireDate": { "type": "string", "description": "The day that the Contact was hired at the Organization.", "format": "date-time", "nullable": true }, "HRLastName": { "maxLength": 255, "type": "string", "description": "The Contact's legal last name, surname, or family name used for HR purposes.", "nullable": true }, "HRMiddleName": { "maxLength": 255, "type": "string", "description": "The Contact's legal middle name or middle initial used for HR purposes.", "nullable": true }, "HRPhoneNumber": { "maxLength": 100, "type": "string", "description": "The Contact's main contact number used for HR purposes.", "nullable": true }, "HRStartDate": { "type": "string", "description": "The actual day that the Contact began work.", "format": "date-time", "nullable": true }, "HRState": { "maxLength": 100, "type": "string", "description": "State of the Contact's legal address.", "nullable": true }, "HRStatus": { "type": "integer", "description": "The Contact's legal working status with an Organization.", "format": "int32", "nullable": true }, "HRWorkAuthorizationStatus": { "type": "integer", "description": "The Contact's legal ability to work in the country", "format": "int32", "nullable": true }, "HRWorkEligibilityStatus": { "type": "integer", "description": "This Contact's work eligibility status.", "format": "int32", "nullable": true }, "HRWorksiteId": { "allOf": [ { "$ref": "#/components/schemas/WorksitesLookup" } ], "description": "Legal worksite where the Contact performs their work.", "nullable": true }, "HRZipCode": { "maxLength": 100, "type": "string", "description": "ZIP Code of the Contact's legal address.", "nullable": true }, "IconAttachmentId": { "allOf": [ { "$ref": "#/components/schemas/AttachmentsLookup" } ], "description": "The attachment to use as a Contact's profile picture.", "nullable": true }, "Id": { "type": "string", "format": "uuid", "nullable": true }, "ImportId": { "allOf": [ { "$ref": "#/components/schemas/ImportsLookup" } ], "description": "", "nullable": true }, "InstantAddresses": { "allOf": [ { "$ref": "#/components/schemas/MultiPass" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "JobClassificationCategoryId": { "allOf": [ { "$ref": "#/components/schemas/JobClassificationCategoryLookup" } ], "description": "The EEO Field for the Contact's Job Category.", "nullable": true }, "JobClassificationId": { "allOf": [ { "$ref": "#/components/schemas/JobClassificationLookup" } ], "description": "The EEO field for this Contact's job classification.", "nullable": true }, "JobTitleLevel": { "maxLength": 255, "type": "string", "description": "Classified level for the Contact's current job title.", "nullable": true }, "JobTitleRole": { "maxLength": 255, "type": "string", "description": "Classified role for the Contact's current job title.", "nullable": true }, "JobTitleSubRole": { "maxLength": 255, "type": "string", "description": "Classified sub-role for the Contact's current job title.", "nullable": true }, "JobTypeIds": { "allOf": [ { "$ref": "#/components/schemas/JobTypesMultiLookup" } ], "description": "The type of job this Contact works or is willing to work (\"Full time\", \"Part Time\", \"Hourly\", etc.)", "nullable": true }, "KeyDates": { "allOf": [ { "$ref": "#/components/schemas/MultiPass" } ], "description": "A collection of key dates for this Contact (Birthday, Anniversary, etc.)", "nullable": true }, "LastActionDate": { "type": "string", "description": "The last time there was an action by a Crelate user regarding this Contact, such as creating an activity, sending an email, or moving the Contact to a new stage.", "format": "date-time", "nullable": true }, "LastActivityDate": { "type": "string", "description": "The last date a Contact had a new Activity logged.", "format": "date-time", "nullable": true }, "LastActivityOrModifiedOn": { "type": "string", "description": "The last time this Contact was either modified, or the last time an activity was created for this Contact.", "format": "date-time", "nullable": true }, "LastActivityRegardingId": { "allOf": [ { "$ref": "#/components/schemas/JobsLookup" } ], "description": "The Job the last Activity logged to the Contact was regarding.", "nullable": true }, "LastEngagementDate": { "type": "string", "description": "The date a Contact was last engaged with by an activity that was marked as engagement.", "format": "date-time", "nullable": true }, "LastEnrichmentDate": { "type": "string", "description": "This is updated with date/time of the latest enrichment attempt, whether the record gets enriched successfully or not", "format": "date-time", "nullable": true }, "LastName": { "maxLength": 255, "type": "string", "description": "The Contact's last name, surname, or family name.", "nullable": true }, "LastReachOutBy": { "allOf": [ { "$ref": "#/components/schemas/UsersLookup" } ], "description": "The last user who created a reach out activity for this Contact, such as sending an email, sending a text message, or leaving a voicemail.", "nullable": true }, "LastReachOutDate": { "type": "string", "description": "The last time there was an reach out activity by a Crelate user regarding this Contact, such as sending an email, sending a text message, or leaving a voicemail.", "format": "date-time", "nullable": true }, "LatestPinnedNote": { "maxLength": 255, "type": "string", "description": "The text of the latest pinned Note Activity for the Contact.", "nullable": true }, "LinkedUserType": { "type": "integer", "description": "Determines the type of User that is linked to the Contact. Used for various filters.", "format": "int32", "nullable": true }, "MiddleName": { "type": "string", "description": "The Contact's middle name or middle initial", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "Name": { "type": "string", "description": "The Contact's full name", "nullable": true }, "NickName": { "type": "string", "description": "The Contact's nick name", "nullable": true }, "OrganizationId": { "allOf": [ { "$ref": "#/components/schemas/OrganizationsLookup" } ], "description": "The organization a record belongs to.", "nullable": true }, "Owners": { "allOf": [ { "$ref": "#/components/schemas/UsersMultiLookup" } ], "description": "Tracks the Crelate user (or users) who owns this Contact record.", "nullable": true }, "PayrollExportKey": { "maxLength": 255, "type": "string", "description": "Id of the current record in your Payroll system - used for export.", "nullable": true }, "PayrollStatus": { "type": "integer", "description": "This Contact's eligibility for payroll.", "format": "int32", "nullable": true }, "PhoneNumbers": { "allOf": [ { "$ref": "#/components/schemas/MultiPass" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PreferredContactMethodTypeId": { "allOf": [ { "$ref": "#/components/schemas/PreferredContactMethodTypesLookup" } ], "description": "The Contact's preferred contact method (Email, Phone, or Text)", "nullable": true }, "PrimaryCity": { "maxLength": 255, "type": "string", "description": "This Contact's Primary City", "nullable": true }, "PrimaryDocumentAttachmentId": { "allOf": [ { "$ref": "#/components/schemas/AttachmentsLookup" } ], "description": "The primary Artifact of the Contact.", "nullable": true }, "PrimaryEmail": { "maxLength": 255, "type": "string", "description": "This Contact's Primary Email", "nullable": true }, "PrimaryEmailDomain": { "maxLength": 255, "type": "string", "description": "This Contact's Primary Email Domain (Calculated)", "nullable": true }, "PrimaryPhone": { "maxLength": 255, "type": "string", "description": "This Contact's Primary Phone Number", "nullable": true }, "PrimaryState": { "maxLength": 255, "type": "string", "description": "This Contact's Current State or Province", "nullable": true }, "PrimaryZip": { "maxLength": 255, "type": "string", "description": "This Contact's Primary ZIP or Postal Code", "nullable": true }, "RecordType": { "type": "integer", "description": "The type of Contact (Either \"Candidate\", \"Client Contact\", or both)", "format": "int32", "nullable": true }, "RelatedContacts": { "allOf": [ { "$ref": "#/components/schemas/MultiPass" } ], "description": "A collection of other Contacts that are related to the contact (e.g., \"Spouse\", \"Assistant\", \"Referred By\")", "nullable": true }, "Salary": { "type": "number", "description": "The Contact's salary. This field can be hidden from non-administrator users in Security Settings.", "format": "double", "nullable": true }, "SalaryDetails": { "type": "string", "description": "Additional free-form salary details, such as benefits or bonuses.", "nullable": true }, "Salutation": { "allOf": [ { "$ref": "#/components/schemas/SalutationTypesLookup" } ], "description": "The Contact's salutation or name prefix (e.g. \"Mr.\", \"Mrs.\", \"Dr.\")", "nullable": true }, "SocialSecurityNumber": { "maxLength": 255, "type": "string", "description": "The Social Security number of a Contact.", "nullable": true }, "SourceId": { "allOf": [ { "$ref": "#/components/schemas/SourcesLookup" } ], "description": "The source of a record.", "nullable": true }, "SpokenTo": { "type": "boolean", "description": "", "nullable": true }, "StatusReason": { "maxLength": 255, "type": "string", "description": "An optional text field explaining the reason for the StatusId field.", "nullable": true }, "SuffixId": { "allOf": [ { "$ref": "#/components/schemas/SuffixTypesLookup" } ], "description": "The Contact's suffix (\"Sr.\", \"Jr.\", etc.)", "nullable": true }, "Tags": { "allOf": [ { "$ref": "#/components/schemas/TagsMultiLookup" } ], "description": "The tags for the Contact.", "nullable": true }, "TotalExperience": { "type": "number", "description": "Total years of work experience (union of months across all positions).", "format": "double", "nullable": true }, "TotalExperienceCurrentRole": { "type": "number", "description": "Total years of experience in the Contact's current job title role.", "format": "double", "nullable": true }, "TotalExperienceCurrentSubRole": { "type": "number", "description": "Total years of experience in the Contact's current job title sub-role.", "format": "double", "nullable": true }, "TotalExperienceCxo": { "type": "number", "description": "Total years of experience at CXO level (includes owner/partner).", "format": "double", "nullable": true }, "TotalExperienceDirector": { "type": "number", "description": "Total years of experience at director level.", "format": "double", "nullable": true }, "TotalExperienceManager": { "type": "number", "description": "Total years of experience at manager level.", "format": "double", "nullable": true }, "TotalExperienceSenior": { "type": "number", "description": "Total years of experience at senior level.", "format": "double", "nullable": true }, "TotalExperienceVp": { "type": "number", "description": "Total years of experience at VP level.", "format": "double", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/UsersLookup" } ], "description": "The user who last updated a record.", "nullable": true }, "UserId": { "allOf": [ { "$ref": "#/components/schemas/UsersLookup" } ], "description": "The user that is associated with this Contact.", "nullable": true }, "Veteran": { "allOf": [ { "$ref": "#/components/schemas/VeteranStatusType" } ], "description": "Appropriately casts the VeteranStatus as the enum\n\n0 = None\n\n1 = Declined\n\n2 = NotQualified\n\n3 = Qualified", "nullable": true }, "VeteranStatus": { "type": "integer", "description": "The VEVRAA field for this Contact's Veteran Status.", "format": "int32", "nullable": true }, "Websites": { "allOf": [ { "$ref": "#/components/schemas/MultiPass" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true } }, "additionalProperties": false }, "ContactSourcesLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ContactStatusesLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ContactWorkflowHistoryDetail": { "required": [ "Stage" ], "type": "object", "properties": { "Action": { "type": "string", "description": "The type of action that occurred. Can be `AddedToJob` or `ChangedStage`.", "nullable": true }, "Contact": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The contact/candidate whose workflow stage changed.", "nullable": true }, "Date": { "type": "string", "description": "The date and time a stage change occurred.", "format": "date-time", "nullable": true }, "Job": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The job the workflow is on. A value may not be available for some history entries.", "nullable": true }, "PassReason": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "For a stage change resulting in a pass, the pass reason.", "nullable": true }, "PassReasonNotes": { "type": "string", "description": "For a stage change resulting in a pass, any pass reason notes.", "nullable": true }, "Stage": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The stage the contact/candidate moved to." }, "User": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who triggered the stage change.", "nullable": true } }, "additionalProperties": false, "description": "Represents a candidate's stage in a recruiting workflow at a point in time." }, "ContactWorkflowHistoryDetailPagedListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/ContactWorkflowHistoryDetail" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "ContactsBase": { "type": "object", "properties": { "ContactNumber": { "type": "string", "description": "A user-customizable number representing a contact.", "nullable": true }, "CustomField1": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField10": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField11": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField12": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField13": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField14": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField15": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField16": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField17": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField18": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField19": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField2": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField20": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField21": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField22": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField23": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField24": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField25": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField26": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField27": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField28": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField29": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField3": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField30": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField4": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField41": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField42": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField43": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField44": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField45": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField46": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField47": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField48": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField49": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField5": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField50": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField51": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField52": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField53": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField54": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField55": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField56": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField57": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField58": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField59": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField6": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField60": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField61": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField62": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField63": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField64": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField65": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField66": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField67": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField68": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField69": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField7": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField70": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField8": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField9": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomFields": { "type": "object", "additionalProperties": { }, "description": "A property bag for custom fields, keyed by logical name.", "nullable": true }, "Description": { "type": "string", "description": "A general description of the Contact. This can include formatted text.", "nullable": true }, "DesiredSalaryMax": { "type": "number", "description": "Maximum Desired Salary", "format": "double", "nullable": true }, "DesiredSalaryMin": { "type": "number", "description": "Minimum Desired Salary", "format": "double", "nullable": true }, "ExternalPrimaryKey": { "type": "string", "description": "The external primary key of a record. Not guaranteed to be globally unique.", "nullable": true }, "FirstName": { "type": "string", "description": "The Contact's first name or given name.", "nullable": true }, "LastName": { "type": "string", "description": "The Contact's last name, surname, or family name.", "nullable": true }, "MiddleName": { "type": "string", "description": "The Contact's middle name or middle initial", "nullable": true }, "NickName": { "type": "string", "description": "The Contact's nick name", "nullable": true }, "RecordType": { "type": "integer", "description": "The type of Contact (Either \"Candidate\", \"Client Contact\", or both)", "format": "int32", "nullable": true }, "Salary": { "type": "number", "description": "The Contact's salary. This field can be hidden from non-administrator users in Security Settings.", "format": "double", "nullable": true }, "SalaryDetails": { "type": "string", "description": "Additional free-form salary details, such as benefits or bonuses.", "nullable": true }, "SpokenTo": { "type": "boolean", "nullable": true } }, "additionalProperties": false, "description": "Base class containing properties shared across all operation models for Contacts." }, "ContactsLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CountriesLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateAcademicHonors": { "allOf": [ { "$ref": "#/components/schemas/AcademicHonorsBase" }, { "type": "object", "additionalProperties": false } ], "description": "The model for creating Academic Honors." }, "CreateAccreditations": { "allOf": [ { "$ref": "#/components/schemas/AccreditationsBase" }, { "type": "object", "additionalProperties": false } ], "description": "The model for creating Accreditations." }, "CreateAccreditingInstitutions": { "allOf": [ { "$ref": "#/components/schemas/AccreditingInstitutionsBase" }, { "type": "object", "additionalProperties": false } ], "description": "The model for creating Accrediting Institutions." }, "CreateActivities": { "allOf": [ { "$ref": "#/components/schemas/ActivitiesBase" }, { "type": "object", "properties": { "BCC": { "type": "string", "description": "The Blind Carbon Copy (BCC) recipients for Email Activities.", "nullable": true }, "CC": { "type": "string", "description": "The Carbon Copy (CC) recipients for Email Activities.", "nullable": true }, "From": { "type": "string", "description": "The sender address for Email Activities.", "nullable": true }, "Html": { "type": "string", "description": "The HTML content of the Activity. Not all HTML is allowed and some tags may be removed. Mutually exclusive with the Display field.", "nullable": true }, "IsEngagement": { "type": "boolean", "description": "Whether the Activity is considered engagement with the parent record.", "nullable": true }, "IsReachOut": { "type": "boolean", "description": "Whether the Activity is considered a reach-out to the parent record.", "nullable": true }, "Owners": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" }, "description": "The Crelate user, or users, who owns a record.", "nullable": true }, "ParentId": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "The parent record of the Activity.", "nullable": true }, "RegardingId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Job the Activity is regarding.", "nullable": true }, "Subject": { "type": "string", "description": "The subject line for Email Activities.", "nullable": true }, "To": { "type": "string", "description": "The primary recipient(s) for Email Activities.", "nullable": true }, "VerbId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Specifies the Activity Type of the record, which controls its behavior and available functionality.", "nullable": true } }, "additionalProperties": false } ], "description": "The model for creating Activities." }, "CreateAddresses": { "allOf": [ { "$ref": "#/components/schemas/AddressesBase" }, { "type": "object", "properties": { "CountryId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The standardized country of the address.", "nullable": true } }, "additionalProperties": false } ], "description": "The model for creating Addresses." }, "CreateArtifacts": { "allOf": [ { "$ref": "#/components/schemas/ArtifactsBase" }, { "type": "object", "properties": { "AttachmentTypeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The standardized type of the Artifact.", "nullable": true }, "TargetEntityId": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "The entity targeted by a record.", "nullable": true } }, "additionalProperties": false } ], "description": "The model for creating Artifacts." }, "CreateCompanies": { "allOf": [ { "$ref": "#/components/schemas/CompaniesBase" }, { "type": "object", "properties": { "AccountSourceId": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "Tracks the original source of a Company. i.e., who or what referred the Company to you.", "nullable": true }, "AdditionalContacts_Billing": { "allOf": [ { "$ref": "#/components/schemas/CreateRelatedContacts" } ], "description": "Contacts related to the Company (e.g., Billing Contact)", "nullable": true }, "AdditionalContacts_OtherContact": { "allOf": [ { "$ref": "#/components/schemas/CreateRelatedContacts" } ], "description": "Contacts related to the Company (e.g., Billing Contact)", "nullable": true }, "Addresses_Business": { "allOf": [ { "$ref": "#/components/schemas/CreateAddresses" } ], "description": "Collection of physical addresses for this Company (e.g., Business address, Headquarters)", "nullable": true }, "Addresses_Headquarters": { "allOf": [ { "$ref": "#/components/schemas/CreateAddresses" } ], "description": "Collection of physical addresses for this Company (e.g., Business address, Headquarters)", "nullable": true }, "Addresses_Other": { "allOf": [ { "$ref": "#/components/schemas/CreateAddresses" } ], "description": "Collection of physical addresses for this Company (e.g., Business address, Headquarters)", "nullable": true }, "CustomField31": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField32": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField33": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField34": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField35": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField36": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField37": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField38": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField39": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField40": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField71": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField72": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField73": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField74": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField75": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField76": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField77": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField78": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField79": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField80": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "EmailAddresses_Other": { "allOf": [ { "$ref": "#/components/schemas/CreateEmailAddresses" } ], "description": "Collection of email addresses for this Company (Sales, Support, etc.)", "nullable": true }, "EmailAddresses_Sales": { "allOf": [ { "$ref": "#/components/schemas/CreateEmailAddresses" } ], "description": "Collection of email addresses for this Company (Sales, Support, etc.)", "nullable": true }, "EmailAddresses_Support": { "allOf": [ { "$ref": "#/components/schemas/CreateEmailAddresses" } ], "description": "Collection of email addresses for this Company (Sales, Support, etc.)", "nullable": true }, "IconAttachmentId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Artifact shown as the icon for the Company.", "nullable": true }, "Owners": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" }, "description": "The Crelate user, or users, who owns a record.", "nullable": true }, "ParentAccountId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The parent Company, such as in the case of a subsidiary.", "nullable": true }, "PhoneNumbers_Fax": { "allOf": [ { "$ref": "#/components/schemas/CreatePhoneNumbers" } ], "description": "Collection of phone numbers for this Company (e.g., Main, Sales, Support)", "nullable": true }, "PhoneNumbers_Main": { "allOf": [ { "$ref": "#/components/schemas/CreatePhoneNumbers" } ], "description": "Collection of phone numbers for this Company (e.g., Main, Sales, Support)", "nullable": true }, "PhoneNumbers_Other": { "allOf": [ { "$ref": "#/components/schemas/CreatePhoneNumbers" } ], "description": "Collection of phone numbers for this Company (e.g., Main, Sales, Support)", "nullable": true }, "PhoneNumbers_Sales": { "allOf": [ { "$ref": "#/components/schemas/CreatePhoneNumbers" } ], "description": "Collection of phone numbers for this Company (e.g., Main, Sales, Support)", "nullable": true }, "PhoneNumbers_Skype": { "allOf": [ { "$ref": "#/components/schemas/CreatePhoneNumbers" } ], "description": "Collection of phone numbers for this Company (e.g., Main, Sales, Support)", "nullable": true }, "PhoneNumbers_Support": { "allOf": [ { "$ref": "#/components/schemas/CreatePhoneNumbers" } ], "description": "Collection of phone numbers for this Company (e.g., Main, Sales, Support)", "nullable": true }, "Tags": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" } }, "description": "The tags for the Company.", "nullable": true }, "Websites_Blog": { "allOf": [ { "$ref": "#/components/schemas/CreateUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true }, "Websites_Business": { "allOf": [ { "$ref": "#/components/schemas/CreateUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true }, "Websites_CareerPage": { "allOf": [ { "$ref": "#/components/schemas/CreateUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true }, "Websites_Facebook": { "allOf": [ { "$ref": "#/components/schemas/CreateUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true }, "Websites_Leadership_People": { "allOf": [ { "$ref": "#/components/schemas/CreateUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true }, "Websites_LinkedIn": { "allOf": [ { "$ref": "#/components/schemas/CreateUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true }, "Websites_Other": { "allOf": [ { "$ref": "#/components/schemas/CreateUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true }, "Websites_Other_Alternate": { "allOf": [ { "$ref": "#/components/schemas/CreateUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true }, "Websites_Twitter": { "allOf": [ { "$ref": "#/components/schemas/CreateUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true } }, "additionalProperties": false } ], "description": "The model for creating Companies." }, "CreateContacts": { "allOf": [ { "$ref": "#/components/schemas/ContactsBase" }, { "type": "object", "properties": { "Addresses_Business": { "allOf": [ { "$ref": "#/components/schemas/CreateAddresses" } ], "description": "A collection of addresses (Home address, Work Address, etc.)", "nullable": true }, "Addresses_Home": { "allOf": [ { "$ref": "#/components/schemas/CreateAddresses" } ], "description": "A collection of addresses (Home address, Work Address, etc.)", "nullable": true }, "Addresses_Other": { "allOf": [ { "$ref": "#/components/schemas/CreateAddresses" } ], "description": "A collection of addresses (Home address, Work Address, etc.)", "nullable": true }, "ContactSourceId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Tracks the original source of a candidate. i.e., which job board the candidate came from or who referred them", "nullable": true }, "CurrentPosition": { "allOf": [ { "$ref": "#/components/schemas/CreateWorkHistoryTimelineItem" } ], "description": "The Contact's current company and job title (and optionally, the start date and end date).", "nullable": true }, "CustomField31": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField32": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField33": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField34": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField35": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField36": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField37": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField38": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField39": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField40": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField71": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField72": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField73": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField74": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField75": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField76": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField77": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField78": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField79": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField80": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "Education": { "allOf": [ { "$ref": "#/components/schemas/CreateEducationTimelineItem" } ], "description": "The Contact's education info (School, Degree, Graduation Year, etc.)", "nullable": true }, "EmailAddresses_Other": { "allOf": [ { "$ref": "#/components/schemas/CreateEmailAddresses" } ], "description": "A collection of email addresses (Personal Email, Work Email, etc.)", "nullable": true }, "EmailAddresses_Other_Alternate": { "allOf": [ { "$ref": "#/components/schemas/CreateEmailAddresses" } ], "description": "A collection of email addresses (Personal Email, Work Email, etc.)", "nullable": true }, "EmailAddresses_Personal": { "allOf": [ { "$ref": "#/components/schemas/CreateEmailAddresses" } ], "description": "A collection of email addresses (Personal Email, Work Email, etc.)", "nullable": true }, "EmailAddresses_Personal_Other": { "allOf": [ { "$ref": "#/components/schemas/CreateEmailAddresses" } ], "description": "A collection of email addresses (Personal Email, Work Email, etc.)", "nullable": true }, "EmailAddresses_Potential": { "allOf": [ { "$ref": "#/components/schemas/CreateEmailAddresses" } ], "description": "A collection of email addresses (Personal Email, Work Email, etc.)", "nullable": true }, "EmailAddresses_Work": { "allOf": [ { "$ref": "#/components/schemas/CreateEmailAddresses" } ], "description": "A collection of email addresses (Personal Email, Work Email, etc.)", "nullable": true }, "EmailAddresses_Work_Other": { "allOf": [ { "$ref": "#/components/schemas/CreateEmailAddresses" } ], "description": "A collection of email addresses (Personal Email, Work Email, etc.)", "nullable": true }, "EthnicityId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Contact's ethnicity", "nullable": true }, "GenderId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Contact's gender", "nullable": true }, "IconAttachmentId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The attachment to use as a Contact's profile picture.", "nullable": true }, "InstantAddresses_AIM": { "allOf": [ { "$ref": "#/components/schemas/CreateInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "InstantAddresses_FacebookChat": { "allOf": [ { "$ref": "#/components/schemas/CreateInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "InstantAddresses_FaceTime": { "allOf": [ { "$ref": "#/components/schemas/CreateInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "InstantAddresses_GoogleTalk": { "allOf": [ { "$ref": "#/components/schemas/CreateInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "InstantAddresses_ICQ": { "allOf": [ { "$ref": "#/components/schemas/CreateInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "InstantAddresses_Other": { "allOf": [ { "$ref": "#/components/schemas/CreateInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "InstantAddresses_Skype": { "allOf": [ { "$ref": "#/components/schemas/CreateInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "InstantAddresses_Twitter": { "allOf": [ { "$ref": "#/components/schemas/CreateInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "InstantAddresses_Yahoo_Msg": { "allOf": [ { "$ref": "#/components/schemas/CreateInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "JobTypeIds": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "The type of job this Contact works or is willing to work (\"Full time\", \"Part Time\", \"Hourly\", etc.)", "nullable": true }, "KeyDates_Anniversary": { "allOf": [ { "$ref": "#/components/schemas/CreateDates" } ], "description": "A collection of key dates for this Contact (Birthday, Anniversary, etc.)", "nullable": true }, "KeyDates_Birthday": { "allOf": [ { "$ref": "#/components/schemas/CreateDates" } ], "description": "A collection of key dates for this Contact (Birthday, Anniversary, etc.)", "nullable": true }, "KeyDates_Other": { "allOf": [ { "$ref": "#/components/schemas/CreateDates" } ], "description": "A collection of key dates for this Contact (Birthday, Anniversary, etc.)", "nullable": true }, "Owners": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" }, "description": "Tracks the Crelate user (or users) who owns this Contact record.", "nullable": true }, "PhoneNumbers_Fax": { "allOf": [ { "$ref": "#/components/schemas/CreatePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Home": { "allOf": [ { "$ref": "#/components/schemas/CreatePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Mobile": { "allOf": [ { "$ref": "#/components/schemas/CreatePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Mobile_Other": { "allOf": [ { "$ref": "#/components/schemas/CreatePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Other": { "allOf": [ { "$ref": "#/components/schemas/CreatePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Other_Alternate": { "allOf": [ { "$ref": "#/components/schemas/CreatePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Potential": { "allOf": [ { "$ref": "#/components/schemas/CreatePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Skype": { "allOf": [ { "$ref": "#/components/schemas/CreatePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Work_Direct": { "allOf": [ { "$ref": "#/components/schemas/CreatePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Work_Main": { "allOf": [ { "$ref": "#/components/schemas/CreatePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Work_Other": { "allOf": [ { "$ref": "#/components/schemas/CreatePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PreferredContactMethodTypeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Contact's preferred contact method (Email, Phone, or Text)", "nullable": true }, "RelatedContacts_Assistant": { "allOf": [ { "$ref": "#/components/schemas/CreateRelatedContacts" } ], "description": "A collection of other Contacts that are related to the contact (e.g., \"Spouse\", \"Assistant\", \"Referred By\")", "nullable": true }, "RelatedContacts_OtherContact": { "allOf": [ { "$ref": "#/components/schemas/CreateRelatedContacts" } ], "description": "A collection of other Contacts that are related to the contact (e.g., \"Spouse\", \"Assistant\", \"Referred By\")", "nullable": true }, "RelatedContacts_ReferredBy": { "allOf": [ { "$ref": "#/components/schemas/CreateRelatedContacts" } ], "description": "A collection of other Contacts that are related to the contact (e.g., \"Spouse\", \"Assistant\", \"Referred By\")", "nullable": true }, "RelatedContacts_Spouse": { "allOf": [ { "$ref": "#/components/schemas/CreateRelatedContacts" } ], "description": "A collection of other Contacts that are related to the contact (e.g., \"Spouse\", \"Assistant\", \"Referred By\")", "nullable": true }, "Salutation": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Contact's salutation or name prefix (e.g. \"Mr.\", \"Mrs.\", \"Dr.\")", "nullable": true }, "SuffixId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Contact's suffix (\"Sr.\", \"Jr.\", etc.)", "nullable": true }, "Tags": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" } }, "description": "The tags for the Contact.", "nullable": true }, "Websites_Blog": { "allOf": [ { "$ref": "#/components/schemas/CreateUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_Business": { "allOf": [ { "$ref": "#/components/schemas/CreateUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_Facebook": { "allOf": [ { "$ref": "#/components/schemas/CreateUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_GitHub": { "allOf": [ { "$ref": "#/components/schemas/CreateUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_LinkedIn": { "allOf": [ { "$ref": "#/components/schemas/CreateUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_Other": { "allOf": [ { "$ref": "#/components/schemas/CreateUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_Other_Alternate": { "allOf": [ { "$ref": "#/components/schemas/CreateUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_Personal": { "allOf": [ { "$ref": "#/components/schemas/CreateUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_Portfolio": { "allOf": [ { "$ref": "#/components/schemas/CreateUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_Quora": { "allOf": [ { "$ref": "#/components/schemas/CreateUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_RSSFeed": { "allOf": [ { "$ref": "#/components/schemas/CreateUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true } }, "additionalProperties": false } ], "description": "The model for creating Contacts." }, "CreateDates": { "allOf": [ { "$ref": "#/components/schemas/DatesBase" }, { "type": "object", "additionalProperties": false } ], "description": "The model for creating Dates." }, "CreateEducationTimelineItem": { "required": [ "IsPrimary" ], "type": "object", "properties": { "AcademicHonorIds": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "Any academic honors achieved.", "nullable": true }, "AccreditationId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The accreditation, or degree, achieved.", "nullable": true }, "AccreditingInstitutionId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The accrediting institution where the accreditation was achieved.", "nullable": true }, "Details": { "type": "string", "description": "Text details or other notes about an education item. Allows some basic HTML.", "nullable": true }, "IsPrimary": { "type": "boolean", "description": "Whether an education item is the highest education achieved." }, "WhenEnd": { "type": "string", "description": "The year when education ended.", "format": "date-time", "nullable": true }, "WhenStart": { "type": "string", "description": "The year when education started.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "The model for creating an Education Timeline Item." }, "CreateEmailAddresses": { "allOf": [ { "$ref": "#/components/schemas/EmailAddressesBase" }, { "type": "object", "additionalProperties": false } ], "description": "The model for creating EmailAddresses." }, "CreateEmails": { "required": [ "To" ], "type": "object", "properties": { "BCC": { "type": "string", "description": "The blind carbon copy recipients of an email.", "nullable": true }, "CC": { "type": "string", "description": "The carbon copy recipients of an email.", "nullable": true }, "Display": { "type": "string", "description": "Plaintext email content. One of Display or Html may be provided.", "nullable": true }, "ExternalPrimaryKey": { "type": "string", "description": "The external primary key of a record. Not guaranteed to be globally unique.", "nullable": true }, "From": { "type": "string", "description": "Who sent an email.", "nullable": true }, "Html": { "type": "string", "description": "HTML email content. One of Display or Html may be provided.", "nullable": true }, "ParentId": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "The parent record an email is associated with.", "nullable": true }, "RegardingId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The job an email is regarding.", "nullable": true }, "Subject": { "type": "string", "description": "The subject line of an email.", "nullable": true }, "To": { "minLength": 1, "type": "string", "description": "Who an email was sent to." }, "When": { "type": "string", "description": "Records the date and time an event occured.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "The model for creating Email activities." }, "CreateInstantAddresses": { "allOf": [ { "$ref": "#/components/schemas/InstantAddressesBase" }, { "type": "object", "additionalProperties": false } ], "description": "The model for creating InstantAddresses." }, "CreateJobs": { "allOf": [ { "$ref": "#/components/schemas/JobsBase" }, { "type": "object", "properties": { "AccountId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The company associated with this Job", "nullable": true }, "AccountManagerId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Account manager for the job", "nullable": true }, "AdditionalContacts_Billing": { "allOf": [ { "$ref": "#/components/schemas/CreateRelatedContacts" } ], "description": "Contacts related to this Job (Hiring manager, executive sponsor, etc.)", "nullable": true }, "AdditionalContacts_ExecutiveSponsor": { "allOf": [ { "$ref": "#/components/schemas/CreateRelatedContacts" } ], "description": "Contacts related to this Job (Hiring manager, executive sponsor, etc.)", "nullable": true }, "AdditionalContacts_HiringManager": { "allOf": [ { "$ref": "#/components/schemas/CreateRelatedContacts" } ], "description": "Contacts related to this Job (Hiring manager, executive sponsor, etc.)", "nullable": true }, "AdditionalContacts_InternalRecruiter": { "allOf": [ { "$ref": "#/components/schemas/CreateRelatedContacts" } ], "description": "Contacts related to this Job (Hiring manager, executive sponsor, etc.)", "nullable": true }, "AdditionalContacts_OtherContact": { "allOf": [ { "$ref": "#/components/schemas/CreateRelatedContacts" } ], "description": "Contacts related to this Job (Hiring manager, executive sponsor, etc.)", "nullable": true }, "AdditionalContacts_Sales_ClientContact": { "allOf": [ { "$ref": "#/components/schemas/CreateRelatedContacts" } ], "description": "Contacts related to this Job (Hiring manager, executive sponsor, etc.)", "nullable": true }, "CustomField31": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField32": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField33": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField34": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField35": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField36": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField37": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField38": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField39": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField40": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField71": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField72": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField73": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField74": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField75": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField76": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField77": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField78": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField79": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField80": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "HiringManagerId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Hiring manager for the Job. The person responsible for communicating with the agency.", "nullable": true }, "JobTitleId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The job title or short description for this Job.", "nullable": true }, "JobTypeIds": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "The type of job (Full time, Part time, Hourly, etc.)", "nullable": true }, "LeadSourceId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The standardized Lead Source of the Job.", "nullable": true }, "Locations_Business": { "allOf": [ { "$ref": "#/components/schemas/CreateAddresses" } ], "description": "The location where this Job is available", "nullable": true }, "Locations_Other": { "allOf": [ { "$ref": "#/components/schemas/CreateAddresses" } ], "description": "The location where this Job is available", "nullable": true }, "OpportunityTypeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The type of opportunity (e.g., Job, Project)", "nullable": true }, "Owners": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" }, "description": "The owners of this Job record", "nullable": true }, "ParentJobId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The linked parent Job of the Job.", "nullable": true }, "PriorityId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The priority of the Job (e.g., Cold, Medium, Hot)", "nullable": true }, "RecruiterId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The id of the primary recruiter for this job", "nullable": true }, "SecondaryRecruiterId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "An additional Recruiter working on this Job alongside the primary Recruiter.", "nullable": true }, "SourcerId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Sourcer for the job", "nullable": true }, "Tags": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" } }, "description": "Tags for the Job.", "nullable": true }, "TimeCardApproverId": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "The time keeping approver for this job.", "nullable": true }, "TimeEntryFormat": { "allOf": [ { "$ref": "#/components/schemas/TimeEntryFormat" } ], "description": "The type of time entry for Time Keeping information.", "nullable": true }, "Websites_Description": { "allOf": [ { "$ref": "#/components/schemas/CreateUrls" } ], "description": "Website addresses or URLs associated with this Job", "nullable": true }, "Websites_Other": { "allOf": [ { "$ref": "#/components/schemas/CreateUrls" } ], "description": "Website addresses or URLs associated with this Job", "nullable": true }, "WorkflowTypeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The type of workflow (e.g., Recruiting or EmploymentSearch)", "nullable": true } }, "additionalProperties": false } ], "description": "The model for creating Jobs." }, "CreateNotes": { "required": [ "Display", "ParentId" ], "type": "object", "properties": { "Display": { "minLength": 1, "type": "string", "description": "Plaintext note content." }, "ExternalPrimaryKey": { "type": "string", "description": "The external primary key of a record. Not guaranteed to be globally unique.", "nullable": true }, "IsEngagement": { "type": "boolean", "description": "Whether a note constitutes any form of engagement.", "nullable": true }, "IsReachOut": { "type": "boolean", "description": "Whether a note constitutes any form of a reach-out.", "nullable": true }, "ParentId": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "The parent record a note is associated with." }, "RegardingId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The job a note is regarding.", "nullable": true }, "When": { "type": "string", "description": "The date a note was created. Defaults to creation timestamp if omitted.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "The model for creating Note activities." }, "CreatePhoneNumbers": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumbersBase" }, { "type": "object", "additionalProperties": false } ], "description": "The model for creating PhoneNumbers." }, "CreateRelatedContacts": { "allOf": [ { "$ref": "#/components/schemas/RelatedContactsBase" }, { "type": "object", "properties": { "Value": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "A lookup to a related entity of a single entity type within a set of allowed entity types.", "nullable": true } }, "additionalProperties": false } ], "description": "The model for creating Related Contacts." }, "CreateTagCategories": { "allOf": [ { "$ref": "#/components/schemas/TagCategoriesBase" }, { "type": "object", "properties": { "AllowedEntityTypes": { "type": "array", "items": { "type": "string" }, "description": "The type(s) of entities a tag category is allowed on.", "nullable": true } }, "additionalProperties": false } ], "description": "The model for creating Tag Categories." }, "CreateTags": { "allOf": [ { "$ref": "#/components/schemas/TagsBase" }, { "type": "object", "properties": { "TagCategoryId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The tag category of a tag. This is null for tags with no category.", "nullable": true } }, "additionalProperties": false } ], "description": "The model for creating Tags." }, "CreateTasks": { "required": [ "Display", "ParentId", "When" ], "type": "object", "properties": { "Display": { "minLength": 1, "type": "string", "description": "Free-form plaintext information about a task such as notes, reminders, or outcome of a task." }, "ExternalPrimaryKey": { "type": "string", "description": "The external primary key of a record. Not guaranteed to be globally unique.", "nullable": true }, "Owners": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" }, "description": "The Crelate user, or users, who owns a record.", "nullable": true }, "ParentId": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "The parent record a task is associated with." }, "RegardingId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The job a task is regarding.", "nullable": true }, "When": { "type": "string", "description": "For a scheduled task, when it occurs in UTC time.", "format": "date-time" } }, "additionalProperties": false, "description": "The model for creating Task activities." }, "CreateUrls": { "allOf": [ { "$ref": "#/components/schemas/UrlsBase" }, { "type": "object", "additionalProperties": false } ], "description": "The model for creating Urls." }, "CreateWorkHistoryTimelineItem": { "required": [ "IsPrimary" ], "type": "object", "properties": { "CompanyId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The company of a work history item.", "nullable": true }, "Details": { "type": "string", "description": "Text details or other notes about a work history item. Allows some basic HTML.", "nullable": true }, "IsPrimary": { "type": "boolean", "description": "Whether a work history item is the current position of the target." }, "JobTitle": { "type": "string", "description": "The job title of a work history item.", "nullable": true }, "WhenEnd": { "type": "string", "description": "The month and year when work ended.", "format": "date-time", "nullable": true }, "WhenStart": { "type": "string", "description": "The month and year when work started.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "The model for creating a Work History Timeline Item." }, "CreateWorksites": { "allOf": [ { "$ref": "#/components/schemas/WorksitesBase" }, { "type": "object", "properties": { "Addresses_Business": { "allOf": [ { "$ref": "#/components/schemas/CreateAddresses" } ], "description": "Address of the worksite.", "nullable": true }, "LegalEntityName": { "type": "string", "description": "Legal Entity Name of the worksite for tax purposes.", "nullable": true }, "ParentAccountId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Parent company that this worksite is for.", "nullable": true }, "PhoneNumbers_Main": { "allOf": [ { "$ref": "#/components/schemas/CreatePhoneNumbers" } ], "description": "Phone number for the worksite.", "nullable": true }, "PrimaryContactId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The primary point of contact for the worksite.", "nullable": true }, "WorksiteEIN": { "type": "string", "description": "Federal Employment Identification Number of the worksite for tax purposes.", "nullable": true }, "WorksiteNumber": { "type": "integer", "description": "Optional number of the worksite for tracking purposes (e.g., Store Number).", "format": "int32", "nullable": true }, "WorksiteType": { "type": "integer", "description": "General classification of the worksite (e.g., Onsite vs. Remote).", "format": "int32", "nullable": true } }, "additionalProperties": false } ], "description": "The model for creating Worksites." }, "CrelateEntity": { "required": [ "Count", "EntityName", "IsReadOnly", "Keys", "Values" ], "type": "object", "properties": { "EntityName": { "type": "string" }, "EntityStatus": { "type": "integer", "format": "int32", "nullable": true }, "Id": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "CrelateErrorDetails": { "required": [ "Code", "Message", "Status", "Type" ], "type": "object", "properties": { "Code": { "type": "integer", "description": "The HTTP status code associated with an error.", "format": "int32" }, "HelpLink": { "type": "string", "description": "A help link with more details about an error and how it can be addressed or prevented.", "nullable": true }, "Message": { "type": "string", "description": "A message describing the error that occurred." }, "Status": { "type": "string", "description": "The HTTP status code or reason phrase (e.g., \"Not Found\", \"Unauthorized\")." }, "Type": { "type": "string", "description": "The type of error that occurred." } }, "additionalProperties": false, "description": "Describes a single instance of an error when interacting with the Crelate Unified API." }, "CrelateFileStream": { "required": [ "ContentLength", "ContentType" ], "type": "object", "properties": { "Content": { "type": "string", "description": "Stream of the file.", "format": "binary", "nullable": true }, "ContentLength": { "type": "integer", "description": "Length of content.", "format": "int64" }, "ContentType": { "type": "string", "description": "Content type of the file stream. Most basic file types can be found via MediaTypeNames." }, "FileName": { "type": "string", "description": "Name of the file.", "nullable": true } }, "additionalProperties": false, "description": "Contains a stream of file contents as well as metadata about that file." }, "CrelateResponseMetadata": { "required": [ "CorrelationId", "TimeStamp", "Url", "Verb" ], "type": "object", "properties": { "CorrelationId": { "type": "string", "description": "The correlation ID for the request.", "format": "uuid", "example": "f131dc39-f1ef-43e7-930c-ffcb528eef1f" }, "Links": { "allOf": [ { "$ref": "#/components/schemas/LinkCollection" } ], "description": "The collection of links to other pages relative to this one.", "nullable": true }, "MoreRecords": { "type": "boolean", "description": "Whether there are more records in a paged set after the current page.", "nullable": true, "example": true }, "TimeStamp": { "type": "string", "description": "The current UTC DateTime.", "format": "date-time", "example": "2023-06-23T18:12:07.522503Z" }, "TotalRecords": { "type": "integer", "description": "The total number of records in a paged set.", "format": "int32", "nullable": true, "example": 30 }, "Url": { "type": "string", "description": "The original Url passed in.", "example": "https://app.crelate.com/api3/jobs?offset=10&limit=5" }, "Verb": { "type": "string", "description": "The verb used on the original request.", "example": "GET" } }, "additionalProperties": false, "description": "Metadata returned to provide additional context to a Crelate API response. Provides generalized key-value storage as well as identifying specific, strongly-typed metadata relevant to response data." }, "CustomFieldMultiLookup": { "required": [ "Lookups" ], "type": "object", "properties": { "Lookups": { "type": "array", "items": { "$ref": "#/components/schemas/EntityLookup" } } }, "additionalProperties": false }, "DatesBase": { "type": "object", "properties": { "IsPrimary": { "type": "boolean", "nullable": true }, "Value": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Base class containing properties shared across all operation models for Dates." }, "DisabilityStatusType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "\n\n0 = None\n\n1 = Declined\n\n2 = NotQualified\n\n3 = Qualified", "format": "int32", "x-enumNames": [ "None", "Declined", "NotQualified", "Qualified" ], "x-enumDescriptions": [ "", "", "", "" ] }, "EEO_EthnicityLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EEO_GenderLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EmailAddressesBase": { "type": "object", "properties": { "IsPrimary": { "type": "boolean", "nullable": true }, "Value": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Base class containing properties shared across all operation models for Emails." }, "EmploymentSearchWorkflowStageRules": { "required": [ "CreateActivity", "CreateActivityOptional", "CreateActivityPrompt", "MoveWhenActivityCreated", "MoveWhenSubmittalCreated", "SendEmail" ], "type": "object", "properties": { "CreateActivity": { "type": "boolean", "description": "Whether an activity should be created upon stage change." }, "CreateActivityOptional": { "type": "boolean", "description": "When CreateActivity is true, whether creating an activity on stage change is optional." }, "CreateActivityPrompt": { "type": "boolean", "description": "When CreateActivity is true, whether to prompt for activity notes and details. When false, the activity would be created without any notes or details." }, "CreateActivityType": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "When CreateActivity is true, the type of activity to create.", "nullable": true }, "LinkedSequence": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The sequence (automation) linked to this stage, if any. When set, moving items into this stage may prompt to add them to the linked sequence.", "nullable": true }, "MoveActivityType": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "When MoveWhenActivityCreated is true, the activity type that will trigger the automatic stage change.", "nullable": true }, "MoveWhenActivityCreated": { "type": "boolean", "description": "Whether a Workflow Stage change is automatically triggered by the creation of an activity.\r\n Warning: Candidates that are moved by creating this activity type will not prompt users for a submission. Additionally, users will not be prompted for notes for the above selected activity under \"Create a new activity\"." }, "MoveWhenSubmittalCreated": { "type": "boolean", "description": "Whether a Workflow Stage change is automatically triggered by the creation of a Submittal." }, "SendEmail": { "type": "boolean", "description": "Whether to optionally send an email on stage change. Stage transitions that send email must be made manually from within Crelate as the API does not accept them." }, "SendEmailTemplate": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "When SendEmail is true, an optional email template to begin forming an email from. Depending on the workflow type, the context of the email may differ: for Sales, only Jobs, but for Recruiting, Employment Search, and Business Development, Contacts and Jobs. Stage transitions that send email must be made manually from within Crelate as the API does not accept them.", "nullable": true } }, "additionalProperties": false, "description": "Rules to apply when changing Employment Search Workflow stages. Each stage has separate rules." }, "EmploymentSearchWorkflowStageRulesCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/EmploymentSearchWorkflowStageRules" } ], "description": "Rules to apply when changing Employment Search Workflow stages. Each stage has separate rules.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "EntityFieldInfo": { "required": [ "DisplayName", "IsEncrypted", "Type", "ValidFor", "ValueMaskingMode" ], "type": "object", "properties": { "BoundValues": { "type": "array", "items": { "type": "string" }, "description": "A set of possible values for fields where only a pre-defined set of values are allowed.", "nullable": true }, "Categories": { "type": "array", "items": { "type": "string" }, "description": "For multipass type fields, the primary keys and names of the possible categories.", "nullable": true }, "DisplayName": { "type": "string", "description": "The display name of the field which is preferred for UI presentation." }, "IsEncrypted": { "type": "boolean", "description": "Whether field data is stored in an encrypted format. Encryption and decryption are handled by Crelate." }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/PicklistItemInfo" }, "description": "A set of possible values for system picklist values.", "nullable": true }, "LookupSources": { "type": "array", "items": { "type": "string" }, "description": "A set of possible endpoint prefixes for fields with a type of lookupAny where the possible entity types valid as a value are bound. These values can be used directly as the base of a route to the Crelate API.", "nullable": true }, "Statuses": { "type": "array", "items": { "$ref": "#/components/schemas/RecordStatusInfo" }, "description": "For recordStatus type fields, the possible record status values for the entity type.", "nullable": true }, "Type": { "type": "string", "description": "The data type of a field. Possible values are: \n * `addresses`: List of Addresses.\n * `boolean`: Boolean value (true/false).\n * `byte`: 8-bit integer value.\n * `date`: UTC date value.\n * `datetime`: UTC date and time value.\n * `decimal`: decimal numeric value.\n * `education`: List of education history entries.\n * `emails`: List of email addresses.\n * `float`: floating point numeric value.\n * `guid`: GUID value.\n * `instantMessaging`: List of instant messaging handles.\n * `int16`: 16-bit integer value.\n * `int32`: 32-bit integer value.\n * `int64`: 64-bit integer value.\n * `links`: List of external web links.\n * `multipass`: List of related entities.\n * `object`: Dynamic type value.\n * `phoneNumbers`: List of phone numbers.\n * `picklist`: A value from a fixed set of values.\n * `recordStatus`: An integer value representing a record status.\n * `string`: A string of text. UTF-16 characters like emoji and some Unicode are not supported.\n * `workHistory`: A list of work history (timeline) entries." }, "ValidFor": { "type": "array", "items": { "type": "string" }, "description": "The set of operation categories a field is valid for. Possible values are: \n * `create`\n * `read`\n * `update`\n * `sort`" }, "ValueMaskingMode": { "allOf": [ { "$ref": "#/components/schemas/MaskingMode" } ], "description": "Describes a masking mode for obscuring some or all of sensitive data.\n\n0 = ShowAll\n\n1 = ShowLastFour\n\n2 = ShowNone", "x-enumNames": [ "ShowAll", "ShowLastFour", "ShowNone" ], "x-enumDescriptions": [ "", "", "" ] }, "Values": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "A set of possible values for fields with a type that constrains values to a fixed set.", "nullable": true } }, "additionalProperties": false, "description": "Information about a Crelate entity field and how it can be used." }, "EntityInfo": { "required": [ "Fields" ], "type": "object", "properties": { "CustomFields": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/EntityFieldInfo" }, "description": "Custom fields configured for an entity. Keyed by logical custom field name.", "nullable": true }, "Fields": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/EntityFieldInfo" }, "description": "Available fields for an entity. Keyed by field name." } }, "additionalProperties": false, "description": "Information about a Crelate entity, such as field metadata." }, "EntityInfoCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/EntityInfo" } ], "description": "Information about a Crelate entity, such as field metadata.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "EntityLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "A \"Lookup\" to another crelate entity" }, "EntityStatusesLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EntityTypes": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 109, 110, 111, 112, 113, 114, 115, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 134, 137, 138, 139, 140, 141, 142, 143, 144, 145, 150, 160, 161, 162, 163, 165, 166, 167, 170, 200, 220, 221, 300, 301, 302, 303, 304, 305, 306, 307, 308, 309, 310, 311, 312, 313, 317, 318, 320, 321, 322, 350, 375, 376, 377, 400, 401, 405, 406, 407, 500, 501, 502, 510, 511, 512, 513, 514, 515, 516, 517, 550, 551, 552, 553, 554, 555, 556, 557, 558, 559, 650, 651, 700, 701, 750, 751, 801, 802, 803, 804, 805, 806, 807, 808, 809, 810, 811, 812, 814, 815, 816, 817, 818, 819, 820, 821, 822, 823, 824, 827, 828, 829, 830, 831, 832, 833, 834, 840, 841, 850, 851, 860, 900, 950, 951, 952, 1000, 1001, 1002, 1003, 1004, 1005, 1006, 1008, 1100, 1101, 1200, 1201, 1300, 2000, 2001, 3000, 5000, 5001, 5002, 10000, 10001, 11000, 12000, 12001 ], "type": "integer", "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "format": "int32", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "ErrorCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "ExpenseTypeType": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "\n\n0 = Unknown\n\n1 = Amount\n\n2 = Quantity", "format": "int32", "x-enumNames": [ "Unknown", "Amount", "Quantity" ], "x-enumDescriptions": [ "", "", "" ] }, "ExternalAuthDomainsLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Form": { "required": [ "Id", "Name", "Sections" ], "type": "object", "properties": { "Id": { "type": "string", "description": "The primary key of the form definition/template.", "format": "uuid" }, "Name": { "type": "string", "description": "The name of the form definition/template." }, "Sections": { "type": "array", "items": { "$ref": "#/components/schemas/FormSection" }, "description": "The logical sections of the form. Each section contains one or more form fields. Sections are returned in the order they should be presented." } }, "additionalProperties": false, "description": "Represents a form definition/template. Contains one or more sections." }, "FormCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/Form" } ], "description": "Represents a form definition/template. Contains one or more sections.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "FormField": { "required": [ "FieldTypeName", "FormFieldTypeId", "HasRating", "HelpText", "Id", "IsRequired", "Name" ], "type": "object", "properties": { "FieldTypeName": { "type": "string", "description": "An optional string used to set a CSS class name for each type of field on the client." }, "FormFieldTypeId": { "type": "string", "description": "The type of the form field. This is not a primary key.", "format": "uuid" }, "HasRating": { "type": "integer", "description": "Whether a form field supports a five-star rating in addition to the response to a form field.", "format": "int32" }, "HelpText": { "type": "string", "description": "Optional help text to assist users in responding to a form field." }, "Id": { "type": "string", "description": "The primary key of the form field.", "format": "uuid" }, "IsRequired": { "type": "boolean", "description": "Whether a form field is required for submitting." }, "Name": { "type": "string", "description": "The display name for a form field. Typically rendered as a label next to the input control." }, "PickListItems": { "type": "array", "items": { "$ref": "#/components/schemas/FormPickListItem" }, "description": "For picklist (dropdown/combo/select menu) type form fields, contains the possible options.", "nullable": true } }, "additionalProperties": false, "description": "A form field with information for rendering an input control in a graphical user interface." }, "FormPickListItem": { "required": [ "Id", "Title" ], "type": "object", "properties": { "Id": { "type": "string", "description": "The primary key of the picklist option.", "format": "uuid" }, "Title": { "type": "string", "description": "The display title of the picklist option." } }, "additionalProperties": false, "description": "A picklist option for a form field." }, "FormRequestTemplates": { "required": [ "ActivityForms", "ArtifactTypes" ], "type": "object", "properties": { "ActivityForms": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "Available activity forms for sending a Form type form request." }, "ArtifactTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "Available artifact types for sending a Document type form request." } }, "additionalProperties": false, "description": "Aggregates available options for selecting a template to send a form request." }, "FormRequestTemplatesCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/FormRequestTemplates" } ], "description": "Aggregates available options for selecting a template to send a form request.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "FormResponse": { "required": [ "FormFieldTypeId", "Id" ], "type": "object", "properties": { "FormFieldId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Id of the form response.", "nullable": true }, "FormFieldTypeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Type of question." }, "FormId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Id of the form that this response is for.", "nullable": true }, "Id": { "type": "string", "description": "Id of the form response..", "format": "uuid" }, "Rating": { "type": "integer", "description": "Optional rating value to the question.", "format": "int32", "nullable": true }, "Value": { "type": "string", "description": "Stores the response to the question.", "nullable": true }, "Values": { "type": "array", "items": { "$ref": "#/components/schemas/LookupAny" }, "description": "Stores responses to questions.", "nullable": true } }, "additionalProperties": false, "description": "Represents a custom form that has been filled out. Does not indicate if the form is completed." }, "FormResponseListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/FormResponse" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "FormSection": { "required": [ "Fields", "Name" ], "type": "object", "properties": { "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/FormField" }, "description": "The fields within a section." }, "Name": { "type": "string", "description": "The name, or title, of the form section." } }, "additionalProperties": false, "description": "A logical grouping of form fields." }, "GeoLocation": { "required": [ "Lat", "Lon" ], "type": "object", "properties": { "Lat": { "type": "number", "description": "The latitude of a location in decimal degrees.", "format": "double" }, "Lon": { "type": "number", "description": "The longitude of a location in decimal degrees.", "format": "double" } }, "additionalProperties": false, "description": "Describes a geographic location by decimal degree latitude and longitude values. Domain model representation of the Location Metabase attribute type." }, "GeofencingOptions": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "Available options for defining various levels of geofencing enforcement for time keeping.\n\n0 = None (Geofencing is disabled.)\n\n1 = Log (Geofencing is Enabled. Time Recorder location will be captured when submitting time.)\n\n2 = Warning (Geofencing is Enabled. Time Recorders will be warned when entering time manually or outside the geofence. Time entered manually or outside the geofence will be flagged on approvals.)\n\n3 = Restrict (Geofencing is Enabled. Time Recorders must be within the geofence bounds to submit time.)", "format": "int32", "x-enumNames": [ "None", "Log", "Warning", "Restrict" ], "x-enumDescriptions": [ "Geofencing is disabled.", "Geofencing is Enabled. Time Recorder location will be captured when submitting time.", "Geofencing is Enabled. Time Recorders will be warned when entering time manually or outside the geofence. Time entered manually or outside the geofence will be flagged on approvals.", "Geofencing is Enabled. Time Recorders must be within the geofence bounds to submit time." ] }, "GetFormResult": { "required": [ "Color", "DocumentType", "Error", "FormRequestMessageHtml", "RequestedBy", "RequestedDate", "RequestType", "Status" ], "type": "object", "properties": { "Color": { "type": "string", "description": "The color of the form in standard hex format: `#RRGGBB`." }, "CompletedDate": { "type": "string", "description": "If IsCompleted is true, the date the form responses were submitted.", "format": "date-time", "nullable": true }, "DocumentType": { "type": "string", "description": "The type of document requested for Document type form requests. This value is empty for form requests sent with a Form template." }, "Error": { "type": "string", "deprecated": true }, "FormDef": { "allOf": [ { "$ref": "#/components/schemas/Form" } ], "description": "The form definition; that is, the logical grouping of form sections and form fields that make up each section.", "nullable": true }, "FormRequestMessageHtml": { "type": "string", "description": "The message sent to the target contact via email." }, "IsCompleted": { "type": "boolean", "description": "Whether the form request is completed.", "nullable": true }, "RequestedBy": { "type": "string", "description": "The name of the Crelate user who initiated the form request." }, "RequestedDate": { "type": "string", "description": "The date (in UTC the form request was sent.", "format": "date-time" }, "RequestType": { "type": "string", "description": "The type of form request. Can be either \"Document\" or \"Form\" based on the selected template when the form request was sent." }, "Status": { "type": "string", "description": "The status of the form request, such as \"Requested\", \"Completed\", or \"Revoked\"." } }, "additionalProperties": false, "description": "Describes the status and context of a form request." }, "GetFormResultCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/GetFormResult" } ], "description": "Describes the status and context of a form request.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "GlobalSearchResult": { "required": [ "EntityName", "Id" ], "type": "object", "properties": { "EntityName": { "minLength": 1, "type": "string", "description": "User friendly display name of the entity that this lookup points to." }, "EntityStatus": { "type": "integer", "description": "The record status value of the entity. Use the associated entity metadata endpoint to get more info. May be null if the entity does not use record statuses.", "format": "int32", "nullable": true }, "Id": { "type": "string", "description": "The primary key of the related entity referenced.", "format": "uuid" }, "Title": { "type": "string", "description": "The title of the related entity referenced. This is not required for create and update operations, and may not be returned for all retrieve operations. It is display text and may not reflect a later rename of the related entity, so group or join records on Id.", "nullable": true } }, "additionalProperties": false, "description": "A result from a global search operation." }, "GlobalSearchResultListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalSearchResult" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "GuidCrelateResponse": { "required": [ "Data", "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "string", "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "format": "uuid" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "GuidIEnumerableCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "ImportsLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InstantAddressesBase": { "type": "object", "properties": { "IsPrimary": { "type": "boolean", "nullable": true }, "Value": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Base class containing properties shared across all operation models for Instant Addresses." }, "Int32CrelateResponse": { "required": [ "Data", "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "integer", "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "format": "int32" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "InvoicePaymentOptions": { "required": [ "Amount", "InvoiceId" ], "type": "object", "properties": { "Amount": { "type": "number", "description": "Amount applied to the specified invoice", "format": "double" }, "ExternalPaymentId": { "type": "string", "description": "Provide the External Payment Id if the payment came from an external accounting system", "nullable": true }, "InvoiceId": { "type": "string", "description": "Invoice that this payment is applied to", "format": "uuid" }, "Note": { "type": "string", "description": "Free text note that a user can add about a payment", "nullable": true } }, "additionalProperties": false, "description": "Options for invoice payment to recognize payment." }, "InvoiceTermsOption": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ], "type": "integer", "description": "\n\n0 = Unknown\n\n1 = UponReceipt\n\n2 = Net15\n\n3 = Net30\n\n4 = Net60\n\n5 = Net90\n\n6 = Net45\n\n7 = Net10", "format": "int32", "x-enumNames": [ "Unknown", "UponReceipt", "Net15", "Net30", "Net60", "Net90", "Net45", "Net10" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "" ] }, "JobClassificationCategoryLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "JobClassificationLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "JobTypesMultiLookup": { "required": [ "Lookups" ], "type": "object", "properties": { "Lookups": { "type": "array", "items": { "$ref": "#/components/schemas/EntityLookup" } } }, "additionalProperties": false }, "JobWorkflowHistoryDetail": { "required": [ "Stage" ], "type": "object", "properties": { "Action": { "type": "string", "description": "The type of action that occurred. Can be `Opened` or `ChangedStage`.", "nullable": true }, "Date": { "type": "string", "description": "The date and time a stage change occurred.", "format": "date-time", "nullable": true }, "Job": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The job for which a stage change occurred. A value may not be available for some history entries.", "nullable": true }, "LossReason": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "For a stage change resulting in a loss, the loss reason.", "nullable": true }, "LossReasonNotes": { "type": "string", "description": "For a stage change resulting in a loss, any loss reason notes.", "nullable": true }, "Stage": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The stage a job changed to." }, "User": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who triggered the stage change.", "nullable": true } }, "additionalProperties": false, "description": "Represents a jobs's stage in a sales workflow at a point in time." }, "JobWorkflowHistoryDetailPagedListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/JobWorkflowHistoryDetail" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "JobsBase": { "type": "object", "properties": { "ActualValue": { "type": "number", "description": "This records the actual value of the Job after it is closed (either won or lost)", "format": "double", "nullable": true }, "Approvals": { "type": "integer", "description": "The approvals option for Temp Hire Job.", "format": "int32", "nullable": true }, "ApprovalsDueOn": { "type": "integer", "description": "The enumerated option for what day time approval is due relative to the Time Submission Period end for the Job.", "format": "int32", "nullable": true }, "ApprovalsDueOnTime": { "type": "string", "description": "The time of day when approval of time is due relative to the Time Submission Period end for the Job.", "format": "date-time", "nullable": true }, "BillRate": { "type": "number", "description": "The actual or expected bill rate for this Job", "format": "double", "nullable": true }, "Bonus": { "type": "number", "description": "The actual or expected yearly bonus of the position", "format": "double", "nullable": true }, "BurdenRate": { "type": "number", "description": "A monetary amount used to calculate the total cost of hiring and maintaining an employee beyond their direct compensation in wages", "format": "double", "nullable": true }, "BurdenRatePercentage": { "type": "number", "description": "The percentage used to calculate the total cost of hiring and maintaining an employee beyond their direct compensation in wages", "format": "double", "nullable": true }, "Cadence": { "type": "integer", "description": "The time submission cadence of the Job.", "format": "int32", "nullable": true }, "Commission": { "type": "number", "description": "The commision charged for this Job", "format": "double", "nullable": true }, "Compensation": { "type": "number", "description": "Compensation or Job salary (Dollar amount)", "format": "double", "nullable": true }, "CompensationDetails": { "type": "string", "description": "Additional compensation (benefits, bonuses, etc.)", "nullable": true }, "CustomField1": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField10": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField11": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField12": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField13": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField14": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField15": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField16": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField17": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField18": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField19": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField2": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField20": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField21": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField22": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField23": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField24": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField25": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField26": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField27": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField28": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField29": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField3": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField30": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField4": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField41": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField42": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField43": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField44": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField45": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField46": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField47": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField48": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField49": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField5": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField50": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField51": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField52": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField53": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField54": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField55": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField56": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField57": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField58": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField59": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField6": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField60": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField61": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField62": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField63": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField64": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField65": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField66": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField67": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField68": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField69": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField7": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField70": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField8": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField9": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomFields": { "type": "object", "additionalProperties": { }, "description": "A property bag for custom fields, keyed by logical name.", "nullable": true }, "Description": { "type": "string", "description": "A full description of the Job (This can include formatted text)", "nullable": true }, "Discount": { "type": "number", "description": "Discount applied to the fee for this Job", "format": "double", "nullable": true }, "Duration": { "type": "integer", "description": "Estimated duration for the assignments to this job", "format": "int32", "nullable": true }, "EstimatedCloseDate": { "type": "string", "description": "The date that the Job is estimated to close by", "format": "date-time", "nullable": true }, "EstimatedEndDate": { "type": "string", "description": "Indicates when the Job is estimated to end if the Job is not permanent", "format": "date-time", "nullable": true }, "ExternalPrimaryKey": { "type": "string", "description": "The external primary key of a record. Not guaranteed to be globally unique.", "nullable": true }, "Fee": { "type": "number", "description": "The fee charged for this Job", "format": "double", "nullable": true }, "FeePercent": { "type": "number", "description": "The fee charged for this Job (as a percentage of salary)", "format": "double", "nullable": true }, "HourlyRate": { "type": "number", "description": "The actual or expected hourly rate of this position", "format": "double", "nullable": true }, "IsOnHold": { "type": "boolean", "description": "Whether the Job has been put on hold", "nullable": true }, "JobSchedule": { "type": "string", "description": "A description of the work schedule for the Job.", "nullable": true }, "Margin": { "type": "number", "description": "The actual or expected margin for this Job", "format": "double", "nullable": true }, "Name": { "type": "string", "description": "Job Name", "nullable": true }, "NumberOfOpenings": { "type": "integer", "description": "Number of openings available for this position", "format": "int32", "nullable": true }, "NumberOfPlacements": { "type": "integer", "description": "The number of assignments made on this Job.", "format": "int32", "nullable": true }, "OTBillRate": { "type": "number", "description": "Overtime bill rate", "format": "double", "nullable": true }, "OTBillRateMultiplier": { "type": "number", "description": "Overtime bill rate multiplier. Can be used to calculate overtime bill rate", "format": "double", "nullable": true }, "OTPayRate": { "type": "number", "description": "Overtime pay rate, may be calculated based on overtime rate multiplier or a flat rate", "format": "double", "nullable": true }, "OTPayRateMultiplier": { "type": "number", "description": "Used to calculate overtime pay", "format": "double", "nullable": true }, "PayRate": { "type": "number", "description": "Pay rate for this Job can be hourly or salary depending on the PayRateType.", "format": "double", "nullable": true }, "PayRateType": { "type": "integer", "description": "Determines if PayRate is hourly or salary.", "format": "int32", "nullable": true }, "PlacementStatus": { "type": "integer", "description": "The overall placement status of the placements/assignments on this Job. Describes the relationship between Number of Assignments and No. of Openings.", "format": "int32", "nullable": true }, "PotentialValue": { "type": "number", "description": "The total potential value of the Job. This is the amount you expect to gain if this Job is \"won\".", "format": "double", "nullable": true }, "Probability": { "type": "number", "description": "The estimated probability that the Job will result in a \"win\" (percentage, 0 to 100)", "format": "float", "nullable": true }, "Salary": { "type": "number", "description": "The actual or expected salary of the position", "format": "double", "nullable": true }, "Shift": { "type": "integer", "description": "General description of the work schedule", "format": "int32", "nullable": true }, "StartDate": { "type": "string", "description": "Work or employment start date", "format": "date-time", "nullable": true }, "TimeCardDueOnTime": { "type": "string", "description": "The time of day when timecards are due for the Job.", "format": "date-time", "nullable": true }, "TimeCardsDueOn": { "type": "integer", "description": "The enumerated option for what day timecards are due relative to the Time Submission Period end for the Job.", "format": "int32", "nullable": true }, "TotalHours": { "type": "number", "description": "The expected total number of hours for this position", "format": "float", "nullable": true } }, "additionalProperties": false, "description": "Base class containing properties shared across all operation models for Jobs." }, "JobsLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LedgerAccountTypeOption": { "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "description": "\n\n0 = Asset\n\n1 = Liability\n\n2 = Equity\n\n3 = Revenue\n\n4 = Expense\n\n5 = CostofGoodsSold\n\n6 = ContraAccount", "format": "int32", "x-enumNames": [ "Asset", "Liability", "Equity", "Revenue", "Expense", "CostofGoodsSold", "ContraAccount" ], "x-enumDescriptions": [ "", "", "", "", "", "", "" ] }, "LedgerEventOption": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "description": "\n\n0 = Unknown\n\n1 = InvoiceSent\n\n2 = MemoCreated\n\n3 = InvoiceVoided\n\n4 = PaymentRecognized", "format": "int32", "x-enumNames": [ "Unknown", "InvoiceSent", "MemoCreated", "InvoiceVoided", "PaymentRecognized" ], "x-enumDescriptions": [ "", "", "", "", "" ] }, "Link": { "type": "object", "properties": { "Href": { "type": "string", "description": "The link.", "format": "uri", "nullable": true } }, "additionalProperties": false, "description": "Currently just a wrapper for a Url." }, "LinkCollection": { "required": [ "First", "Last", "Next", "Prev", "Self" ], "type": "object", "properties": { "First": { "allOf": [ { "$ref": "#/components/schemas/Link" } ], "description": "The href to the first result page." }, "Last": { "allOf": [ { "$ref": "#/components/schemas/Link" } ], "description": "Currently just a wrapper for a Url." }, "Next": { "allOf": [ { "$ref": "#/components/schemas/Link" } ], "description": "The href to the next result page, if any." }, "Prev": { "allOf": [ { "$ref": "#/components/schemas/Link" } ], "description": "The href to the previous result page, if any." }, "Self": { "allOf": [ { "$ref": "#/components/schemas/Link" } ], "description": "The href to the current result page that's being returned." } }, "additionalProperties": false, "description": "A collection of links." }, "Lookup": { "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "string", "description": "The primary key of the related entity referenced.", "format": "uuid" }, "Title": { "type": "string", "description": "The title of the related entity referenced. This is not required for create and update operations, and may not be returned for all retrieve operations. It is display text and may not reflect a later rename of the related entity, so group or join records on Id.", "nullable": true } }, "additionalProperties": false, "description": "A lookup to a related entity of a single entity type." }, "LookupAny": { "required": [ "EntityName", "Id" ], "type": "object", "properties": { "EntityName": { "minLength": 1, "type": "string", "description": "User friendly display name of the entity that this lookup points to." }, "Id": { "type": "string", "description": "The primary key of the related entity referenced.", "format": "uuid" }, "Title": { "type": "string", "description": "The title of the related entity referenced. This is not required for create and update operations, and may not be returned for all retrieve operations. It is display text and may not reflect a later rename of the related entity, so group or join records on Id.", "nullable": true } }, "additionalProperties": false, "description": "A lookup to a related entity of a single entity type within a set of allowed entity types." }, "MaskingMode": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "Describes a masking mode for obscuring some or all of sensitive data.\n\n0 = ShowAll\n\n1 = ShowLastFour\n\n2 = ShowNone", "format": "int32", "x-enumNames": [ "ShowAll", "ShowLastFour", "ShowNone" ], "x-enumDescriptions": [ "", "", "" ] }, "MetabaseAttributeTypeCategoryTypesLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MetabaseAttributesLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MultiCreateOperationResponse": { "required": [ "PrimaryRecordId", "SecondaryRecordIds" ], "type": "object", "properties": { "PrimaryRecordId": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "The primary record created." }, "SecondaryRecordIds": { "type": "array", "items": { "$ref": "#/components/schemas/LookupAny" }, "description": "Any secondary records created that are related to the primary record." } }, "additionalProperties": false, "description": "Lookups to multiple records created in one operation, with a primary record and a collection of secondary records." }, "MultiCreateOperationResponseCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/MultiCreateOperationResponse" } ], "description": "Lookups to multiple records created in one operation, with a primary record and a collection of secondary records.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "MultiPass": { "required": [ "Values" ], "type": "object", "properties": { "Values": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateEntity" } } }, "additionalProperties": false, "description": "An array of CrelateEntities uses to define a N:N relationship" }, "NoteRequirementOptions": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "\n\n0 = None\n\n1 = Optional (Optional)\n\n2 = Required (Required)", "format": "int32", "x-enumNames": [ "None", "Optional", "Required" ], "x-enumDescriptions": [ "", "Optional", "Required" ] }, "OpportunityRecruitingType": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "keep in sync with crelate.web.core.core\\wwwroot\\app\\modules\\settings\\opportunity_settings\\opportunity.d.ts\n\n0 = Custom\n\n1 = DirectHire\n\n2 = Temp", "format": "int32", "x-enumNames": [ "Custom", "DirectHire", "Temp" ], "x-enumDescriptions": [ "", "", "" ] }, "OpportunityTypeValueModes": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "description": "\n\n0 = Basic\n\n1 = SumChildJobs\n\n2 = FeeBased\n\n3 = Hourly\n\n4 = Custom", "format": "int32", "x-enumNames": [ "Basic", "SumChildJobs", "FeeBased", "Hourly", "Custom" ], "x-enumDescriptions": [ "", "", "", "", "" ] }, "OrganizationsLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Owner": { "required": [ "Id", "IsPrimary" ], "type": "object", "properties": { "Id": { "type": "string", "description": "The primary key of the related entity referenced.", "format": "uuid" }, "IsPrimary": { "type": "boolean", "description": "Whether an owning user is the primary owner." }, "Title": { "type": "string", "description": "The title of the related entity referenced. This is not required for create and update operations, and may not be returned for all retrieve operations. It is display text and may not reflect a later rename of the related entity, so group or join records on Id.", "nullable": true } }, "additionalProperties": false, "description": "A lookup to an owner of a record." }, "Owners": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" }, "description": "Zero or more owners of a record. One owner may be the primary owner." }, "PaySchedulesLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentMethodOption": { "enum": [ 0, 1, 2, 3, 4, 50, 51 ], "type": "integer", "description": "\n\n0 = Unknown\n\n1 = ACH\n\n2 = Cash\n\n3 = Check\n\n4 = CreditCard\n\n50 = ZeroAmount\n\n51 = Other", "format": "int32", "x-enumNames": [ "Unknown", "ACH", "Cash", "Check", "CreditCard", "ZeroAmount", "Other" ], "x-enumDescriptions": [ "", "", "", "", "", "", "" ] }, "PaymentTypeOption": { "enum": [ 0, 1 ], "type": "integer", "description": "\n\n0 = Normal\n\n1 = ZeroAmount", "format": "int32", "x-enumNames": [ "Normal", "ZeroAmount" ], "x-enumDescriptions": [ "", "" ] }, "PhoneNumbersBase": { "type": "object", "properties": { "Extension": { "type": "string", "description": "The optional extension of the Phone Number.", "nullable": true }, "IsPrimary": { "type": "boolean", "description": "Whether the Phone Number is the primary number of a record.", "nullable": true }, "Value": { "type": "string", "description": "The phone number value. North American phone numbers may omit the +1 country code, but all international phone numbers must specify a + numbered calling code. All inbound values are re-formatted and stored in E.164 format.", "nullable": true } }, "additionalProperties": false, "description": "Base class containing properties shared across all operation models for Phone Numbers." }, "PicklistItemInfo": { "required": [ "Name", "Value" ], "type": "object", "properties": { "Name": { "type": "string", "description": "The display name of a picklist item." }, "Value": { "type": "integer", "description": "The underlying value of a picklist item.", "format": "int32" } }, "additionalProperties": false, "description": "Encapsulates basic information about a picklist item." }, "PreferredContactMethodTypesLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RateLimitErrorResponse": { "type": "object", "properties": { "error": { "type": "string", "description": "Details about the error encountered." }, "message": { "type": "string", "description": "A human-readable summary of why the request was rejected." }, "status": { "type": "integer", "description": "The HTTP status code of the response (429).", "format": "int32" }, "retry_after_seconds": { "type": "string", "description": "The number of seconds to wait before retrying the request." } }, "description": "Returned when the rate limit has been exceeded. Produced at the network edge, so the standard `Data`/`Metadata`/`Errors` envelope does not apply.", "example": { "error": "Sample error message", "message": "Too many requests.", "status": 429, "retry_after_seconds": "60" } }, "RecognizePaymentOptions": { "required": [ "InvoicePaymentOptions", "PaymentMethodOption", "ReceivedOn" ], "type": "object", "properties": { "ExternalId": { "type": "string", "description": "Value used to identify the payment like check id", "nullable": true }, "InvoicePaymentOptions": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicePaymentOptions" }, "description": "List of all the invoice payment options. Need at least one for the payment" }, "PaymentMethodOption": { "allOf": [ { "$ref": "#/components/schemas/PaymentMethodOption" } ], "description": "Payment method used\n\n0 = Unknown\n\n1 = ACH\n\n2 = Cash\n\n3 = Check\n\n4 = CreditCard\n\n50 = ZeroAmount\n\n51 = Other", "x-enumNames": [ "Unknown", "ACH", "Cash", "Check", "CreditCard", "ZeroAmount", "Other" ], "x-enumDescriptions": [ "", "", "", "", "", "", "" ] }, "ReceivedOn": { "type": "string", "description": "Time that the payment was recognized. It must be after the invoice was sent Earliest possible date would be the earliest send date of the all invoices in the payment", "format": "date-time" } }, "additionalProperties": false, "description": "Options for recognize payment record." }, "RecordStatusInfo": { "required": [ "AllowContactOption", "IsSystemReservedStatus", "Name", "Value", "VisibilityOption" ], "type": "object", "properties": { "AllowContactOption": { "allOf": [ { "$ref": "#/components/schemas/AllowContactOptionTypes" } ], "description": "Describes how a record status enforces contact options for associated records.\n\n0 = Unknown\n\n1 = No\n\n2 = Yes\n\n3 = Limited", "x-enumNames": [ "Unknown", "No", "Yes", "Limited" ], "x-enumDescriptions": [ "", "", "", "" ] }, "IsSystemReservedStatus": { "type": "boolean", "description": "Whether a record status is a reserved system-managed status. Reserved system-managed statuses cannot be modified and records with this status value are ineligible for status change except by Crelate internal systems." }, "Name": { "type": "string", "description": "The display name of a record status." }, "Value": { "type": "integer", "description": "The underlying value of a record status.", "format": "int32" }, "VisibilityOption": { "allOf": [ { "$ref": "#/components/schemas/VisibilityOptionTypes" } ], "description": "Describes whether a record status should hide records. Custom views may surface records with statuses that indicate they should be hidden.\n\n0 = Unknown\n\n1 = Hide\n\n2 = Show\n\n3 = SystemOnly", "x-enumNames": [ "Unknown", "Hide", "Show", "SystemOnly" ], "x-enumDescriptions": [ "", "", "", "" ] } }, "additionalProperties": false, "description": "Encapsulates basic information about a record status." }, "RecruitingWorkflowStageRules": { "required": [ "CreateActivity", "CreateActivityOptional", "CreateActivityPrompt", "CreateChecklist", "CreateSubmittal", "MoveWhenActivityCreated", "MoveWhenSubmittalCreated", "SendEmail", "SendEmailIncludeResume" ], "type": "object", "properties": { "ChecklistTemplate": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "When CreateChecklist is true, the checklist template to create a checklist from.", "nullable": true }, "CreateActivity": { "type": "boolean", "description": "Whether an activity should be created upon stage change." }, "CreateActivityOptional": { "type": "boolean", "description": "When CreateActivity is true, whether creating an activity on stage change is optional." }, "CreateActivityPrompt": { "type": "boolean", "description": "When CreateActivity is true, whether to prompt for activity notes and details. When false, the activity would be created without any notes or details." }, "CreateActivityType": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "When CreateActivity is true, the type of activity to create.", "nullable": true }, "CreateChecklist": { "type": "boolean", "description": "Whether to create a checklist. Stage transitions that create checklists must be made manually from within Crelate as the API does not accept them." }, "CreateSubmittal": { "type": "boolean", "description": "Whether to ask to optionally submit candidates. Stage transitions that create submittals must be made manually from within Crelate as the API does not accept them." }, "LinkedSequence": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The sequence (automation) linked to this stage, if any. When set, moving items into this stage may prompt to add them to the linked sequence.", "nullable": true }, "MoveActivityType": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "When MoveWhenActivityCreated is true, the activity type that will trigger the automatic stage change.", "nullable": true }, "MoveWhenActivityCreated": { "type": "boolean", "description": "Whether a Workflow Stage change is automatically triggered by the creation of an activity.\r\n Warning: Candidates that are moved by creating this activity type will not prompt users for a submission. Additionally, users will not be prompted for notes for the above selected activity under \"Create a new activity\"." }, "MoveWhenSubmittalCreated": { "type": "boolean", "description": "Whether a Workflow Stage change is automatically triggered by the creation of a Submittal." }, "SendEmail": { "type": "boolean", "description": "Whether to optionally send an email on stage change. Stage transitions that send email must be made manually from within Crelate as the API does not accept them." }, "SendEmailIncludeResume": { "type": "boolean", "description": "When SendEmail is true, whether to attach a candidate's resume with the email." }, "SendEmailTemplate": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "When SendEmail is true, an optional email template to begin forming an email from. Depending on the workflow type, the context of the email may differ: for Sales, only Jobs, but for Recruiting, Employment Search, and Business Development, Contacts and Jobs. Stage transitions that send email must be made manually from within Crelate as the API does not accept them.", "nullable": true } }, "additionalProperties": false, "description": "Rules to apply when changing Recruiting Workflow stages. Each stage has separate rules." }, "RecruitingWorkflowStageRulesCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RecruitingWorkflowStageRules" } ], "description": "Rules to apply when changing Recruiting Workflow stages. Each stage has separate rules.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RejectApplicantWorkflowAction": { "required": [ "ApplicationId", "IgnorePossibleMatches" ], "type": "object", "properties": { "ApplicationId": { "type": "string", "description": "The primary key of the application.", "format": "uuid" }, "IgnorePossibleMatches": { "type": "boolean", "description": "If true, any matching contact found is ignored and a new, duplicate contact is created. If false (this is default), duplicate detection rules apply and MatchedContactId is required if a match is found." }, "MatchedContactId": { "type": "string", "description": "The primary key of an existing contact that an application corresponds to. Providing this value will merge the applicant's information with the linked contact.", "format": "uuid", "nullable": true }, "PassReasonId": { "type": "string", "description": "The primary key of the pass reason to associate with the rejection. This is required when EEOC is enabled.", "format": "uuid", "nullable": true }, "PassReasonNote": { "type": "string", "description": "A note to accommodate the pass reason.", "nullable": true } }, "additionalProperties": false }, "RelatedContactsBase": { "type": "object", "properties": { "IsPrimary": { "type": "boolean", "nullable": true } }, "additionalProperties": false, "description": "Base class containing properties shared across all operation models for Related Contacts." }, "RelationshipDefinitions": { "required": [ "Groups", "Types" ], "type": "object", "properties": { "Groups": { "type": "array", "items": { "$ref": "#/components/schemas/RelationshipGroupInfo" }, "description": "The available relationship groups." }, "Types": { "type": "array", "items": { "$ref": "#/components/schemas/RelationshipTypeInfo" }, "description": "The available relationship types." } }, "additionalProperties": false, "description": "The relationship groups and types configured for an org, so callers can discover the group and type codes available for use when retrieving or filtering relationships." }, "RelationshipDefinitionsCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RelationshipDefinitions" } ], "description": "The relationship groups and types configured for an org, so callers can discover the group and type codes available for use when retrieving or filtering relationships.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RelationshipGroupInfo": { "required": [ "AvailableOn", "Code", "EnableSplits" ], "type": "object", "properties": { "AvailableOn": { "type": "array", "items": { "type": "string" }, "description": "The friendly names of the record types this group is available on.", "example": [ "Contacts", "Jobs" ] }, "Code": { "type": "integer", "description": "The numeric code identifying this relationship group. Supply this as the group code when retrieving or filtering relationships.", "format": "int32", "example": 5 }, "EnableSplits": { "type": "boolean", "description": "Whether relationships in this group support split percentages/amounts.", "example": true }, "Name": { "type": "string", "description": "The friendly name of the relationship group.", "nullable": true, "example": "Referrals" } }, "additionalProperties": false, "description": "Externally-appropriate, simplified representation of a relationship group that callers can reference by code." }, "RelationshipInfo": { "required": [ "Id" ], "type": "object", "properties": { "CreatedOn": { "type": "string", "description": "The date the relationship was created.", "format": "date-time", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "Id": { "type": "string", "description": "The unique identifier of the relationship record.", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "ModifiedOn": { "type": "string", "description": "The date the relationship was last modified.", "format": "date-time", "nullable": true, "example": "2024-02-20T14:45:00Z" }, "Parent": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "The record this relationship belongs to (the \"from\" side).", "nullable": true }, "RelationshipGroupCode": { "type": "integer", "description": "The numeric code of the relationship group.", "format": "int32", "nullable": true, "example": 5 }, "RelationshipGroupName": { "type": "string", "description": "The friendly name of the relationship group, resolved from RelationshipGroupCode.", "nullable": true, "example": "Referrals" }, "RelationshipTypeCode": { "type": "integer", "description": "The numeric code of the relationship type.", "format": "int32", "nullable": true, "example": 10 }, "RelationshipTypeName": { "type": "string", "description": "The friendly name of the relationship type, resolved from RelationshipTypeCode.", "nullable": true, "example": "Referred By" }, "SplitAmount": { "type": "number", "description": "The split amount for this relationship, when the group has splits enabled.", "format": "double", "nullable": true, "example": 5000 }, "SplitPercentage": { "type": "number", "description": "The split percentage (0-1) for this relationship, when the group has splits enabled.", "format": "double", "nullable": true, "example": 0.5 }, "Target": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "The record this relationship references (the \"to\" side).", "nullable": true } }, "additionalProperties": false, "description": "Externally-appropriate, simplified representation of a single relationship between two records." }, "RelationshipInfoCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RelationshipInfo" } ], "description": "Externally-appropriate, simplified representation of a single relationship between two records.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RelationshipInfoRecordCollectionCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RelationshipInfo" }, "description": "Represents a collection of records resulting from a query or other retrieve operation.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RelationshipTypeInfo": { "required": [ "AppliesTo", "Code", "GroupCodes" ], "type": "object", "properties": { "AppliesTo": { "type": "array", "items": { "type": "string" }, "description": "The friendly names of the record types a relationship of this type can reference.", "example": [ "Accounts", "Contacts" ] }, "Code": { "type": "integer", "description": "The numeric code identifying this relationship type. Supply this as the type code when retrieving or filtering relationships.", "format": "int32", "example": 10 }, "DefaultSplit": { "type": "number", "description": "The default split applied to new relationships of this type, expressed as a fraction between 0 and 1 (for example, 0.5 represents 50%). Null when the type has no default split.", "format": "double", "nullable": true, "example": 0.5 }, "GroupCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The codes of the relationship groups this type belongs to.", "example": [ 5, 12 ] }, "Name": { "type": "string", "description": "The friendly name of the relationship type.", "nullable": true, "example": "Referred By" } }, "additionalProperties": false, "description": "Externally-appropriate, simplified representation of a relationship type that callers can reference by code." }, "RetrieveAcademicHonors": { "allOf": [ { "$ref": "#/components/schemas/AcademicHonorsBase" }, { "type": "object", "properties": { "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true } }, "additionalProperties": false } ], "description": "The model for retrieving Academic Honors." }, "RetrieveAcademicHonorsCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveAcademicHonors" } ], "description": "The model for retrieving Academic Honors.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveAcademicHonorsListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveAcademicHonors" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveAccreditations": { "allOf": [ { "$ref": "#/components/schemas/AccreditationsBase" }, { "type": "object", "properties": { "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true } }, "additionalProperties": false } ], "description": "The model for retrieving Accreditations." }, "RetrieveAccreditationsCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveAccreditations" } ], "description": "The model for retrieving Accreditations.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveAccreditationsListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveAccreditations" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveAccreditingInstitutions": { "allOf": [ { "$ref": "#/components/schemas/AccreditingInstitutionsBase" }, { "type": "object", "properties": { "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true } }, "additionalProperties": false } ], "description": "The model for retrieving Accrediting Institutions." }, "RetrieveAccreditingInstitutionsCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveAccreditingInstitutions" } ], "description": "The model for retrieving Accrediting Institutions.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveAccreditingInstitutionsListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveAccreditingInstitutions" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveActivities": { "allOf": [ { "$ref": "#/components/schemas/ActivitiesBase" }, { "type": "object", "properties": { "AllDay": { "type": "boolean", "description": "Whether the Activity is all-day.", "nullable": true }, "AttachmentId": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "Stores the ID of an associated attachment Artifact if the Activity has an associated document.", "nullable": true }, "Attendees": { "type": "string", "description": "The attendees of the Activity.", "nullable": true }, "BCC": { "type": "string", "description": "The Blind Carbon Copy (BCC) recipients for Email Activities.", "nullable": true }, "CC": { "type": "string", "description": "The Carbon Copy (CC) recipients for Email Activities.", "nullable": true }, "ChildExperienceCount": { "type": "integer", "description": "The number of child Activities whose parent is this Activity.", "format": "int32", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "DocumentTypeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "This is used for setting the document type when sending document requests", "nullable": true }, "DueDate": { "type": "string", "description": "The date an Activity is due to be completed on.", "format": "date-time", "nullable": true }, "Duration": { "type": "number", "description": "Duration of an appointment or call activity (in minutes)", "format": "float", "nullable": true }, "EmailAlternateHtml": { "type": "string", "description": "The alternate HTML for Email Activities.", "nullable": true }, "EmailAttachmentIds": { "type": "array", "items": { "$ref": "#/components/schemas/LookupAny" }, "description": "Any Artifacts included for Email Activities.", "nullable": true }, "EmailFlagReason": { "type": "string", "description": "Any additional details about a flagged Email Activity.", "nullable": true }, "EmailImportance": { "type": "integer", "description": "The enumerated importance of recorded email inbound to Crelate. A lower number is more important, though zero indicates no specified importance.", "format": "int32", "nullable": true }, "EmailRawHeader": { "type": "string", "description": "For journal email, this is the raw header", "nullable": true }, "EmailStatus": { "type": "integer", "description": "The status value for Email Activities.", "format": "int32", "nullable": true }, "FormId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Form instance for the Activity.", "nullable": true }, "From": { "type": "string", "description": "The sender address for Email Activities.", "nullable": true }, "HasAlternateEmail": { "type": "boolean", "description": "Whether alternate HTML is present for Email Activities.", "nullable": true }, "Html": { "type": "string", "description": "The HTML content of the Activity. Not all HTML is allowed and some tags may be removed. Mutually exclusive with the Display field.", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "IsCallCompleted": { "type": "boolean", "description": "Whether a phone call from a phone call type Activity from dialer integrations is completed.", "nullable": true }, "IsEngagement": { "type": "boolean", "description": "Whether the Activity is considered engagement with the parent record.", "nullable": true }, "IsInvite": { "type": "boolean", "description": "Whether the Activity represents a calendar invitation.", "nullable": true }, "IsReachOut": { "type": "boolean", "description": "Whether the Activity is considered a reach-out to the parent record.", "nullable": true }, "IsTeamsMeeting": { "type": "boolean", "description": "Determines if this is a Microsoft Teams meeting", "nullable": true }, "Location": { "type": "string", "description": "The location of meeting-type Activities.", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "Owners": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" }, "description": "The Crelate user, or users, who owns a record.", "nullable": true }, "ParentExperienceId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The parent Activity of the Activity.", "nullable": true }, "ParentId": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "The parent record of the Activity.", "nullable": true }, "Rating": { "type": "integer", "description": "The 0-5 star rating value of the Activity, for Activity Types that support ratings like Client Portal Feedback.", "format": "int32", "nullable": true }, "RegardingId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Job the Activity is regarding.", "nullable": true }, "Subject": { "type": "string", "description": "The subject line for Email Activities.", "nullable": true }, "TimezoneId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The standardized time zone for meeting Activities.", "nullable": true }, "To": { "type": "string", "description": "The primary recipient(s) for Email Activities.", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true }, "VerbId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Specifies the Activity Type of the record, which controls its behavior and available functionality.", "nullable": true }, "WhatEntityIds": { "type": "array", "items": { "$ref": "#/components/schemas/LookupAny" }, "description": "Various related records to the Activity. Types of entities linked depend on the Activity Type.", "nullable": true }, "WhenOffset": { "type": "integer", "description": "The time zone offset in minutes relative to UTC.", "format": "int32", "nullable": true }, "WhoAttendeeIds": { "type": "array", "items": { "$ref": "#/components/schemas/LookupAny" }, "description": "The linked Email Addresses of attendees of meeting Activities.", "nullable": true }, "WhoBccIds": { "type": "array", "items": { "$ref": "#/components/schemas/LookupAny" }, "description": "The linked Email Addresses of Blind Carbon Copy recipients of Email Activities.", "nullable": true }, "WhoCcIds": { "type": "array", "items": { "$ref": "#/components/schemas/LookupAny" }, "description": "The linked Email Addresses of Carbon Copy recipients of Email Activities.", "nullable": true }, "WorkflowItemId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The linked Workflow Item of the Activity.", "nullable": true } }, "additionalProperties": false } ], "description": "The model for retrieving Activities." }, "RetrieveActivitiesCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveActivities" } ], "description": "The model for retrieving Activities.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveActivitiesListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveActivities" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveActivityTypes": { "type": "object", "properties": { "AbbreviatedName": { "type": "string", "description": "The abbreviated name of the Activity Type to show in place of the full name when screen space is limited.", "nullable": true }, "AllowAttachments": { "type": "boolean", "description": "Whether the Activity Type allows adding Artifacts as attachments.", "nullable": true }, "AllowCalendarInvite": { "type": "boolean", "description": "If the activity supports sending a calendar invitation.", "nullable": true }, "AllowedParentEntityTypes": { "type": "array", "items": { "type": "string" }, "description": "The entity types allowed as parents of Activities of the Activity Type.", "nullable": true }, "AttachmentRequired": { "type": "boolean", "description": "Whether an Artifact is required for Activities of the Activity Type that allow Artifacts.", "nullable": true }, "AttachmentTypeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The single Artifact Type allowed for Activities of the Activity Type. If blank, any Artifact Type is allowed.", "nullable": true }, "Color": { "type": "string", "description": "The color to associate with records having the Activity Type in graphical interfaces.", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "EngagementBehaviorType": { "type": "integer", "description": "The engagement behavior type for Activities of the Activity Type. Never = 0, Always = 1, AskDefaultFalse = 2, AskDefaultTrue = 3, Dynamic = 4", "format": "int32", "nullable": true }, "FollowUpVerbId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "If follow-up is enabled, this determines the activity-type of the follow-up activity.", "nullable": true }, "Icon": { "type": "string", "description": "The icon to use for Activities of the Activity Type in graphical interfaces.", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "IsActivityFormRequired": { "type": "boolean", "description": "Whether an Activity Form is required when creating Activities of the Activity Type.", "nullable": true }, "IsCustomActivity": { "type": "boolean", "description": "If the verb is a custom activity", "nullable": true }, "IsEngagement": { "type": "boolean", "description": "Whether Activities of the Activity Type constitute engagement with the parent record.", "nullable": true }, "IsFollowUpEnabled": { "type": "boolean", "description": "Whether the 'follow up' field is displayed when creating activities of this type.", "nullable": true }, "Mode": { "type": "integer", "description": "1 = Basic Activity, 2 = Meeting/Appointment Activity, 3 = Placement", "format": "int32", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "Name": { "type": "string", "description": "The name of the Activity Type.", "nullable": true }, "PastTense": { "type": "string", "description": "The past tense of this verb", "nullable": true }, "PluralName": { "type": "string", "description": "The plural name of the Activity Type.", "nullable": true }, "PresentTense": { "type": "string", "description": "The present tense form of the Activity Type name for use in forming sentences.", "nullable": true }, "Rating": { "type": "boolean", "description": "True if the activity includes a thumbs up / thumbs down rating.", "nullable": true }, "RatingRequired": { "type": "boolean", "description": "Feedback Rating is required", "nullable": true }, "ReachOutBehaviorType": { "type": "integer", "description": "The reach-out behavior type for Activities of the Activity Type. Never = 0, Always = 1, AskDefaultFalse = 2, AskDefaultTrue = 3, Dynamic = 4", "format": "int32", "nullable": true }, "RegardingRequired": { "type": "boolean", "description": "Whether a regarding Job is required when creating Activities of the Activity Type.", "nullable": true }, "SortOrder": { "type": "integer", "description": "The sort order of the Activity Type relative to other Activity Types.", "format": "int32", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Activity Types." }, "RetrieveActivityTypesCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveActivityTypes" } ], "description": "The model for retrieving Activity Types.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveActivityTypesListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveActivityTypes" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveAddresses": { "allOf": [ { "$ref": "#/components/schemas/AddressesBase" }, { "type": "object", "properties": { "CountryId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The standardized country of the address.", "nullable": true }, "CreatedOnSystem": { "type": "string", "description": "The date a record was created on and recognized by the Crelate system. This cannot be overridden.", "format": "date-time", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true } }, "additionalProperties": false } ], "description": "The model for retrieving Addresses." }, "RetrieveApplications": { "type": "object", "properties": { "Addresses_Business": { "allOf": [ { "$ref": "#/components/schemas/RetrieveAddresses" } ], "description": "The addresses of the Applicant.", "nullable": true }, "Addresses_Home": { "allOf": [ { "$ref": "#/components/schemas/RetrieveAddresses" } ], "description": "The addresses of the Applicant.", "nullable": true }, "Addresses_Other": { "allOf": [ { "$ref": "#/components/schemas/RetrieveAddresses" } ], "description": "The addresses of the Applicant.", "nullable": true }, "ContactId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The linked contact record of a processed Applicant.", "nullable": true }, "ContactSourceId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The standardized source of the Applicant.", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "CurrentCompanyId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The linked Company from the parsed resume Artifact of the Applicant.", "nullable": true }, "Education": { "allOf": [ { "$ref": "#/components/schemas/RetrieveEducationTimelineItem" } ], "description": "The Application's education info (School, Degree, Graduation Year, etc)", "nullable": true }, "EmailAddresses_Other": { "allOf": [ { "$ref": "#/components/schemas/RetrieveEmailAddresses" } ], "description": "The email addresses of the Applicant.", "nullable": true }, "EmailAddresses_Personal": { "allOf": [ { "$ref": "#/components/schemas/RetrieveEmailAddresses" } ], "description": "The email addresses of the Applicant.", "nullable": true }, "EmailAddresses_Work": { "allOf": [ { "$ref": "#/components/schemas/RetrieveEmailAddresses" } ], "description": "The email addresses of the Applicant.", "nullable": true }, "ExternalPrimaryKey": { "type": "string", "description": "The external primary key of a record. Not guaranteed to be globally unique.", "nullable": true }, "FirstName": { "type": "string", "description": "The first name of the Applicant.", "nullable": true }, "FormId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The linked application form of the Applicant.", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "JobId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The job being applied to.", "nullable": true }, "JobTitle": { "type": "string", "description": "The current job title of the Applicant.", "nullable": true }, "LastName": { "type": "string", "description": "The last name of the Applicant.", "nullable": true }, "MiddleName": { "type": "string", "description": "The middle name of the Applicant.", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "Name": { "type": "string", "description": "The full name of the Applicant.", "nullable": true }, "NickName": { "type": "string", "description": "The nickname of the Applicant.", "nullable": true }, "Owners": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" }, "description": "The Crelate user, or users, who owns a record.", "nullable": true }, "ParsedCity": { "type": "string", "description": "The residing city of the Applicant as parsed from their resume.", "nullable": true }, "ParsedEmail": { "type": "string", "description": "The email of the Applicant as parsed from their resume.", "nullable": true }, "ParsedFirstName": { "type": "string", "description": "The first name of the Applicant as parsed from their resume.", "nullable": true }, "ParsedLastName": { "type": "string", "description": "The last name of the Applicant as parsed from their resume.", "nullable": true }, "ParsedPhone": { "type": "string", "description": "The phone number of the Applicant as parsed from their resume.", "nullable": true }, "ParsedState": { "type": "string", "description": "The residing state or province of the Applicant as parsed from their resume.", "nullable": true }, "ParsedZip": { "type": "string", "description": "The residing ZIP or postal code of the Applicant as parsed from their resume.", "nullable": true }, "PhoneNumbers_Fax": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "The phone numbers of the Applicant.", "nullable": true }, "PhoneNumbers_Home": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "The phone numbers of the Applicant.", "nullable": true }, "PhoneNumbers_Mobile": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "The phone numbers of the Applicant.", "nullable": true }, "PhoneNumbers_Other": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "The phone numbers of the Applicant.", "nullable": true }, "PhoneNumbers_Skype": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "The phone numbers of the Applicant.", "nullable": true }, "PhoneNumbers_Work_Direct": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "The phone numbers of the Applicant.", "nullable": true }, "PhoneNumbers_Work_Main": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "The phone numbers of the Applicant.", "nullable": true }, "PrimaryDocumentAttachmentId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The primary Artifact, usually a resume, of the Applicant.", "nullable": true }, "RawHttpReferer": { "type": "string", "description": "The raw HTTP Referer header information of the Applicant, if received, from certain external systems.", "nullable": true }, "SourceId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The source of a record.", "nullable": true }, "StatusId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "A lookup to a related entity of a single entity type.", "nullable": true }, "Tags": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" } }, "description": "The tags for the Applicant.", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true }, "Websites_Blog": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "The websites for the Applicant.", "nullable": true }, "Websites_Business": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "The websites for the Applicant.", "nullable": true }, "Websites_Facebook": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "The websites for the Applicant.", "nullable": true }, "Websites_LinkedIn": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "The websites for the Applicant.", "nullable": true }, "Websites_Other": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "The websites for the Applicant.", "nullable": true }, "Websites_Personal": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "The websites for the Applicant.", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Applications." }, "RetrieveApplicationsCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveApplications" } ], "description": "The model for retrieving Applications.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveApplicationsListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveApplications" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveArtifactTypes": { "type": "object", "properties": { "AllowedEntityTypes": { "type": "array", "items": { "type": "string" }, "description": "The entity type(s) Artifacts of the Artifact Type are allowed to be parented to.", "nullable": true }, "Color": { "type": "string", "description": "The color to associate with Artifacts of the Artifact Type in graphical interfaces.", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "HasExpiration": { "type": "boolean", "description": "Whether Artifacts of the Artifact Type can expire.", "nullable": true }, "HasRestrictedStorage": { "type": "boolean", "description": "Whether Artifacts of the Artifact Type should use restricted storage.", "nullable": true }, "HasVerification": { "type": "boolean", "description": "Whether Artifacts of the Artifact Type can be verified.", "nullable": true }, "Icon": { "type": "string", "description": "The icon to use for Artifacts of the Artifact Type in graphical interfaces.", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "IsAdvancedType": { "type": "boolean", "description": "Whether the Artifact Type represents an Advanced Artifact with additional settings.", "nullable": true }, "MeaningId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The standardized meaning of the Artifact Type.", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "Name": { "type": "string", "description": "The name of the Artifact Type.", "nullable": true }, "NamePlural": { "type": "string", "description": "The plural name of the Artifact Type.", "nullable": true }, "ShowOnForm": { "type": "boolean", "nullable": true }, "SortOrder": { "type": "integer", "description": "The sort order of the Artifact Type relative to other Artifact Types.", "format": "int32", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Artifact Types." }, "RetrieveArtifactTypesCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveArtifactTypes" } ], "description": "The model for retrieving Artifact Types.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveArtifactTypesListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveArtifactTypes" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveArtifacts": { "allOf": [ { "$ref": "#/components/schemas/ArtifactsBase" }, { "type": "object", "properties": { "Addresses_Business": { "allOf": [ { "$ref": "#/components/schemas/RetrieveAddresses" } ], "description": "A collection of addresses associated with the artifact.", "nullable": true }, "Addresses_Headquarters": { "allOf": [ { "$ref": "#/components/schemas/RetrieveAddresses" } ], "description": "A collection of addresses associated with the artifact.", "nullable": true }, "Addresses_Home": { "allOf": [ { "$ref": "#/components/schemas/RetrieveAddresses" } ], "description": "A collection of addresses associated with the artifact.", "nullable": true }, "Addresses_Other": { "allOf": [ { "$ref": "#/components/schemas/RetrieveAddresses" } ], "description": "A collection of addresses associated with the artifact.", "nullable": true }, "ApplicationId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The linked application of the Artifact.", "nullable": true }, "AttachmentTypeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The standardized type of the Artifact.", "nullable": true }, "BackgroundCheckProviderType": { "type": "integer", "description": "Describes the service provider for background checks.", "format": "int32", "nullable": true }, "BankName": { "type": "string", "description": "Bank Name associated with a routing number", "nullable": true }, "BankNameAttestationType": { "type": "integer", "description": "Indicates the systems ability to provide a bank name for the given routing number and whether it aligns with what the candidate attested.", "format": "int32", "nullable": true }, "CitizenshipId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The citizenship of the record associated with the artifact.", "nullable": true }, "Class": { "type": "string", "description": "The associated class in relation to the artifact.", "nullable": true }, "Code": { "type": "string", "description": "The associated code in relation to the artifact.", "nullable": true }, "CompletedOn": { "type": "string", "description": "The date the Artifact was completed on.", "format": "date-time", "nullable": true }, "ContentLength": { "type": "integer", "description": "The content length in bytes of the binary file data of the Artifact. Null for Artifacts without a file.", "format": "int32", "nullable": true }, "ContentType": { "type": "string", "description": "The content MIME type of the binary file data of the Artifact. Null for Artifacts without a file.", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "CredentialId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "A lookup to a related entity of a single entity type.", "nullable": true }, "DateOfBirth": { "type": "string", "description": "Record's date of birth", "format": "date-time", "nullable": true }, "DepositAccountIdNumber": { "type": "string", "description": "Employee’s bank account number.", "nullable": true }, "DepositAccountRoutingNumber": { "type": "string", "description": "Employee's bank routing number for the deposit.", "nullable": true }, "DepositAccountType": { "type": "integer", "description": "Type of account for direct deposit: checking or savings.", "format": "int32", "nullable": true }, "DepositType": { "type": "integer", "description": "Method of payment: direct deposit, pay card, or other.", "format": "int32", "nullable": true }, "Details": { "type": "string", "description": "Additional details regarding the artifact.", "nullable": true }, "EffectiveOn": { "type": "string", "description": "The date the artifact goes into effect.", "format": "date-time", "nullable": true }, "EmailAddresses_Other": { "allOf": [ { "$ref": "#/components/schemas/RetrieveEmailAddresses" } ], "description": "A collection of email addresses associated to the artifact.", "nullable": true }, "EmailAddresses_Personal": { "allOf": [ { "$ref": "#/components/schemas/RetrieveEmailAddresses" } ], "description": "A collection of email addresses associated to the artifact.", "nullable": true }, "EmailAddresses_Work": { "allOf": [ { "$ref": "#/components/schemas/RetrieveEmailAddresses" } ], "description": "A collection of email addresses associated to the artifact.", "nullable": true }, "EsignatureId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Lookup to eSignature if the attachment was created from an eSignature request.", "nullable": true }, "EthnicityId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The ethnicity of the record associated with the artifact", "nullable": true }, "ExpiresOn": { "type": "string", "description": "The date an Artifact expires on.", "format": "date-time", "nullable": true }, "ExternalLinks_Blog": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "A collection of external links associated with the artifact.", "nullable": true }, "ExternalLinks_Business": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "A collection of external links associated with the artifact.", "nullable": true }, "ExternalLinks_Description": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "A collection of external links associated with the artifact.", "nullable": true }, "ExternalLinks_Other": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "A collection of external links associated with the artifact.", "nullable": true }, "ExternalLinks_Personal": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "A collection of external links associated with the artifact.", "nullable": true }, "FirstName": { "type": "string", "description": "Record's first name or given name", "nullable": true }, "From": { "type": "string", "description": "Sender email address", "nullable": true }, "Height": { "type": "string", "description": "Record's height", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "IsDocument": { "type": "boolean", "description": "Whether the Artifact is a document file.", "nullable": true }, "IsImage": { "type": "boolean", "description": "Whether the Artifact is an image file.", "nullable": true }, "IssuedBy": { "type": "string", "description": "The authority that issued the artifact", "nullable": true }, "IssuedOn": { "type": "string", "description": "The date the artifact was issued", "format": "date-time", "nullable": true }, "IssuingCountryId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The country that issued the artifact", "nullable": true }, "IssuingState": { "type": "string", "description": "The state that issued the artifact", "nullable": true }, "LastName": { "type": "string", "description": "Record's last name, surname, or family name", "nullable": true }, "MiddleName": { "type": "string", "description": "Record's middle name or middle initial", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "Name": { "type": "string", "description": "The name of the Artifact.", "nullable": true }, "NationalityId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The nationality of the record associated with the artifact", "nullable": true }, "Owners": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" }, "description": "The Crelate user, or users, who owns a record.", "nullable": true }, "ParentAttachmentId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The parent Artifact of the artifact.", "nullable": true }, "PayCardIdNumber": { "type": "string", "description": "The account number assigned to the employee's Pay Card.", "nullable": true }, "PayCardRoutingNumber": { "type": "string", "description": "The routing number assigned to the employee's Pay Card.", "nullable": true }, "PhoneNumbers_Home": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "A collection of phone numbers associated with the artifact", "nullable": true }, "PhoneNumbers_Mobile": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "A collection of phone numbers associated with the artifact", "nullable": true }, "PhoneNumbers_Other": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "A collection of phone numbers associated with the artifact", "nullable": true }, "PhoneNumbers_Work_Direct": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "A collection of phone numbers associated with the artifact", "nullable": true }, "PlaceOfBirth": { "type": "string", "description": "Record's place of birth", "nullable": true }, "PrimaryArtifactIdentifier": { "type": "string", "description": "The primary ID or number that identifies the artifact", "nullable": true }, "RevokedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Crelate user who revoked the Artifact.", "nullable": true }, "RevokedOn": { "type": "string", "description": "The date the Artifact was revoked on.", "format": "date-time", "nullable": true }, "SecondaryArtifactIdentifier": { "type": "string", "description": "A secondary ID or number that identifies the artifact", "nullable": true }, "SentOn": { "type": "string", "description": "Describes when an artifact was sent", "format": "date-time", "nullable": true }, "SexId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Record's gender", "nullable": true }, "SourceId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The source of a record.", "nullable": true }, "StatusId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Current status of the artifact", "nullable": true }, "Subject": { "type": "string", "description": "Email subject", "nullable": true }, "SubStatus": { "type": "string", "description": "Sub Status text from external system to contain extra status information.", "nullable": true }, "SubType": { "type": "string", "description": "The associated type in relation to the artifact - different than Artifact Type", "nullable": true }, "TargetEntityId": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "The entity targeted by a record.", "nullable": true }, "To": { "type": "string", "description": "Recipient email address", "nullable": true }, "TypeCode": { "type": "integer", "description": "Used as a system type for special artifacts (i.e. placeholder artifacts)", "format": "int32", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true }, "VerifiedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Crelate user who verified the Artifact.", "nullable": true }, "VerifiedOn": { "type": "string", "description": "The date the Artifact was verified on.", "format": "date-time", "nullable": true }, "Weight": { "type": "string", "description": "Record's weight", "nullable": true }, "WorkAuthorizationProviderType": { "allOf": [ { "$ref": "#/components/schemas/WAProviderType" } ], "description": "Value for the work authorization provider type.", "nullable": true } }, "additionalProperties": false } ], "description": "The model for retrieving Artifacts." }, "RetrieveArtifactsCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveArtifacts" } ], "description": "The model for retrieving Artifacts.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveArtifactsListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveArtifacts" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveBackups": { "type": "object", "properties": { "AttachmentStatusDetails": { "type": "string", "description": "Status progress details of attachments including attachment entity records and attachment files", "nullable": true }, "BackupDetails": { "type": "string", "description": "Include all of the package info like the zips, ids, etc", "nullable": true }, "BackupVersion": { "type": "integer", "description": "This is used to indicate which backup service version this backup created by to help for logging and tracing.", "format": "int32", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "IncludeAttachments": { "type": "boolean", "description": "Whether the Backup includes Artifact file attachments.", "nullable": true }, "IncludeModifiedAfter": { "type": "string", "description": "The timestamp only after which to include records in the Backup.", "format": "date-time", "nullable": true }, "IncludeRestrictedAttachments": { "type": "boolean", "description": "Whether the Backup includes Artifact file attachments from restricted storage.", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "Name": { "type": "string", "description": "The name of the Backup.", "nullable": true }, "Password": { "type": "string", "description": "The password to unlock the Backup.", "nullable": true }, "Status": { "type": "string", "description": "The current status of the Backup.", "nullable": true }, "StatusDetails": { "type": "string", "description": "Detailed status information about the Backup.", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Backups." }, "RetrieveBackupsCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveBackups" } ], "description": "The model for retrieving Backups.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveBackupsListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveBackups" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveBillableItems": { "type": "object", "properties": { "AccountId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The account this billable item will be charged to.", "nullable": true }, "Amount": { "type": "number", "description": "The amount of this billable item.", "format": "double", "nullable": true }, "BillableItemNum": { "type": "integer", "description": "Auto number field", "format": "int32", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "DebitAccountId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Ledger Account to debit when the invoice is sent.", "nullable": true }, "DeliveryTypeId": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "The delivery type for this billable item.", "nullable": true }, "EmployeeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The employee that generated this billable item.", "nullable": true }, "EntityStatus": { "type": "integer", "description": "The status of this billable item.", "format": "int32", "nullable": true }, "ErrorDetails": { "type": "string", "description": "Details pertaining to the error that this billable item has.", "nullable": true }, "ExpenseEntryId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The expense entry that generated this billable item.", "nullable": true }, "ExternalLineItemId": { "type": "string", "description": "Id of the line item in the external accounting system (e.g. xero)", "nullable": true }, "FirstExportedOn": { "type": "string", "description": "First time that this billable item was exported.", "format": "date-time", "nullable": true }, "HasError": { "type": "boolean", "description": "If true, this item has an error. Details in ErrorDetails.", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "InvoiceId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Invoice that this billable item is for", "nullable": true }, "JobId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The job that this billable item was created for.", "nullable": true }, "LastExportedOn": { "type": "string", "description": "Time that this billable item was exported", "format": "date-time", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "Name": { "type": "string", "description": "The name of the billable item.", "nullable": true }, "Note": { "type": "string", "description": "Free text notes field to add additional detail for this billable item.", "nullable": true }, "OriginalBillableItemId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Link to the original billable item if one was cloned.", "nullable": true }, "PayRuleName": { "type": "string", "description": "A human readable representation of the rule applied.", "nullable": true }, "Quantity": { "type": "number", "description": "The quantity of this billable item.", "format": "double", "nullable": true }, "Rate": { "type": "number", "description": "The rate to multiply against the quantity for quantity-based billable items.", "format": "double", "nullable": true }, "TimeSubmissionPeriodId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The time submission period associated with this item", "nullable": true }, "Total": { "type": "number", "description": "The total of this billable item.", "format": "double", "nullable": true }, "TransactionDate": { "type": "string", "description": "Date that this billable item is recognized.", "format": "date-time", "nullable": true }, "TypeOption": { "allOf": [ { "$ref": "#/components/schemas/BillableItemTypeOption" } ], "description": "Describes the item from a ledger perspective. That is, which ledger to record this item under.\n\n0 = Unknown\n\n1 = ServiceOrGoods\n\n2 = Expense", "nullable": true }, "ValidFrom": { "type": "string", "description": "DateTime that this row in SQL is valid from. Used for \"as of\" queries", "format": "date-time", "nullable": true }, "ValidTo": { "type": "string", "description": "DateTime that this row in SQL is valid to. Used for \"as of\" queries", "format": "date-time", "nullable": true }, "WasExported": { "type": "boolean", "description": "If true, this billable item has been exported before.", "nullable": true }, "WasManuallyCreated": { "type": "boolean", "description": "If true, this billable item was manually created.", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Billable Items." }, "RetrieveBillableItemsListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveBillableItems" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveCompanies": { "allOf": [ { "$ref": "#/components/schemas/CompaniesBase" }, { "type": "object", "properties": { "AccountBalance": { "type": "number", "description": "A readonly number field that is a quick reference to the outstanding balance for an Account", "format": "double", "nullable": true }, "AccountSourceId": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "Tracks the original source of a Company. i.e., who or what referred the Company to you.", "nullable": true }, "AdditionalContacts_Billing": { "allOf": [ { "$ref": "#/components/schemas/RetrieveRelatedContacts" } ], "description": "Contacts related to the Company (e.g., Billing Contact)", "nullable": true }, "AdditionalContacts_OtherContact": { "allOf": [ { "$ref": "#/components/schemas/RetrieveRelatedContacts" } ], "description": "Contacts related to the Company (e.g., Billing Contact)", "nullable": true }, "Addresses_Business": { "allOf": [ { "$ref": "#/components/schemas/RetrieveAddresses" } ], "description": "Collection of physical addresses for this Company (e.g., Business address, Headquarters)", "nullable": true }, "Addresses_Headquarters": { "allOf": [ { "$ref": "#/components/schemas/RetrieveAddresses" } ], "description": "Collection of physical addresses for this Company (e.g., Business address, Headquarters)", "nullable": true }, "Addresses_Other": { "allOf": [ { "$ref": "#/components/schemas/RetrieveAddresses" } ], "description": "Collection of physical addresses for this Company (e.g., Business address, Headquarters)", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "CustomField31": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField32": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField33": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField34": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField35": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField36": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField37": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField38": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField39": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField40": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField71": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField72": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField73": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField74": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField75": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField76": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField77": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField78": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField79": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField80": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "EmailAddresses_Other": { "allOf": [ { "$ref": "#/components/schemas/RetrieveEmailAddresses" } ], "description": "Collection of email addresses for this Company (Sales, Support, etc.)", "nullable": true }, "EmailAddresses_Sales": { "allOf": [ { "$ref": "#/components/schemas/RetrieveEmailAddresses" } ], "description": "Collection of email addresses for this Company (Sales, Support, etc.)", "nullable": true }, "EmailAddresses_Support": { "allOf": [ { "$ref": "#/components/schemas/RetrieveEmailAddresses" } ], "description": "Collection of email addresses for this Company (Sales, Support, etc.)", "nullable": true }, "EntityStatus": { "type": "integer", "description": "The status of a record.", "format": "int32", "nullable": true }, "IconAttachmentId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Artifact shown as the icon for the Company.", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "LastActionDate": { "type": "string", "description": "The last time there was an action by a Crelate user regarding this Company.", "format": "date-time", "nullable": true }, "LastActivityDate": { "type": "string", "description": "The last time any activity was created or modified regarding this company..", "format": "date-time", "nullable": true }, "LastActivityOrModifiedOn": { "type": "string", "description": "The last time this Company was either modified, or the last time an activity was created for this Company.", "format": "date-time", "nullable": true }, "LastEngagementDate": { "type": "string", "description": "The When date of the last completed \"engagement\" activity regarding this company.", "format": "date-time", "nullable": true }, "LastReachOutBy": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last reached out, such as by sending an email, sending a text message, or leaving a voicemail.", "nullable": true }, "LastReachOutDate": { "type": "string", "description": "The last time there was an reach out activity by a Crelate user regarding this Company.", "format": "date-time", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "Owners": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" }, "description": "The Crelate user, or users, who owns a record.", "nullable": true }, "ParentAccountId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The parent Company, such as in the case of a subsidiary.", "nullable": true }, "PhoneNumbers_Fax": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "Collection of phone numbers for this Company (e.g., Main, Sales, Support)", "nullable": true }, "PhoneNumbers_Main": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "Collection of phone numbers for this Company (e.g., Main, Sales, Support)", "nullable": true }, "PhoneNumbers_Other": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "Collection of phone numbers for this Company (e.g., Main, Sales, Support)", "nullable": true }, "PhoneNumbers_Sales": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "Collection of phone numbers for this Company (e.g., Main, Sales, Support)", "nullable": true }, "PhoneNumbers_Skype": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "Collection of phone numbers for this Company (e.g., Main, Sales, Support)", "nullable": true }, "PhoneNumbers_Support": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "Collection of phone numbers for this Company (e.g., Main, Sales, Support)", "nullable": true }, "PrimaryDocumentAttachmentId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The primary Artifact for the Company.", "nullable": true }, "StatusReason": { "type": "string", "description": "An optional text field explaining the reason for the StatusId field.", "nullable": true }, "Tags": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" } }, "description": "The tags for the Company.", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true }, "Websites_Blog": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true }, "Websites_Business": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true }, "Websites_CareerPage": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true }, "Websites_Facebook": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true }, "Websites_Leadership_People": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true }, "Websites_LinkedIn": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true }, "Websites_Other": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true }, "Websites_Other_Alternate": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true }, "Websites_Twitter": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true }, "WorksiteId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The default Worksite for a Company.", "nullable": true } }, "additionalProperties": false } ], "description": "The model for retrieving Companies." }, "RetrieveCompaniesCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveCompanies" } ], "description": "The model for retrieving Companies.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveCompaniesListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveCompanies" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveCompanySources": { "type": "object", "properties": { "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "MeaningId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The standardized meaning of the Company Source.", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "Name": { "type": "string", "description": "The name of the Company Source.", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Company Sources." }, "RetrieveCompanySourcesCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveCompanySources" } ], "description": "The model for retrieving Company Sources.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveCompanySourcesListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveCompanySources" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveContactSources": { "type": "object", "properties": { "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "ExternalPrimaryKey": { "type": "string", "description": "The external primary key of a record. Not guaranteed to be globally unique.", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "MeaningId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The standardized meaning of the Contact Source.", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "Name": { "type": "string", "description": "The name of the Contact Source.", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Contact Sources." }, "RetrieveContactSourcesCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveContactSources" } ], "description": "The model for retrieving Contact Sources.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveContactSourcesListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveContactSources" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveContacts": { "allOf": [ { "$ref": "#/components/schemas/ContactsBase" }, { "type": "object", "properties": { "Addresses_Business": { "allOf": [ { "$ref": "#/components/schemas/RetrieveAddresses" } ], "description": "A collection of addresses (Home address, Work Address, etc.)", "nullable": true }, "Addresses_Home": { "allOf": [ { "$ref": "#/components/schemas/RetrieveAddresses" } ], "description": "A collection of addresses (Home address, Work Address, etc.)", "nullable": true }, "Addresses_Other": { "allOf": [ { "$ref": "#/components/schemas/RetrieveAddresses" } ], "description": "A collection of addresses (Home address, Work Address, etc.)", "nullable": true }, "ContactNum": { "type": "integer", "description": "If auto-numbering on Contacts is enabled, then an incrementing unique Id number will be assigned to each Contact. Note: This field will NOT appear on the \"New Contact\" form.", "format": "int32", "nullable": true }, "ContactSourceId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Tracks the original source of a candidate. i.e., which job board the candidate came from or who referred them", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "CurrentPosition": { "allOf": [ { "$ref": "#/components/schemas/RetrieveWorkHistoryTimelineItem" } ], "description": "The Contact's current company and job title (and optionally, the start date and end date).", "nullable": true }, "CustomField31": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField32": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField33": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField34": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField35": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField36": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField37": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField38": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField39": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField40": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField71": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField72": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField73": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField74": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField75": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField76": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField77": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField78": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField79": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField80": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "DisabilityStatus": { "type": "integer", "description": "The OFCCP field for this Contact's disability status.", "format": "int32", "nullable": true }, "Education": { "allOf": [ { "$ref": "#/components/schemas/RetrieveEducationTimelineItem" } ], "description": "The Contact's education info (School, Degree, Graduation Year, etc.)", "nullable": true }, "EeoEthnicity": { "type": "integer", "description": "The EEO field for this Contact's ethnicity.", "format": "int32", "nullable": true }, "EeoGender": { "type": "integer", "description": "The EEO field for this Contact's gender.", "format": "int32", "nullable": true }, "EmailAddresses_Other": { "allOf": [ { "$ref": "#/components/schemas/RetrieveEmailAddresses" } ], "description": "A collection of email addresses (Personal Email, Work Email, etc.)", "nullable": true }, "EmailAddresses_Other_Alternate": { "allOf": [ { "$ref": "#/components/schemas/RetrieveEmailAddresses" } ], "description": "A collection of email addresses (Personal Email, Work Email, etc.)", "nullable": true }, "EmailAddresses_Personal": { "allOf": [ { "$ref": "#/components/schemas/RetrieveEmailAddresses" } ], "description": "A collection of email addresses (Personal Email, Work Email, etc.)", "nullable": true }, "EmailAddresses_Personal_Other": { "allOf": [ { "$ref": "#/components/schemas/RetrieveEmailAddresses" } ], "description": "A collection of email addresses (Personal Email, Work Email, etc.)", "nullable": true }, "EmailAddresses_Potential": { "allOf": [ { "$ref": "#/components/schemas/RetrieveEmailAddresses" } ], "description": "A collection of email addresses (Personal Email, Work Email, etc.)", "nullable": true }, "EmailAddresses_Work": { "allOf": [ { "$ref": "#/components/schemas/RetrieveEmailAddresses" } ], "description": "A collection of email addresses (Personal Email, Work Email, etc.)", "nullable": true }, "EmailAddresses_Work_Other": { "allOf": [ { "$ref": "#/components/schemas/RetrieveEmailAddresses" } ], "description": "A collection of email addresses (Personal Email, Work Email, etc.)", "nullable": true }, "EntityStatus": { "type": "integer", "description": "The status of a record.", "format": "int32", "nullable": true }, "EthnicityId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Contact's ethnicity", "nullable": true }, "FullName": { "type": "string", "description": "The Contact' Full Name (First Last)", "nullable": true }, "GenderId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Contact's gender", "nullable": true }, "IconAttachmentId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The attachment to use as a Contact's profile picture.", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "InstantAddresses_AIM": { "allOf": [ { "$ref": "#/components/schemas/RetrieveInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "InstantAddresses_FacebookChat": { "allOf": [ { "$ref": "#/components/schemas/RetrieveInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "InstantAddresses_FaceTime": { "allOf": [ { "$ref": "#/components/schemas/RetrieveInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "InstantAddresses_GoogleTalk": { "allOf": [ { "$ref": "#/components/schemas/RetrieveInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "InstantAddresses_ICQ": { "allOf": [ { "$ref": "#/components/schemas/RetrieveInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "InstantAddresses_Other": { "allOf": [ { "$ref": "#/components/schemas/RetrieveInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "InstantAddresses_Skype": { "allOf": [ { "$ref": "#/components/schemas/RetrieveInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "InstantAddresses_Twitter": { "allOf": [ { "$ref": "#/components/schemas/RetrieveInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "InstantAddresses_Yahoo_Msg": { "allOf": [ { "$ref": "#/components/schemas/RetrieveInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "JobClassificationCategoryId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The EEO Field for the Contact's Job Category.", "nullable": true }, "JobClassificationId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The EEO field for this Contact's job classification.", "nullable": true }, "JobTypeIds": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "The type of job this Contact works or is willing to work (\"Full time\", \"Part Time\", \"Hourly\", etc.)", "nullable": true }, "KeyDates_Anniversary": { "allOf": [ { "$ref": "#/components/schemas/RetrieveDates" } ], "description": "A collection of key dates for this Contact (Birthday, Anniversary, etc.)", "nullable": true }, "KeyDates_Birthday": { "allOf": [ { "$ref": "#/components/schemas/RetrieveDates" } ], "description": "A collection of key dates for this Contact (Birthday, Anniversary, etc.)", "nullable": true }, "KeyDates_Other": { "allOf": [ { "$ref": "#/components/schemas/RetrieveDates" } ], "description": "A collection of key dates for this Contact (Birthday, Anniversary, etc.)", "nullable": true }, "LastActionDate": { "type": "string", "description": "The last time there was an action by a Crelate user regarding this Contact, such as creating an activity, sending an email, or moving the Contact to a new stage.", "format": "date-time", "nullable": true }, "LastActivityDate": { "type": "string", "description": "The last date a Contact had a new Activity logged.", "format": "date-time", "nullable": true }, "LastActivityOrModifiedOn": { "type": "string", "description": "The last time this Contact was either modified, or the last time an activity was created for this Contact.", "format": "date-time", "nullable": true }, "LastActivityRegardingId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Job the last Activity logged to the Contact was regarding.", "nullable": true }, "LastEngagementDate": { "type": "string", "description": "The date a Contact was last engaged with by an activity that was marked as engagement.", "format": "date-time", "nullable": true }, "LastEnrichmentDate": { "type": "string", "description": "This is updated with date/time of the latest enrichment attempt, whether the record gets enriched successfully or not", "format": "date-time", "nullable": true }, "LastReachOutBy": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The last user who created a reach out activity for this Contact, such as sending an email, sending a text message, or leaving a voicemail.", "nullable": true }, "LastReachOutDate": { "type": "string", "description": "The last time there was an reach out activity by a Crelate user regarding this Contact, such as sending an email, sending a text message, or leaving a voicemail.", "format": "date-time", "nullable": true }, "LatestPinnedNote": { "type": "string", "description": "The text of the latest pinned Note Activity for the Contact.", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "Name": { "type": "string", "description": "The Contact's full name", "nullable": true }, "Owners": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" }, "description": "Tracks the Crelate user (or users) who owns this Contact record.", "nullable": true }, "PhoneNumbers_Fax": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Home": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Mobile": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Mobile_Other": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Other": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Other_Alternate": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Potential": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Skype": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Work_Direct": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Work_Main": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Work_Other": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PreferredContactMethodTypeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Contact's preferred contact method (Email, Phone, or Text)", "nullable": true }, "PrimaryDocumentAttachmentId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The primary Artifact of the Contact.", "nullable": true }, "RelatedContacts_Assistant": { "allOf": [ { "$ref": "#/components/schemas/RetrieveRelatedContacts" } ], "description": "A collection of other Contacts that are related to the contact (e.g., \"Spouse\", \"Assistant\", \"Referred By\")", "nullable": true }, "RelatedContacts_OtherContact": { "allOf": [ { "$ref": "#/components/schemas/RetrieveRelatedContacts" } ], "description": "A collection of other Contacts that are related to the contact (e.g., \"Spouse\", \"Assistant\", \"Referred By\")", "nullable": true }, "RelatedContacts_ReferredBy": { "allOf": [ { "$ref": "#/components/schemas/RetrieveRelatedContacts" } ], "description": "A collection of other Contacts that are related to the contact (e.g., \"Spouse\", \"Assistant\", \"Referred By\")", "nullable": true }, "RelatedContacts_Spouse": { "allOf": [ { "$ref": "#/components/schemas/RetrieveRelatedContacts" } ], "description": "A collection of other Contacts that are related to the contact (e.g., \"Spouse\", \"Assistant\", \"Referred By\")", "nullable": true }, "Salutation": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Contact's salutation or name prefix (e.g. \"Mr.\", \"Mrs.\", \"Dr.\")", "nullable": true }, "StatusReason": { "type": "string", "description": "An optional text field explaining the reason for the StatusId field.", "nullable": true }, "SuffixId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Contact's suffix (\"Sr.\", \"Jr.\", etc.)", "nullable": true }, "Tags": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" } }, "description": "The tags for the Contact.", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true }, "UserId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user that is associated with this Contact.", "nullable": true }, "VeteranStatus": { "type": "integer", "description": "The VEVRAA field for this Contact's Veteran Status.", "format": "int32", "nullable": true }, "Websites_Blog": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_Business": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_Facebook": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_GitHub": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_LinkedIn": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_Other": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_Other_Alternate": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_Personal": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_Portfolio": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_Quora": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_RSSFeed": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true } }, "additionalProperties": false } ], "description": "The model for retrieving Contacts." }, "RetrieveContactsCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveContacts" } ], "description": "The model for retrieving Contacts.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveContactsListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveContacts" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveCountries": { "type": "object", "properties": { "Alpha2": { "type": "string", "description": "The unique, alphabetical, two-character identifier of the Country.", "nullable": true }, "Alpha3": { "type": "string", "description": "The unique, alphabetical, three-character identifier of the Country.", "nullable": true }, "CallingCode": { "type": "string", "description": "The numeric Country calling code for phone numbers. Always prefixed with +.", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "Name": { "type": "string", "description": "The full name of the Country.", "nullable": true }, "NumericCode": { "type": "integer", "description": "The integer numeric code of the Country.", "format": "int32", "nullable": true }, "SortOrder": { "type": "integer", "description": "The sort order of the Country relative to other Countries.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Countries." }, "RetrieveCountriesCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveCountries" } ], "description": "The model for retrieving Countries.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveCountriesListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveCountries" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveCustomPicklistItems": { "type": "object", "properties": { "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "CustomPicklistSetId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The custom picklist set a picklist item belongs to.", "nullable": true }, "ExternalPrimaryKey": { "type": "string", "description": "The external primary key of a record. Not guaranteed to be globally unique.", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "Value": { "type": "string", "description": "The text value of a picklist item.", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Custom Picklist Items." }, "RetrieveCustomPicklistItemsListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveCustomPicklistItems" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveCustomPicklistSets": { "type": "object", "properties": { "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "ExternalPrimaryKey": { "type": "string", "description": "The external primary key of a record. Not guaranteed to be globally unique.", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "Name": { "type": "string", "description": "The name of a custom picklist set.", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Custom Picklist Sets." }, "RetrieveCustomPicklistSetsCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveCustomPicklistSets" } ], "description": "The model for retrieving Custom Picklist Sets.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveCustomPicklistSetsListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveCustomPicklistSets" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveDates": { "allOf": [ { "$ref": "#/components/schemas/DatesBase" }, { "type": "object", "properties": { "CreatedOnSystem": { "type": "string", "description": "The date a record was created on and recognized by the Crelate system. This cannot be overridden.", "format": "date-time", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true } }, "additionalProperties": false } ], "description": "The model for retrieving Dates." }, "RetrieveEducationTimelineItem": { "required": [ "Id", "IsPrimary" ], "type": "object", "properties": { "AcademicHonorIds": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "Any academic honors achieved.", "nullable": true }, "AccreditationId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The accreditation, or degree, achieved.", "nullable": true }, "AccreditingInstitutionId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The accrediting institution where the accreditation was achieved.", "nullable": true }, "Details": { "type": "string", "description": "Text details or other notes about an education item. Allows some basic HTML.", "nullable": true }, "Id": { "type": "string", "description": "The primary key of an education item.", "format": "uuid" }, "IsPrimary": { "type": "boolean", "description": "Whether an education item is the highest education achieved." }, "WhenEnd": { "type": "string", "description": "The year when education ended.", "format": "date-time", "nullable": true }, "WhenStart": { "type": "string", "description": "The year when education started.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving an Education Timeline Item." }, "RetrieveEmailAddresses": { "allOf": [ { "$ref": "#/components/schemas/EmailAddressesBase" }, { "type": "object", "properties": { "CreatedOnSystem": { "type": "string", "description": "The date a record was created on and recognized by the Crelate system. This cannot be overridden.", "format": "date-time", "nullable": true }, "EmailFlagError": { "type": "string", "nullable": true }, "EmailFlaggedOn": { "type": "string", "format": "date-time", "nullable": true }, "EmailFlagTypeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Determines if this address has been flagged", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true } }, "additionalProperties": false } ], "description": "The model for retrieving EmailAddresses." }, "RetrieveEmails": { "type": "object", "properties": { "BCC": { "type": "string", "description": "The blind carbon copy recipients of an email.", "nullable": true }, "CC": { "type": "string", "description": "The carbon copy recipients of an email.", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "Display": { "type": "string", "description": "Plaintext email content. One of Display or Html may be provided.", "nullable": true }, "EmailAttachmentIds": { "type": "array", "items": { "$ref": "#/components/schemas/LookupAny" }, "description": "The identifiers of any attachment artifacts included with an email.", "nullable": true }, "ExternalPrimaryKey": { "type": "string", "description": "The external primary key of a record. Not guaranteed to be globally unique.", "nullable": true }, "From": { "type": "string", "description": "Who sent an email.", "nullable": true }, "Html": { "type": "string", "description": "HTML email content. One of Display or Html may be provided.", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "ParentId": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "The parent record an email is associated with.", "nullable": true }, "RegardingId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The job an email is regarding.", "nullable": true }, "Subject": { "type": "string", "description": "The subject line of an email.", "nullable": true }, "To": { "type": "string", "description": "Who an email was sent to.", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true }, "VerbId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Specifies the Activity Type of the record, which controls its behavior and available functionality.", "nullable": true }, "When": { "type": "string", "format": "date-time", "nullable": true }, "WhoAttendeeIds": { "type": "array", "items": { "$ref": "#/components/schemas/LookupAny" }, "description": "Recipients of an email sent by a user or by Crelate on behalf of a user.", "nullable": true }, "WhoBccIds": { "type": "array", "items": { "$ref": "#/components/schemas/LookupAny" }, "description": "Blind carbon copy recipients of an email sent by a user or by Crelate on behalf of a user.", "nullable": true }, "WhoCcIds": { "type": "array", "items": { "$ref": "#/components/schemas/LookupAny" }, "description": "Carbon copy recipients of an email sent by a user or by Crelate on behalf of a user.", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Email activities." }, "RetrieveEmailsCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveEmails" } ], "description": "The model for retrieving Email activities.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveEmailsListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveEmails" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveExpenseTypes": { "type": "object", "properties": { "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "DefaultRate": { "type": "number", "description": "The default rate of the Expense Type. Used when the type of the Expense Type is Quantity.", "format": "double", "nullable": true }, "Description": { "type": "string", "description": "The entity that contains settings and meanings for time cards and derived entities.", "nullable": true }, "EntityStatus": { "type": "integer", "description": "The entity that contains settings and meanings for expenses and derived entities.", "format": "int32", "nullable": true }, "ExpenseType": { "allOf": [ { "$ref": "#/components/schemas/ExpenseTypeType" } ], "description": "The type of expenses, such as amount- or quantity-based, using this Expense Type.\n\n0 = Unknown\n\n1 = Amount\n\n2 = Quantity", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "IsBillable": { "type": "boolean", "description": "Indicates if the Expense Type creates a Billable Item.", "nullable": true }, "IsPayable": { "type": "boolean", "description": "Indicates if the Expense Type creates a Payable Item.", "nullable": true }, "MeaningId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The underlying meaning for the Expense Type.", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "Name": { "type": "string", "description": "The name of the Expense Type.", "nullable": true }, "ParentExpenseTypeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The parent Expense Type for this Expense Type.", "nullable": true }, "RequiresGeneralNote": { "allOf": [ { "$ref": "#/components/schemas/NoteRequirementOptions" } ], "description": "Enables requiring a general note on an expense.\n\n0 = None\n\n1 = Optional (Optional)\n\n2 = Required (Required)", "nullable": true }, "RequiresNote": { "type": "boolean", "description": "Indicates if the Expense Type requires a note to be finalized.", "nullable": true }, "RequiresReceipt": { "type": "boolean", "description": "Indicates if the Expense Type requires a receipt to be finalized.", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Expense Types." }, "RetrieveExpenseTypesCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveExpenseTypes" } ], "description": "The model for retrieving Expense Types.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveExpenseTypesListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveExpenseTypes" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveForms": { "type": "object", "properties": { "AverageRating": { "type": "number", "description": "The average rating of all questions on a completed scorecard", "format": "float", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "FormDefinitionId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The linked Form Template of the Form.", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "IsComplete": { "type": "boolean", "description": "Whether the Form is complete.", "nullable": true }, "Layout": { "type": "string", "description": "The layout of the Form.", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "Name": { "type": "string", "description": "Name of the form", "nullable": true }, "ParentId": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "This is the entity that the form is ultimately parented by", "nullable": true }, "RegardingId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The job that this form is regarding.", "nullable": true }, "TargetEntityId": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "The entity targeted by a record.", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true }, "Url": { "type": "string", "nullable": true }, "VerbId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "A lookup to a related entity of a single entity type.", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Forms." }, "RetrieveFormsListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveForms" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveInstantAddresses": { "allOf": [ { "$ref": "#/components/schemas/InstantAddressesBase" }, { "type": "object", "properties": { "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true } }, "additionalProperties": false } ], "description": "The model for retrieving InstantAddresses." }, "RetrieveInvoices": { "type": "object", "properties": { "AccountId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Client that this Invoice is for", "nullable": true }, "Balance": { "type": "number", "description": "Current balance of the invoice. Total minus Payments", "format": "double", "nullable": true }, "BalanceChangedOn": { "type": "string", "description": "Post date of the last change to the balance of the invoice", "format": "date-time", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "Credits": { "type": "number", "description": "Total of all other credits on the invoice", "format": "double", "nullable": true }, "Discounts": { "type": "number", "description": "Total of all discounts on the invoice", "format": "double", "nullable": true }, "DueOn": { "type": "string", "description": "Date that this Invoice is due", "format": "date-time", "nullable": true }, "EmployeeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Link to employee if invoices were generated by employee", "nullable": true }, "EntityStatus": { "type": "integer", "description": "Represents the status of an invoice", "format": "int32", "nullable": true }, "ExternalInvoiceId": { "type": "string", "description": "Id of the invoice in the external system it has been sent to (e..g. Xero)", "nullable": true }, "ExternalInvoiceUrl": { "type": "string", "description": "Url to the invoice record in the external system", "nullable": true }, "ExternalSystemName": { "type": "string", "description": "Name of the external system the invoice was sent to (e.g. Xero)", "nullable": true }, "FirstSentById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "User that first sent this invoice", "nullable": true }, "FirstSentOn": { "type": "string", "description": "Time that the Invoice was first sent via Crelate", "format": "date-time", "nullable": true }, "HasError": { "type": "boolean", "description": "If true, this invoice has an error on it", "nullable": true }, "HasUnsentChanges": { "type": "boolean", "description": "If true, this invoice has changes that have not been sent to the user", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "InvoiceDate": { "type": "string", "description": "User set date for the invoice", "format": "date-time", "nullable": true }, "InvoiceNum": { "type": "integer", "description": "If auto-numbering on Invoices is enabled, then an incrementing unique Id number will be assigned to each Invoice. Note: This field will NOT appear on the \"New Invoice\" form.", "format": "int32", "nullable": true }, "IsLate": { "type": "boolean", "description": "Indicates if the invoice is past due.", "nullable": true }, "IsSentToExternal": { "type": "boolean", "description": "Has the invoice been sent to an external provider (e.g. Xero)", "nullable": true }, "JobId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Link to a job if invoices were generated by Job", "nullable": true }, "LastSentById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "User that most recently sent this invoice", "nullable": true }, "LastSentOn": { "type": "string", "description": "Time that the Invoice was last sent via Crelate", "format": "date-time", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "Name": { "type": "string", "description": "Name of invoice that is a concatenation of client and invoice number", "nullable": true }, "Payments": { "type": "number", "description": "Total of all payments recognized on the invoice", "format": "double", "nullable": true }, "PrimaryDocumentAttachmentId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The primary Artifact of the Invoice.", "nullable": true }, "SendToExternalById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who sent the invoice to the external accounting system", "nullable": true }, "SentToExternalOn": { "type": "string", "description": "Date and time when the invoice was sent to an integrated external accounting system", "format": "date-time", "nullable": true }, "Subtotal": { "type": "number", "description": "Subtotal of all billable items on the invoice", "format": "double", "nullable": true }, "Taxes": { "type": "number", "description": "Total of all taxable items on the invoice", "format": "double", "nullable": true }, "TermsOption": { "allOf": [ { "$ref": "#/components/schemas/InvoiceTermsOption" } ], "description": "Determines the terms for a client to fulfill this Invoice\n\n0 = Unknown\n\n1 = UponReceipt\n\n2 = Net15\n\n3 = Net30\n\n4 = Net60\n\n5 = Net90\n\n6 = Net45\n\n7 = Net10", "nullable": true }, "Total": { "type": "number", "description": "Total amount invoiced to the customer", "format": "double", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true }, "VoidDate": { "type": "string", "description": "This is the user set date to recognize the void", "format": "date-time", "nullable": true }, "VoidedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "User that voided this invoice", "nullable": true }, "VoidedOn": { "type": "string", "description": "Date that this invoice was voided", "format": "date-time", "nullable": true }, "WasSent": { "type": "boolean", "description": "If true, the invoice has been sent to the customer", "nullable": true }, "WriteOffs": { "type": "number", "description": "Total of all write offs on the invoice", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Invoices." }, "RetrieveInvoicesCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveInvoices" } ], "description": "The model for retrieving Invoices.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveInvoicesListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveInvoices" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveJobTitles": { "type": "object", "properties": { "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "Title": { "type": "string", "description": "The title of the Job Title.", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Job Titles." }, "RetrieveJobTitlesCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveJobTitles" } ], "description": "The model for retrieving Job Titles.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveJobTitlesListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveJobTitles" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveJobTypes": { "type": "object", "properties": { "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "Name": { "type": "string", "description": "The name of a job type.", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Job Types." }, "RetrieveJobTypesListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveJobTypes" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveJobs": { "allOf": [ { "$ref": "#/components/schemas/JobsBase" }, { "type": "object", "properties": { "AccountId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The company associated with this Job", "nullable": true }, "AccountManagerId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Account manager for the job", "nullable": true }, "AdditionalContacts_Billing": { "allOf": [ { "$ref": "#/components/schemas/RetrieveRelatedContacts" } ], "description": "Contacts related to this Job (Hiring manager, executive sponsor, etc.)", "nullable": true }, "AdditionalContacts_ExecutiveSponsor": { "allOf": [ { "$ref": "#/components/schemas/RetrieveRelatedContacts" } ], "description": "Contacts related to this Job (Hiring manager, executive sponsor, etc.)", "nullable": true }, "AdditionalContacts_HiringManager": { "allOf": [ { "$ref": "#/components/schemas/RetrieveRelatedContacts" } ], "description": "Contacts related to this Job (Hiring manager, executive sponsor, etc.)", "nullable": true }, "AdditionalContacts_InternalRecruiter": { "allOf": [ { "$ref": "#/components/schemas/RetrieveRelatedContacts" } ], "description": "Contacts related to this Job (Hiring manager, executive sponsor, etc.)", "nullable": true }, "AdditionalContacts_OtherContact": { "allOf": [ { "$ref": "#/components/schemas/RetrieveRelatedContacts" } ], "description": "Contacts related to this Job (Hiring manager, executive sponsor, etc.)", "nullable": true }, "AdditionalContacts_Sales_ClientContact": { "allOf": [ { "$ref": "#/components/schemas/RetrieveRelatedContacts" } ], "description": "Contacts related to this Job (Hiring manager, executive sponsor, etc.)", "nullable": true }, "AvailableDeliveryTypes": { "type": "array", "items": { "$ref": "#/components/schemas/LookupAny" }, "description": "The available delivery types for this Job.", "nullable": true }, "ClosedOn": { "type": "string", "description": "The date the Job was closed on.", "format": "date-time", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "CustomField31": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField32": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField33": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField34": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField35": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField36": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField37": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField38": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField39": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField40": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField71": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField72": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField73": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField74": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField75": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField76": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField77": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField78": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField79": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField80": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "DefaultWorksiteId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Location of the Job and the default location for all assignments", "nullable": true }, "EmploymentSearchContactId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The parent contact record for this employment search", "nullable": true }, "ExpectedValue": { "type": "number", "description": "Expected value is the total potential value of the Job multiplied by the probability of a win.", "format": "double", "nullable": true }, "ExternalEmailAddress": { "type": "string", "description": "A unique email address specific to the Job.", "nullable": true }, "HiringManagerId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Hiring manager for the Job. The person responsible for communicating with the agency.", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "InactiveDeliveryTypes": { "type": "array", "items": { "$ref": "#/components/schemas/LookupAny" }, "description": "The delivery types that are on the Job but cannot be used to create a delivery item.", "nullable": true }, "IsFeatured": { "type": "boolean", "description": "This field is obsolete and will be removed in a future release. Use PortalVisibility instead.", "nullable": true }, "IsHidden": { "type": "boolean", "description": "This field is obsolete and will be removed in a future release. Use PortalVisibility instead.", "nullable": true }, "IsLead": { "type": "boolean", "description": "Indicates that this Job is still a lead.", "nullable": true }, "IsPublishedToFreeBoards": { "type": "boolean", "description": "Whether the Job is published to free job boards.", "nullable": true }, "JobCode": { "type": "string", "description": "The unique code for identifying the Job", "nullable": true }, "JobNum": { "type": "integer", "description": "If auto-numbering on Jobs is enabled, then an incrementing unique id number will be assigned to each Job. Note: this field will NOT appear on the \"New Job\" form.", "format": "int32", "nullable": true }, "JobTitleId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The job title or short description for this Job.", "nullable": true }, "JobTypeIds": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "The type of job (Full time, Part time, Hourly, etc.)", "nullable": true }, "LastActionDate": { "type": "string", "description": "The last time there was an action by a Crelate user regarding this Job, such as creating an activity, sending an email, or moving the Job to a new stage.", "format": "date-time", "nullable": true }, "LastActivityDate": { "type": "string", "description": "The last date a Job had a new Activity logged.", "format": "date-time", "nullable": true }, "LastActivityOrModifiedOn": { "type": "string", "description": "The last time this Job was either modified, or the last time an activity was created for this Job.", "format": "date-time", "nullable": true }, "LastEngagementDate": { "type": "string", "description": "The last date a Job had a new Activity categorized as engagement logged.", "format": "date-time", "nullable": true }, "LastReachOutDate": { "type": "string", "description": "The last date a Job had a new Activity categorized as a reach-out logged.", "format": "date-time", "nullable": true }, "LeadSourceId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The standardized Lead Source of the Job.", "nullable": true }, "Locations_Business": { "allOf": [ { "$ref": "#/components/schemas/RetrieveAddresses" } ], "description": "The location where this Job is available", "nullable": true }, "Locations_Other": { "allOf": [ { "$ref": "#/components/schemas/RetrieveAddresses" } ], "description": "The location where this Job is available", "nullable": true }, "LossReasonTypeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The reason the opportunity was lost", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date that this Job was last modified", "format": "date-time", "nullable": true }, "OnPortal": { "type": "boolean", "description": "Whether a Job is on the Job Portal.", "nullable": true }, "OpportunityTypeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The type of opportunity (e.g., Job, Project)", "nullable": true }, "Owners": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" }, "description": "The owners of this Job record", "nullable": true }, "ParentJobId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The linked parent Job of the Job.", "nullable": true }, "PortalCity": { "type": "string", "description": "The city of the location to list on external postings, including the Crelate Job Portal, for the Job.", "nullable": true }, "PortalCompanyName": { "type": "string", "description": "The company name to list on external postings, including the Crelate Job Portal, for the Job.", "nullable": true }, "PortalCompensation": { "type": "string", "description": "The compensation to list on external postings, including the Crelate Job Portal, for the Job.", "nullable": true }, "PortalCompensationMaximum": { "type": "number", "description": "Maximum Compensation for Job", "format": "double", "nullable": true }, "PortalCompensationMinimum": { "type": "number", "description": "Minimum Compensation for Job", "format": "double", "nullable": true }, "PortalCountryId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The standardized country of the location to list on external postings, including the Crelate Job Portal, for the Job.", "nullable": true }, "PortalDescription": { "type": "string", "description": "The description of the Job for external postings, including the Crelate Job Portal.", "nullable": true }, "PortalLastPostedOn": { "type": "string", "description": "The date the Job was last posted to the Job Portal.", "format": "date-time", "nullable": true }, "PortalState": { "type": "string", "description": "The state or province of the location to list on external postings, including the Crelate Job Portal, for the Job.", "nullable": true }, "PortalStreetAddress": { "type": "string", "description": "The street address for a jobs portal posting", "nullable": true }, "PortalTitle": { "type": "string", "description": "The Job title to list on external postings, including the Crelate Job Portal.", "nullable": true }, "PortalUrlSlug": { "type": "string", "description": "A human-readable string of text to include in the Crelate Job Portal URL generated for each published Job.", "nullable": true }, "PortalVisibility": { "type": "integer", "description": "Determines the visibility of the Job on the Portal. Possible values are - 0 = Shown, 1 = Featured, 2 = Hidden", "format": "int32", "nullable": true }, "PortalZip": { "type": "string", "description": "The ZIP or postal code of the location to list on external postings, including the Crelate Job Portal, for the Job.", "nullable": true }, "PrimaryDocumentAttachmentId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The primary Artifact of the Job.", "nullable": true }, "PriorityId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The priority of the Job (e.g., Cold, Medium, Hot)", "nullable": true }, "PublishedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Id of the user that published this Job.", "nullable": true }, "PublishedToFreeBoardsOn": { "type": "string", "description": "The date the Job was last published to free job boards.", "format": "date-time", "nullable": true }, "RecruiterId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The id of the primary recruiter for this job", "nullable": true }, "SalesWorkflowItemStatusId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The stage that this Job is in on the Sales board", "nullable": true }, "SecondaryRecruiterId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "An additional Recruiter working on this Job alongside the primary Recruiter.", "nullable": true }, "SourcerId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Sourcer for the job", "nullable": true }, "Tags": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" } }, "description": "Tags for the Job.", "nullable": true }, "TimeCardApproverId": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "The time keeping approver for this job.", "nullable": true }, "TimeEntryFormat": { "allOf": [ { "$ref": "#/components/schemas/TimeEntryFormat" } ], "description": "The type of time entry for Time Keeping information.", "nullable": true }, "TimeToClose": { "type": "number", "description": "Number of days between open date and close date. This field is automatically calculated and is not editable, and will not be displayed on the form when creating new records.", "format": "float", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true }, "UserCloseDate": { "type": "string", "description": "Date when the Job becomes Closed or no longer available", "format": "date-time", "nullable": true }, "UserOpenDate": { "type": "string", "description": "Date when the Job becomes Open", "format": "date-time", "nullable": true }, "Websites_Description": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "Website addresses or URLs associated with this Job", "nullable": true }, "Websites_Other": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUrls" } ], "description": "Website addresses or URLs associated with this Job", "nullable": true }, "WorkflowTypeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The type of workflow (e.g., Recruiting or EmploymentSearch)", "nullable": true } }, "additionalProperties": false } ], "description": "The model for retrieving Jobs." }, "RetrieveJobsCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveJobs" } ], "description": "The model for retrieving Jobs.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveJobsListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveJobs" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveLedgerAccounts": { "type": "object", "properties": { "AccountTypeOption": { "type": "integer", "description": "Determines the type of Ledger Account", "format": "int32", "nullable": true }, "Code": { "type": "string", "description": "Code to identify the Ledger Account. Generally a number, but could include other alpha characters", "nullable": true }, "ContraAccountTypeOption": { "type": "integer", "description": "If the Account Type is a Contra Account, this is the account that is is Contra of", "format": "int32", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "Name": { "type": "string", "description": "Name of the Ledger Account", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Ledger Accounts." }, "RetrieveLedgerAccountsListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveLedgerAccounts" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveLedgers": { "type": "object", "properties": { "AccountId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Account for this line item", "nullable": true }, "BatchTransactionKey": { "type": "string", "description": "Unique Id for the transaction that created this ledger item", "nullable": true }, "BillableItemId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Billable Item related to this transaction", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "Credit": { "type": "number", "description": "Credit value for this Ledger Item", "format": "double", "nullable": true }, "Debit": { "type": "number", "description": "Debit value for this Ledger Item", "format": "double", "nullable": true }, "DeliveryTypeId": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "The delivery type for this ledger item", "nullable": true }, "EmployeeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Employee related to this transaction", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "InvoiceId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Invoice related to this transaction", "nullable": true }, "JobId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Job related to this transaction", "nullable": true }, "LedgerAccountId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Ledger Account related to this transaction", "nullable": true }, "LedgerDate": { "type": "string", "description": "This is the date time that the event occurred to enter the ledger, but not the transaction date", "format": "date-time", "nullable": true }, "LedgerEventOption": { "type": "integer", "description": "Describes the event for this ledger item", "format": "int32", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "PaymentId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Payment related to this transaction", "nullable": true }, "TransactionDate": { "type": "string", "description": "Date and time of the transaction that created this ledger item", "format": "date-time", "nullable": true }, "TransactionKey": { "type": "string", "description": "A unique timestamp that serves to group ledger items as part of the same debit and credit group", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Ledgers." }, "RetrieveLedgersListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveLedgers" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveLossReasonTypes": { "type": "object", "properties": { "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true }, "Value": { "type": "string", "description": "The name of the loss reason type.", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Loss Reason Types." }, "RetrieveLossReasonTypesCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveLossReasonTypes" } ], "description": "The model for retrieving Loss Reason Types.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveLossReasonTypesListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveLossReasonTypes" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveLosses": { "type": "object", "properties": { "CompetitorId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The linked competitor Company to whom a Job Opportunity or Lead was lost.", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "CustomField1": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField10": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField11": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField12": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField13": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField14": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField15": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField16": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField17": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField18": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField19": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField2": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField20": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField21": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField22": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField23": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField24": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField25": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField26": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField27": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField28": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField29": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField3": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField30": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField31": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField32": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField33": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField34": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField35": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField36": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField37": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField38": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField39": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField4": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField40": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField41": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField42": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField43": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField44": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField45": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField46": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField47": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField48": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField49": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField5": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField50": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField51": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField52": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField53": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField54": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField55": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField56": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField57": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField58": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField59": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField6": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField60": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField61": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField62": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField63": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField64": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField65": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField66": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField67": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField68": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField69": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField7": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField70": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField71": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField72": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField73": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField74": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField75": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField76": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField77": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField78": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField79": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField8": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField80": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField9": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomFields": { "type": "object", "additionalProperties": { }, "description": "A property bag for custom fields, keyed by logical name.", "nullable": true }, "Description": { "type": "string", "description": "The description of a Loss.", "nullable": true }, "ExperienceId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The linked Activity representing the Loss.", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "JobId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The lost opportunity", "nullable": true }, "LossReasonTypeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The standardized type of Loss that occurred for the Loss.", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true }, "When": { "type": "string", "description": "The date of the Loss.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Losses." }, "RetrieveLossesCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveLosses" } ], "description": "The model for retrieving Losses.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveLossesListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveLosses" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveMeanings": { "type": "object", "properties": { "AllowContactOption": { "type": "integer", "description": "Determines the level of contact a user can have with the record", "format": "int32", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "Name": { "type": "string", "nullable": true }, "Order": { "type": "integer", "format": "int32", "nullable": true }, "StyleOption": { "type": "integer", "description": "Describe how the associated record will be styled in the app", "format": "int32", "nullable": true }, "Value": { "type": "integer", "format": "int32", "nullable": true }, "VisibilityOption": { "type": "integer", "description": "Describes the associated record's visibility in the app", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Meanings." }, "RetrieveMeaningsListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveMeanings" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveNotes": { "type": "object", "properties": { "Announced": { "type": "boolean", "description": "Whether a note is announced.", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "CreatedOnSystem": { "type": "string", "description": "The date a record was created on and recognized by the Crelate system. This cannot be overridden.", "format": "date-time", "nullable": true }, "Display": { "type": "string", "description": "Plaintext note content.", "nullable": true }, "ExternalPrimaryKey": { "type": "string", "description": "The external primary key of a record. Not guaranteed to be globally unique.", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "IsEngagement": { "type": "boolean", "description": "Whether a note constitutes any form of engagement.", "nullable": true }, "IsReachOut": { "type": "boolean", "description": "Whether a note constitutes any form of a reach-out.", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "Owners": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" }, "description": "The Crelate user, or users, who owns a record.", "nullable": true }, "ParentId": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "The parent record a note is associated with.", "nullable": true }, "Pinned": { "type": "boolean", "description": "Whether the Activity is pinned to the top of its parent record's activity stream.", "nullable": true }, "RegardingId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The job a note is regarding.", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true }, "When": { "type": "string", "description": "The date a note was created. Defaults to creation timestamp if omitted.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Note activities." }, "RetrieveNotesCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveNotes" } ], "description": "The model for retrieving Note activities.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveNotesListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveNotes" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveOpportunityTypes": { "type": "object", "properties": { "CollectionOfTypeIds": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "The allowed types for opportunity types that are a collection type", "nullable": true }, "Color": { "type": "string", "description": "The hex RGB color of an opportunity type.", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user that created an opportunity type.", "nullable": true }, "CreatedOn": { "type": "string", "description": "When an opportunity type was created.", "format": "date-time", "nullable": true }, "DefaultExpenseTypeIds": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "Expense Types that will be available when a job valid for Time Keeping is created.", "nullable": true }, "DefaultTimeEntryFormat": { "allOf": [ { "$ref": "#/components/schemas/TimeEntryFormat" } ], "description": "The default Time Entry Format that is used on opportunity creation. This field is only valid for Temp Jobs. All other jobs will default to 0.\n\n0 = None\n\n1 = Straight (Straight Time)\n\n2 = Pipo (Punch In/Punch Out)", "nullable": true }, "DefaultTimeTypeIds": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "Time Types that will be made available when a job valid for Time Keeping is created.", "nullable": true }, "Description": { "type": "string", "description": "The description of an opportunity type.", "nullable": true }, "Icon": { "type": "string", "description": "The icon identifier used to render an icon associated with an opportunity type.", "nullable": true }, "Id": { "type": "string", "description": "The unique identifier of an opportunity type.", "format": "uuid", "nullable": true }, "IsChildOnly": { "type": "boolean", "description": "Whether an opportunity type is only available as a child and cannot have child opportunities underneath it.", "nullable": true }, "IsCollectionType": { "type": "boolean", "description": "Whether an opportunity type is a collection type; for example, a Project.", "nullable": true }, "IsDefault": { "type": "boolean", "description": "Whether an opportunity type is the default opportunity type when creating a new opportunity.", "nullable": true }, "IsEnabled": { "type": "boolean", "description": "Whether an opportunity type is enabled within Crelate. Opportunities cannot be created for inactive opportunity types.", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The last date an opportunity type was modified.", "format": "date-time", "nullable": true }, "Name": { "type": "string", "description": "The name of an opportunity type.", "nullable": true }, "PlacementStatusId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Specified what entity status to use by default for this opportunity type", "nullable": true }, "PluralName": { "type": "string", "description": "The plural form of the name of an opportunity type.", "nullable": true }, "RecruitingType": { "allOf": [ { "$ref": "#/components/schemas/OpportunityRecruitingType" } ], "description": "The type of recruiting this opportunity type supports\n\n0 = Custom\n\n1 = DirectHire\n\n2 = Temp", "nullable": true }, "SortOrder": { "type": "integer", "description": "The order in which to display an opportunity type in a list of opportunity types.", "format": "int32", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Who updated an opportunity type last.", "nullable": true }, "ValueMode": { "allOf": [ { "$ref": "#/components/schemas/OpportunityTypeValueModes" } ], "description": "Determines how value is calculated for opportunities of this type\n\n0 = Basic\n\n1 = SumChildJobs\n\n2 = FeeBased\n\n3 = Hourly\n\n4 = Custom", "nullable": true }, "WorkflowTypeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The type of workflow associated with an opportunity type, such as recruiting or employment search.", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Opportunity Types." }, "RetrieveOpportunityTypesCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveOpportunityTypes" } ], "description": "The model for retrieving Opportunity Types.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveOpportunityTypesListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveOpportunityTypes" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveOptions": { "required": [ "DisableIndexingOptions", "TotalCount", "UnmaskValues" ], "type": "object", "properties": { "Fields": { "type": "array", "items": { "type": "string" }, "description": "A list of attributes to return in the result. This value may be provided in either the request body or the query string (as a comma-separated list and/or repeated `fields` keys), but not both.", "nullable": true, "example": [ "Id", "FirstName", "AccountId" ] }, "FilterOperator": { "type": "string", "description": "The logical operator to use when combining filters. Supported values are: `and`, `or`. Only one value may be specified; the default value is `and` if not specified. This value may be provided in either the request body or the query string, but not both.", "nullable": true, "example": "or" }, "TotalCount": { "type": "boolean", "description": "If true, return the total number of records for the current query. This value is ignored when paging past the first page of records. To page records, we recommend inspecting the Links collection in the response instead of relying on this value in each response. This value may also be provided in the query string; a query string value takes precedence over the request body.", "example": true }, "UnmaskValues": { "type": "boolean", "description": "If true and the user has permission, unmask any requested masked fields. This value may also be provided in the query string; a query string value takes precedence over the request body." } }, "additionalProperties": false, "description": "Options for retrieve operations against the API" }, "RetrieveOrganizations": { "type": "object", "properties": { "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "DisplayName": { "type": "string", "description": "The display name of the Organization.", "nullable": true }, "Name": { "type": "string", "description": "The unique name that identifies the Organization.", "nullable": true }, "TimezoneId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The standardized default time zone of the Organization.", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Organizations." }, "RetrieveOrganizationsCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveOrganizations" } ], "description": "The model for retrieving Organizations.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrievePassReasonTypes": { "type": "object", "properties": { "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true }, "Value": { "type": "string", "description": "The display value of the Pass Reason Type.", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Pass Reason Types." }, "RetrievePassReasonTypesCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrievePassReasonTypes" } ], "description": "The model for retrieving Pass Reason Types.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrievePassReasonTypesListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrievePassReasonTypes" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrievePayments": { "type": "object", "properties": { "AccountId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Link to the account that this payment is for", "nullable": true }, "Amount": { "type": "number", "description": "Total amount of the payment", "format": "double", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "DebitAccountId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Ledger account to debit", "nullable": true }, "ExternalId": { "type": "string", "description": "Value used to identify the payment like check id", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "PaymentMethodOption": { "allOf": [ { "$ref": "#/components/schemas/PaymentMethodOption" } ], "description": "Payment method used\n\n0 = Unknown\n\n1 = ACH\n\n2 = Cash\n\n3 = Check\n\n4 = CreditCard\n\n50 = ZeroAmount\n\n51 = Other", "nullable": true }, "PaymentNum": { "type": "integer", "description": "Id for this Payment", "format": "int32", "nullable": true }, "PaymentTypeOption": { "allOf": [ { "$ref": "#/components/schemas/PaymentTypeOption" } ], "description": "Determines the type of payment. Most will be normal payments\n\n0 = Normal\n\n1 = ZeroAmount", "nullable": true }, "ReceivedOn": { "type": "string", "description": "Time that the payment was recognized", "format": "date-time", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Payments." }, "RetrievePaymentsListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrievePayments" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrievePhoneNumbers": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumbersBase" }, { "type": "object", "properties": { "CreatedOnSystem": { "type": "string", "description": "The date a record was created on and recognized by the Crelate system. This cannot be overridden.", "format": "date-time", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "PhoneFlaggedOn": { "type": "string", "description": "The date a Phone Number was flagged as problematic or invalid.", "format": "date-time", "nullable": true }, "PhoneFlagTypeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The flag value of an invalid or problematic Phone Number.", "nullable": true } }, "additionalProperties": false } ], "description": "The model for retrieving PhoneNumbers." }, "RetrievePlacements": { "type": "object", "properties": { "AccountId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The linked Company the Placement is related to.", "nullable": true }, "AdditionalDetails": { "type": "string", "description": "Additional details or notes about the placement", "nullable": true }, "Addresses_Business": { "allOf": [ { "$ref": "#/components/schemas/RetrieveAddresses" } ], "description": "The addresses of the Placement.", "nullable": true }, "BillDate": { "type": "string", "description": "The bill date of the Placement.", "format": "date-time", "nullable": true }, "BillRate": { "type": "number", "description": "The bill rate of the Placement.", "format": "double", "nullable": true }, "Bonus": { "type": "number", "description": "The flat monetary bonus of the Placement.", "format": "double", "nullable": true }, "BurdenRate": { "type": "number", "description": "A monetary amount used to calculate the total cost of hiring and maintaining an employee beyond their direct compensation in wages", "format": "double", "nullable": true }, "BurdenRatePercentage": { "type": "number", "description": "The percentage used to calculate the total cost of hiring and maintaining an employee beyond their direct compensation in wages", "format": "double", "nullable": true }, "CandidateSourceId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The standardized Contact Source of the Placement.", "nullable": true }, "Commission": { "type": "number", "description": "The commission monetary amount of the Placement.", "format": "double", "nullable": true }, "Costs": { "type": "number", "description": "The costs associated with the Placement.", "format": "double", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "CustomField1": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField10": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField11": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField12": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField13": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField14": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField15": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField16": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField17": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField18": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField19": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField2": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField20": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField21": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField22": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField23": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField24": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField25": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField26": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField27": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField28": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField29": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField3": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField30": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField31": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField32": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField33": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField34": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField35": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField36": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField37": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField38": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField39": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField4": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField40": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField41": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField42": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField43": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField44": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField45": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField46": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField47": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField48": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField49": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField5": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField50": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField51": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField52": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField53": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField54": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField55": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField56": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField57": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField58": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField59": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField6": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField60": { "type": "number", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "double", "nullable": true }, "CustomField61": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField62": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField63": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField64": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField65": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField66": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField67": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField68": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField69": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField7": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField70": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "format": "date-time", "nullable": true }, "CustomField71": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField72": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField73": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField74": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField75": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField76": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField77": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField78": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField79": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField8": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField80": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField9": { "type": "string", "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomFields": { "type": "object", "additionalProperties": { }, "description": "A property bag for custom fields, keyed by logical name.", "nullable": true }, "Discount": { "type": "number", "description": "The discount applied to the Placement.", "format": "double", "nullable": true }, "Duration": { "type": "integer", "description": "Estimated duration for the assignment", "format": "int32", "nullable": true }, "EndDate": { "type": "string", "description": "The end date of the Placement.", "format": "date-time", "nullable": true }, "EndingReason": { "type": "integer", "description": "General reason why the placement ended", "format": "int32", "nullable": true }, "EndingReasonDescription": { "type": "string", "description": "A detailed description of why a placement was ended", "nullable": true }, "EntityStatus": { "type": "integer", "description": "The status of a record.", "format": "int32", "nullable": true }, "EstimatedEndDate": { "type": "string", "description": "Estimated end date for the placement", "format": "date-time", "nullable": true }, "ExperienceId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The linked Activity of the Placement.", "nullable": true }, "ExternalPrimaryKey": { "type": "string", "description": "The external primary key of a record. Not guaranteed to be globally unique.", "nullable": true }, "Fee": { "type": "number", "description": "The flat monetary fee of the Placement.", "format": "double", "nullable": true }, "FeePercent": { "type": "number", "description": "The percentage-based fee of the Placement.", "format": "double", "nullable": true }, "HourlyRate": { "type": "number", "description": "The hourly rate of the placed worker of the Placement.", "format": "double", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "JobOpenDate": { "type": "string", "description": "The date that the Job (or opportunity) was originally opened", "format": "date-time", "nullable": true }, "JobSchedule": { "type": "string", "description": "A description of the work schedule for the placement", "nullable": true }, "JobTitleId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The standardized Job Title of the Placement.", "nullable": true }, "LeadSourceId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The standardized Lead Source of the Placement.", "nullable": true }, "Margin": { "type": "number", "description": "The flat monetary margin of the Placement.", "format": "double", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "Name": { "type": "string", "description": "Calculated name field for Placement in the format of \"contact_name @ job_name\"", "nullable": true }, "OpportunityTypeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Opportunity Type of the regarding Job of the Placement.", "nullable": true }, "OTBillRate": { "type": "number", "description": "Overtime bill rate", "format": "double", "nullable": true }, "OTBillRateMultiplier": { "type": "number", "description": "Overtime bill rate multiplier. Can be used to calculate overtime bill rate", "format": "double", "nullable": true }, "OTPayRate": { "type": "number", "description": "Overtime pay rate, may be calculated based on overtime rate multiplier or a flat rate", "format": "double", "nullable": true }, "OTPayRateMultiplier": { "type": "number", "description": "Used to calculate overtime pay", "format": "double", "nullable": true }, "Owners": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" }, "description": "The Crelate user, or users, who owns a record.", "nullable": true }, "PayRate": { "type": "number", "description": "Pay rate for this Placement can be hourly or salary depending on the PayRateType.", "format": "double", "nullable": true }, "PayRateType": { "type": "integer", "description": "Determines if PayRate is hourly or salary.", "format": "int32", "nullable": true }, "PlacedContactId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The linked Contact of the Placement.", "nullable": true }, "PlacementNum": { "type": "integer", "description": "An auto-generated unique ID number for each placement", "format": "int32", "nullable": true }, "PrimaryDocumentAttachmentId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The primary Artifact of the Placement.", "nullable": true }, "RegardingId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Job the Placement is regarding.", "nullable": true }, "Salary": { "type": "number", "description": "The flat monetary salary of the placed worker of the Placement.", "format": "double", "nullable": true }, "SecondaryRecruiterId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The id of the secondary recruiter for this placement", "nullable": true }, "Shift": { "type": "integer", "description": "General description of the work schedule", "format": "int32", "nullable": true }, "StartDate": { "type": "string", "description": "The start date of the Placement.", "format": "date-time", "nullable": true }, "StatusReason": { "type": "string", "description": "An optional text field explaining the reason for the StatusId field.", "nullable": true }, "TimeToFill": { "type": "number", "description": "The time from open to filled (but not necessarily closed) of the Placement.", "format": "float", "nullable": true }, "TotalHours": { "type": "number", "description": "The total hours to be worked for the Placement.", "format": "float", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true }, "UserId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user that is associated with this placement", "nullable": true }, "Value": { "type": "number", "description": "The real monetary value of the Placement.", "format": "double", "nullable": true }, "VerbId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Activity Type of the Placement.", "nullable": true }, "WarrantyDate": { "type": "string", "description": "The warranty date of the Placement.", "format": "date-time", "nullable": true }, "When": { "type": "string", "description": "The date when the Placement occurred.", "format": "date-time", "nullable": true }, "WorksiteId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Location of the assignment", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Placements." }, "RetrievePlacementsCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrievePlacements" } ], "description": "The model for retrieving Placements.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrievePlacementsListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrievePlacements" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveRelatedContacts": { "allOf": [ { "$ref": "#/components/schemas/RelatedContactsBase" }, { "type": "object", "properties": { "CreatedOnSystem": { "type": "string", "description": "The date a record was created on and recognized by the Crelate system. This cannot be overridden.", "format": "date-time", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "Value": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "A lookup to a related entity of a single entity type within a set of allowed entity types.", "nullable": true } }, "additionalProperties": false } ], "description": "The model for retrieving Related Contacts." }, "RetrieveTagCategories": { "allOf": [ { "$ref": "#/components/schemas/TagCategoriesBase" }, { "type": "object", "properties": { "AllowedEntityTypes": { "type": "array", "items": { "type": "string" }, "description": "The type(s) of entities a tag category is allowed on.", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "TagCount": { "type": "integer", "description": "The number of tags in a tag category.", "format": "int32", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true } }, "additionalProperties": false } ], "description": "The model for retrieving Tag Categories." }, "RetrieveTagCategoriesCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveTagCategories" } ], "description": "The model for retrieving Tag Categories.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveTagCategoriesListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveTagCategories" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveTags": { "allOf": [ { "$ref": "#/components/schemas/TagsBase" }, { "type": "object", "properties": { "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "TagCategoryId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The tag category of a tag. This is null for tags with no category.", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true } }, "additionalProperties": false } ], "description": "The model for retrieving Tags." }, "RetrieveTagsCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveTags" } ], "description": "The model for retrieving Tags.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveTagsListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveTags" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveTasks": { "type": "object", "properties": { "Announced": { "type": "boolean", "description": "Whether a task is announced.", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "CreatedOnSystem": { "type": "string", "description": "The date a record was created on and recognized by the Crelate system. This cannot be overridden.", "format": "date-time", "nullable": true }, "Display": { "type": "string", "description": "Free-form plaintext information about a task such as notes, reminders, or outcome of a task.", "nullable": true }, "ExternalPrimaryKey": { "type": "string", "description": "The external primary key of a record. Not guaranteed to be globally unique.", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "Owners": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" }, "description": "The Crelate user, or users, who owns a record.", "nullable": true }, "ParentId": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "The parent record a task is associated with.", "nullable": true }, "Pinned": { "type": "boolean", "description": "Whether the Activity is pinned to the top of its parent record's activity stream.", "nullable": true }, "RegardingId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The job a task is regarding.", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true }, "When": { "type": "string", "description": "For a scheduled task, when it occurs in UTC time.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Note activities." }, "RetrieveTasksCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveTasks" } ], "description": "The model for retrieving Note activities.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveTasksListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveTasks" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveTimeTypes": { "type": "object", "properties": { "BillableOvertimeEligible": { "type": "boolean", "description": "Determines if the time type is eligible for overtime on billable items", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "Description": { "type": "string", "description": "The description of this Time Type.", "nullable": true }, "EntityStatus": { "type": "integer", "description": "The status for this Time Type.", "format": "int32", "nullable": true }, "IsBillable": { "type": "boolean", "description": "Indicates if the Time Type creates a Billable Item.", "nullable": true }, "IsPayable": { "type": "boolean", "description": "Indicates if the Time Type creates a Payable Item.", "nullable": true }, "LegacyMeaningId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The previous meaning prior to a migration", "nullable": true }, "MeaningId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The underlying meaning for the Time Type.", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "Name": { "type": "string", "description": "The name of the Time Type.", "nullable": true }, "ParentTimeTypeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The parent Time Type for this Time Type.", "nullable": true }, "PayableOvertimeEligible": { "type": "boolean", "description": "Determines if the time type is eligible for overtime on payable items", "nullable": true }, "RequiresDailyNote": { "allOf": [ { "$ref": "#/components/schemas/NoteRequirementOptions" } ], "description": "Enables requiring daily notes on all time entries on a Time Card.\n\n0 = None\n\n1 = Optional (Optional)\n\n2 = Required (Required)", "nullable": true }, "RequiresGeneralNote": { "allOf": [ { "$ref": "#/components/schemas/NoteRequirementOptions" } ], "description": "Enables requiring a general note on a Time Card.\n\n0 = None\n\n1 = Optional (Optional)\n\n2 = Required (Required)", "nullable": true }, "RequiresNote": { "type": "boolean", "description": "Indicates if the Time Type requires a note.", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Time Types." }, "RetrieveTimeTypesCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveTimeTypes" } ], "description": "The model for retrieving Time Types.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveTimeTypesListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveTimeTypes" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveUrls": { "allOf": [ { "$ref": "#/components/schemas/UrlsBase" }, { "type": "object", "properties": { "CreatedOnSystem": { "type": "string", "description": "The date a record was created on and recognized by the Crelate system. This cannot be overridden.", "format": "date-time", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true } }, "additionalProperties": false } ], "description": "The model for retrieving Urls." }, "RetrieveUsers": { "type": "object", "properties": { "Color": { "type": "string", "description": "The hex color code to represent this user with, including the pound sign.", "nullable": true }, "CompensationType": { "type": "integer", "description": "Method of paying an employee for their services", "format": "int32", "nullable": true }, "ContactId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The contact this user is linked to.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "Email": { "type": "string", "description": "The email of the Crelate User.", "nullable": true }, "FirstName": { "type": "string", "description": "The first name of the Crelate User.", "nullable": true }, "FullName": { "type": "string", "description": "The full name of the Crelate User. This field is calculated and read-only.", "nullable": true }, "IconAttachmentId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Artifact shown as the icon for the Crelate User.", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "Initials": { "type": "string", "description": "An abbreviated name to show when space for the full name is not available in a user interface.", "nullable": true }, "LanguageCode": { "type": "string", "description": "Language", "nullable": true }, "LastName": { "type": "string", "description": "The last name of the Crelate User.", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "PayrollOnboardStatus": { "type": "integer", "description": "Represents the state of the user during payroll onboarding.", "format": "int32", "nullable": true }, "PayrollOnboardStatusReason": { "type": "string", "description": "Text displaying the various states of the onboarding status.", "nullable": true }, "PrimaryWorksiteId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The primary worksite for the user", "nullable": true }, "TimeZoneId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The preferred time zone of the Crelate User.", "nullable": true }, "UserStateId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user state of the Crelate User.", "nullable": true }, "UserTypeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user type of the Crelate User.", "nullable": true }, "WorkerClassification": { "allOf": [ { "$ref": "#/components/schemas/WorkerType" } ], "description": "Represents different kinds of workers an organization can hire.\n\n0 = Employee\n\n1 = Contractor", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Users." }, "RetrieveUsersCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveUsers" } ], "description": "The model for retrieving Users.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveUsersListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveUsers" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveViews": { "type": "object", "properties": { "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "Description": { "type": "string", "description": "The description of the View.", "nullable": true }, "EntityTypeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The entity type contained within the View.", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "IsShared": { "type": "boolean", "description": "Whether the View is shared with other Crelate Users within the same Organization.", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "Name": { "type": "string", "description": "The name of the View.", "nullable": true }, "OpportunityTypeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Opportunity Type of Jobs in the View.", "nullable": true }, "Owners": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" }, "description": "The Crelate user, or users, who owns a record.", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true }, "ValidFor": { "type": "integer", "description": "For Workflow dashboard views, the type of Workflow the View is valid for.", "format": "int32", "nullable": true }, "ViewTypeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The standardized type of the View.", "nullable": true }, "WorkflowTypeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The standardized Workflow Type of items in the View.", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Views." }, "RetrieveViewsListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveViews" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveWebhooks": { "allOf": [ { "$ref": "#/components/schemas/WebhooksBase" }, { "type": "object", "properties": { "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true } }, "additionalProperties": false } ], "description": "The model for retrieving Webhooks." }, "RetrieveWebhooksCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveWebhooks" } ], "description": "The model for retrieving Webhooks.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveWebhooksListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveWebhooks" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveWorkHistoryTimelineItem": { "required": [ "Id", "IsPrimary" ], "type": "object", "properties": { "CompanyId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The company of a work history item.", "nullable": true }, "Details": { "type": "string", "description": "Text details or other notes about a work history item. Allows some basic HTML.", "nullable": true }, "Id": { "type": "string", "description": "The primary key of a work history item.", "format": "uuid" }, "IsPrimary": { "type": "boolean", "description": "Whether a work history item is the current position of the target." }, "JobTitle": { "type": "string", "description": "The job title of a work history item.", "nullable": true }, "WhenEnd": { "type": "string", "description": "The month and year when work ended.", "format": "date-time", "nullable": true }, "WhenStart": { "type": "string", "description": "The month and year when work started.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving a Work History Timeline Item." }, "RetrieveWorkflowStatuses": { "type": "object", "properties": { "Color": { "type": "string", "description": "The color to associate with Workflow Items having the Workflow Status in graphical interfaces.", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "DarkColor": { "type": "string", "description": "A darker shade of the Workflow Status color to use as a foreground color and other graphical interface styling.", "nullable": true }, "Description": { "type": "string", "description": "The description for the Workflow Status", "nullable": true }, "EmailIncludeAttachment": { "type": "boolean", "nullable": true }, "ExternalPrimaryKey": { "type": "string", "description": "The external primary key of a record. Not guaranteed to be globally unique.", "nullable": true }, "GenerateActivity": { "type": "boolean", "description": "Does moving an item to this status automatically generate a new activity?", "nullable": true }, "GenerateVerbId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "A lookup to a related entity of a single entity type.", "nullable": true }, "Icon": { "type": "string", "description": "The icon to use for Workflow Items of the Workflow Item Status in graphical interfaces.", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "LightColor": { "type": "string", "description": "A lighter shade of the Workflow Status color to use as a foreground color and other graphical interface styling.", "nullable": true }, "MeaningId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The standardized meaning of the Workflow Status.", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "Name": { "type": "string", "description": "The name of the Workflow Status.", "nullable": true }, "PromptForComments": { "type": "boolean", "description": "Whether users should be prompted for comments upon entering the Workflow Status.", "nullable": true }, "PromptToClose": { "type": "boolean", "description": "Whether users should be prompted to close the target record upon entering the Workflow Status.", "nullable": true }, "RequireSubmittal": { "type": "boolean", "description": "Whether entering the Workflow Status requires a Submittal.", "nullable": true }, "ShowDescription": { "type": "boolean", "description": "Whether records in the Workflow Status show their descriptions in the Portal.", "nullable": true }, "SortOrder": { "type": "integer", "description": "The sort order of the Workflow Status relative to other Workflow Statuses.", "format": "int32", "nullable": true }, "WorkflowTypeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Workflow Type of the Workflow Status.", "nullable": true } }, "additionalProperties": false, "description": "The model for retrieving Workflow Statuses." }, "RetrieveWorkflowStatusesCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveWorkflowStatuses" } ], "description": "The model for retrieving Workflow Statuses.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveWorkflowStatusesListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveWorkflowStatuses" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveWorksites": { "allOf": [ { "$ref": "#/components/schemas/WorksitesBase" }, { "type": "object", "properties": { "Addresses_Business": { "allOf": [ { "$ref": "#/components/schemas/RetrieveAddresses" } ], "description": "Address of the worksite.", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "EntityStatus": { "type": "integer", "description": "This is the record status for worksites.", "format": "int32", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "LegalEntityName": { "type": "string", "description": "Legal Entity Name of the worksite for tax purposes.", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "ParentAccountId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Parent company that this worksite is for.", "nullable": true }, "PhoneNumbers_Main": { "allOf": [ { "$ref": "#/components/schemas/RetrievePhoneNumbers" } ], "description": "Phone number for the worksite.", "nullable": true }, "PrimaryContactId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The primary point of contact for the worksite.", "nullable": true }, "StatusReason": { "type": "string", "description": "An optional text field explaining why the IsAddressVerified field is invalid.", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The user who last updated a record.", "nullable": true }, "WorksiteEIN": { "type": "string", "description": "Federal Employment Identification Number of the worksite for tax purposes.", "nullable": true }, "WorksiteNumber": { "type": "integer", "description": "Optional number of the worksite for tracking purposes (e.g., Store Number).", "format": "int32", "nullable": true }, "WorksiteType": { "type": "integer", "description": "General classification of the worksite (e.g., Onsite vs. Remote).", "format": "int32", "nullable": true } }, "additionalProperties": false } ], "description": "The model for retrieving Worksites." }, "RetrieveWorksitesCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveWorksites" } ], "description": "The model for retrieving Worksites.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "RetrieveWorksitesListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveWorksites" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "SalesWorkflowStageRules": { "required": [ "AskLostReason", "CreateActivity", "CreateActivityOptional", "CreateActivityPrompt", "MoveWhenActivityCreated", "MoveWhenSubmittalCreated", "RequiresLeadConversion", "SendEmail", "SetProbability", "SupportsChildOpportunities" ], "type": "object", "properties": { "AskLostReason": { "type": "boolean", "description": "Whether to ask for a Loss Reason. Only available on Sales Workflow Stages." }, "CreateActivity": { "type": "boolean", "description": "Whether an activity should be created upon stage change." }, "CreateActivityOptional": { "type": "boolean", "description": "When CreateActivity is true, whether creating an activity on stage change is optional." }, "CreateActivityPrompt": { "type": "boolean", "description": "When CreateActivity is true, whether to prompt for activity notes and details. When false, the activity would be created without any notes or details." }, "CreateActivityType": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "When CreateActivity is true, the type of activity to create.", "nullable": true }, "LinkedSequence": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The sequence (automation) linked to this stage, if any. When set, moving items into this stage may prompt to add them to the linked sequence.", "nullable": true }, "MoveActivityType": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "When MoveWhenActivityCreated is true, the activity type that will trigger the automatic stage change.", "nullable": true }, "MoveWhenActivityCreated": { "type": "boolean", "description": "Whether a Workflow Stage change is automatically triggered by the creation of an activity.\r\n Warning: Candidates that are moved by creating this activity type will not prompt users for a submission. Additionally, users will not be prompted for notes for the above selected activity under \"Create a new activity\"." }, "MoveWhenSubmittalCreated": { "type": "boolean", "description": "Whether a Workflow Stage change is automatically triggered by the creation of a Submittal." }, "Probability": { "type": "integer", "description": "When SetProbability is true, the probability to set on the associated Job. Increments are fixed, but vary based on organization settings. Crelate allows setting increments of 10% or 25%, defaulting to 25%, and disallowing mixing increments within the same organization.", "format": "int32", "nullable": true }, "RequiresLeadConversion": { "type": "boolean", "description": "Whether moving to this stage should prompt the user to convert any leads that do not yet have an Opportunity Type assigned. Corresponds to Sales stages with an In Progress or Done (Positive Outcome) meaning." }, "SendEmail": { "type": "boolean", "description": "Whether to optionally send an email on stage change. Stage transitions that send email must be made manually from within Crelate as the API does not accept them." }, "SendEmailTemplate": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "When SendEmail is true, an optional email template to begin forming an email from. Depending on the workflow type, the context of the email may differ: for Sales, only Jobs, but for Recruiting, Employment Search, and Business Development, Contacts and Jobs. Stage transitions that send email must be made manually from within Crelate as the API does not accept them.", "nullable": true }, "SetProbability": { "type": "boolean", "description": "Whether to set the Probability of the associated Job. Only available on Sales Workflow Stages." }, "SupportsChildOpportunities": { "type": "boolean", "description": "Whether this stage supports updating child opportunities (project jobs) as part of the stage change. Always true for Sales Workflow Stages." } }, "additionalProperties": false, "description": "Rules to apply when changing Sales Workflow stages. Each stage has separate rules." }, "SalesWorkflowStageRulesCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/SalesWorkflowStageRules" } ], "description": "Rules to apply when changing Sales Workflow stages. Each stage has separate rules.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "SalutationTypesLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SendEmailResponse": { "required": [ "BouncedEmails", "ComplainedEmails", "CredentialUserName", "EmailMessageId", "ErrorCode", "ErrorMessage", "InvalidEmails", "MessageId", "ResponseContent", "UnsubscribedEmails" ], "type": "object", "properties": { "BouncedEmails": { "type": "array", "items": { "type": "string" }, "description": "Email Addresses that have bounced from Crelate Emails." }, "ComplainedEmails": { "type": "array", "items": { "type": "string" }, "description": "Email Addresses that have complained about Crelate Emails." }, "ErrorCode": { "type": "integer", "description": "The error code indicating why an email send failed. \n *0 - OK: Successful send. No error.\n *50 - SocketException: This occurs when the SMTP server/port are incorrect and connection failed.\n *54 - ConnectionRefused: A possibly valid SMTP server, but it may require a SMTP serverusername/password.\n * 113 - BadCredential: May occur due to incorrect username/password.\n * 116 - SaslAnswerRejected: Authentication failed. This happens whenthe username/password cannot authenticate.\n * 9000 - CUSTOM The Email/Invite is currently sending. When complete, there will be an ErrorCodeor 0 for OK. This should only really appear on the Experience in the EmailStatus field\n * 9001 - CUSTOM Unable to Send because there are no valid To addresses\n * 9002 - CUSTOM Stopped Send because there is no content to send (i.e., no email body).\n * 9999 - CUSTOM Current User is Unauthorized to use the credential that they have selected.", "format": "int32" }, "ErrorMessage": { "type": "string", "description": "The error message from the 3rd party (may be different then Exception.Message)" }, "ExperienceId": { "type": "string", "description": "The Id of the activity that represents the sent email.", "format": "uuid", "nullable": true }, "InvalidEmails": { "type": "array", "items": { "type": "string" }, "description": "Email Addresses that fail to pass email address validation." }, "UnsubscribedEmails": { "type": "array", "items": { "type": "string" }, "description": "Email Addresses that have been unsubscribed from Crelate Emails." } }, "additionalProperties": false }, "SendEmailResponseCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/SendEmailResponse" } ], "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "SourcesLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StreamResponse": { "required": [ "ContentLength", "ContentType", "Inline" ], "type": "object", "properties": { "CacheControl": { "type": "string", "description": "Cache control request header value", "nullable": true }, "Content": { "type": "string", "description": "Stream of the file.", "format": "binary", "nullable": true }, "ContentLength": { "type": "integer", "description": "Length of content.", "format": "int64" }, "ContentType": { "type": "string", "description": "Content type of the file stream. Most basic file types can be found via MediaTypeNames." }, "FileName": { "type": "string", "description": "Name of the file.", "nullable": true }, "Inline": { "type": "boolean", "description": "If true, and requester knows how to render the stream, it will do so." } }, "additionalProperties": false, "description": "Contains metadata and content for a file stream result." }, "StreamResponseCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "allOf": [ { "$ref": "#/components/schemas/StreamResponse" } ], "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "StringCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "string", "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "SuffixTypesLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TagCategoriesBase": { "type": "object", "properties": { "Color": { "type": "string", "description": "The hex color value that determines the color of a Tag Category's tags.", "nullable": true }, "Name": { "type": "string", "description": "The name of a tag category.", "nullable": true } }, "additionalProperties": false, "description": "Base class containing properties shared across all operation models for Tag Categories." }, "Tags": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" } }, "description": "Represents tags which are grouped into customizable Tag Categories. Tag categories are identified by a unique identifier. Tags with no category are contained within a category identified by an empty GUID value." }, "TagsBase": { "type": "object", "properties": { "Name": { "type": "string", "description": "The name of a tag.", "nullable": true } }, "additionalProperties": false, "description": "Base class containing properties shared across all operation models for Tags." }, "TagsMultiLookup": { "required": [ "Lookups" ], "type": "object", "properties": { "Lookups": { "type": "array", "items": { "$ref": "#/components/schemas/EntityLookup" } } }, "additionalProperties": false }, "TargetEntityIdLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TeamEntity": { "required": [ "Count", "EntityName", "IsReadOnly", "Keys", "Name", "Values" ], "type": "object", "properties": { "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/UsersLookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "CreatedOnSystem": { "type": "string", "description": "The date a record was created on and recognized by the Crelate system. This cannot be overridden.", "format": "date-time", "nullable": true }, "EntityName": { "type": "string" }, "EntityStatus": { "type": "integer", "format": "int32", "nullable": true }, "ExternalPrimaryKey": { "type": "string", "description": "The external primary key of a record. Not guaranteed to be globally unique.", "nullable": true }, "Id": { "type": "string", "format": "uuid", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "Name": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Team name" }, "OrganizationId": { "allOf": [ { "$ref": "#/components/schemas/OrganizationsLookup" } ], "description": "The organization a record belongs to.", "nullable": true }, "ParentTeamId": { "allOf": [ { "$ref": "#/components/schemas/TeamsLookup" } ], "description": "Parent Team", "nullable": true }, "SourceId": { "allOf": [ { "$ref": "#/components/schemas/SourcesLookup" } ], "description": "The source of a record.", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/UsersLookup" } ], "description": "The user who last updated a record.", "nullable": true } }, "additionalProperties": false }, "TeamsLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TimeEntryFormat": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "Describes the time entry type. This is a System Picklist enum and will be generated in the future.\n\n0 = None\n\n1 = Straight (Straight Time)\n\n2 = Pipo (Punch In/Punch Out)", "format": "int32", "x-enumNames": [ "None", "Straight", "Pipo" ], "x-enumDescriptions": [ "", "Straight Time", "Punch In/Punch Out" ] }, "TimeZoneInfosLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateActivities": { "allOf": [ { "$ref": "#/components/schemas/ActivitiesBase" }, { "type": "object", "properties": { "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "Owners": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" }, "description": "The Crelate user, or users, who owns a record.", "nullable": true }, "RegardingId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Job the Activity is regarding.", "nullable": true } }, "additionalProperties": false } ], "description": "The model for updating Activities." }, "UpdateAddresses": { "allOf": [ { "$ref": "#/components/schemas/AddressesBase" }, { "type": "object", "properties": { "CountryId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The standardized country of the address.", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true } }, "additionalProperties": false } ], "description": "The model for updating Addresses." }, "UpdateCompanies": { "allOf": [ { "$ref": "#/components/schemas/CompaniesBase" }, { "type": "object", "properties": { "AccountSourceId": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "Tracks the original source of a Company. i.e., who or what referred the Company to you.", "nullable": true }, "AdditionalContacts_Billing": { "allOf": [ { "$ref": "#/components/schemas/UpdateRelatedContacts" } ], "description": "Contacts related to the Company (e.g., Billing Contact)", "nullable": true }, "AdditionalContacts_OtherContact": { "allOf": [ { "$ref": "#/components/schemas/UpdateRelatedContacts" } ], "description": "Contacts related to the Company (e.g., Billing Contact)", "nullable": true }, "Addresses_Business": { "allOf": [ { "$ref": "#/components/schemas/UpdateAddresses" } ], "description": "Collection of physical addresses for this Company (e.g., Business address, Headquarters)", "nullable": true }, "Addresses_Headquarters": { "allOf": [ { "$ref": "#/components/schemas/UpdateAddresses" } ], "description": "Collection of physical addresses for this Company (e.g., Business address, Headquarters)", "nullable": true }, "Addresses_Other": { "allOf": [ { "$ref": "#/components/schemas/UpdateAddresses" } ], "description": "Collection of physical addresses for this Company (e.g., Business address, Headquarters)", "nullable": true }, "CustomField31": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField32": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField33": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField34": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField35": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField36": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField37": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField38": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField39": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField40": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField71": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField72": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField73": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField74": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField75": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField76": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField77": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField78": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField79": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField80": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "EmailAddresses_Other": { "allOf": [ { "$ref": "#/components/schemas/UpdateEmailAddresses" } ], "description": "Collection of email addresses for this Company (Sales, Support, etc.)", "nullable": true }, "EmailAddresses_Sales": { "allOf": [ { "$ref": "#/components/schemas/UpdateEmailAddresses" } ], "description": "Collection of email addresses for this Company (Sales, Support, etc.)", "nullable": true }, "EmailAddresses_Support": { "allOf": [ { "$ref": "#/components/schemas/UpdateEmailAddresses" } ], "description": "Collection of email addresses for this Company (Sales, Support, etc.)", "nullable": true }, "IconAttachmentId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Artifact shown as the icon for the Company.", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "Owners": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" }, "description": "The Crelate user, or users, who owns a record.", "nullable": true }, "ParentAccountId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The parent Company, such as in the case of a subsidiary.", "nullable": true }, "PhoneNumbers_Fax": { "allOf": [ { "$ref": "#/components/schemas/UpdatePhoneNumbers" } ], "description": "Collection of phone numbers for this Company (e.g., Main, Sales, Support)", "nullable": true }, "PhoneNumbers_Main": { "allOf": [ { "$ref": "#/components/schemas/UpdatePhoneNumbers" } ], "description": "Collection of phone numbers for this Company (e.g., Main, Sales, Support)", "nullable": true }, "PhoneNumbers_Other": { "allOf": [ { "$ref": "#/components/schemas/UpdatePhoneNumbers" } ], "description": "Collection of phone numbers for this Company (e.g., Main, Sales, Support)", "nullable": true }, "PhoneNumbers_Sales": { "allOf": [ { "$ref": "#/components/schemas/UpdatePhoneNumbers" } ], "description": "Collection of phone numbers for this Company (e.g., Main, Sales, Support)", "nullable": true }, "PhoneNumbers_Skype": { "allOf": [ { "$ref": "#/components/schemas/UpdatePhoneNumbers" } ], "description": "Collection of phone numbers for this Company (e.g., Main, Sales, Support)", "nullable": true }, "PhoneNumbers_Support": { "allOf": [ { "$ref": "#/components/schemas/UpdatePhoneNumbers" } ], "description": "Collection of phone numbers for this Company (e.g., Main, Sales, Support)", "nullable": true }, "Tags": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" } }, "description": "The tags for the Company.", "nullable": true }, "Websites_Blog": { "allOf": [ { "$ref": "#/components/schemas/UpdateUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true }, "Websites_Business": { "allOf": [ { "$ref": "#/components/schemas/UpdateUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true }, "Websites_CareerPage": { "allOf": [ { "$ref": "#/components/schemas/UpdateUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true }, "Websites_Facebook": { "allOf": [ { "$ref": "#/components/schemas/UpdateUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true }, "Websites_Leadership_People": { "allOf": [ { "$ref": "#/components/schemas/UpdateUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true }, "Websites_LinkedIn": { "allOf": [ { "$ref": "#/components/schemas/UpdateUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true }, "Websites_Other": { "allOf": [ { "$ref": "#/components/schemas/UpdateUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true }, "Websites_Other_Alternate": { "allOf": [ { "$ref": "#/components/schemas/UpdateUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true }, "Websites_Twitter": { "allOf": [ { "$ref": "#/components/schemas/UpdateUrls" } ], "description": "Collection of website addresses or URLs (Company website, blog, Facebook page, etc)", "nullable": true } }, "additionalProperties": false } ], "description": "The model for updating Companies." }, "UpdateContacts": { "allOf": [ { "$ref": "#/components/schemas/ContactsBase" }, { "type": "object", "properties": { "Addresses_Business": { "allOf": [ { "$ref": "#/components/schemas/UpdateAddresses" } ], "description": "A collection of addresses (Home address, Work Address, etc.)", "nullable": true }, "Addresses_Home": { "allOf": [ { "$ref": "#/components/schemas/UpdateAddresses" } ], "description": "A collection of addresses (Home address, Work Address, etc.)", "nullable": true }, "Addresses_Other": { "allOf": [ { "$ref": "#/components/schemas/UpdateAddresses" } ], "description": "A collection of addresses (Home address, Work Address, etc.)", "nullable": true }, "ContactSourceId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Tracks the original source of a candidate. i.e., which job board the candidate came from or who referred them", "nullable": true }, "CurrentPosition": { "allOf": [ { "$ref": "#/components/schemas/UpdateWorkHistoryTimelineItem" } ], "description": "The Contact's current company and job title (and optionally, the start date and end date).", "nullable": true }, "CustomField31": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField32": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField33": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField34": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField35": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField36": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField37": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField38": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField39": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField40": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField71": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField72": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField73": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField74": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField75": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField76": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField77": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField78": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField79": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField80": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "Education": { "allOf": [ { "$ref": "#/components/schemas/UpdateEducationTimelineItem" } ], "description": "The Contact's education info (School, Degree, Graduation Year, etc.)", "nullable": true }, "EmailAddresses_Other": { "allOf": [ { "$ref": "#/components/schemas/UpdateEmailAddresses" } ], "description": "A collection of email addresses (Personal Email, Work Email, etc.)", "nullable": true }, "EmailAddresses_Other_Alternate": { "allOf": [ { "$ref": "#/components/schemas/UpdateEmailAddresses" } ], "description": "A collection of email addresses (Personal Email, Work Email, etc.)", "nullable": true }, "EmailAddresses_Personal": { "allOf": [ { "$ref": "#/components/schemas/UpdateEmailAddresses" } ], "description": "A collection of email addresses (Personal Email, Work Email, etc.)", "nullable": true }, "EmailAddresses_Personal_Other": { "allOf": [ { "$ref": "#/components/schemas/UpdateEmailAddresses" } ], "description": "A collection of email addresses (Personal Email, Work Email, etc.)", "nullable": true }, "EmailAddresses_Potential": { "allOf": [ { "$ref": "#/components/schemas/UpdateEmailAddresses" } ], "description": "A collection of email addresses (Personal Email, Work Email, etc.)", "nullable": true }, "EmailAddresses_Work": { "allOf": [ { "$ref": "#/components/schemas/UpdateEmailAddresses" } ], "description": "A collection of email addresses (Personal Email, Work Email, etc.)", "nullable": true }, "EmailAddresses_Work_Other": { "allOf": [ { "$ref": "#/components/schemas/UpdateEmailAddresses" } ], "description": "A collection of email addresses (Personal Email, Work Email, etc.)", "nullable": true }, "EthnicityId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Contact's ethnicity", "nullable": true }, "GenderId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Contact's gender", "nullable": true }, "IconAttachmentId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The attachment to use as a Contact's profile picture.", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "InstantAddresses_AIM": { "allOf": [ { "$ref": "#/components/schemas/UpdateInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "InstantAddresses_FacebookChat": { "allOf": [ { "$ref": "#/components/schemas/UpdateInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "InstantAddresses_FaceTime": { "allOf": [ { "$ref": "#/components/schemas/UpdateInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "InstantAddresses_GoogleTalk": { "allOf": [ { "$ref": "#/components/schemas/UpdateInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "InstantAddresses_ICQ": { "allOf": [ { "$ref": "#/components/schemas/UpdateInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "InstantAddresses_Other": { "allOf": [ { "$ref": "#/components/schemas/UpdateInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "InstantAddresses_Skype": { "allOf": [ { "$ref": "#/components/schemas/UpdateInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "InstantAddresses_Twitter": { "allOf": [ { "$ref": "#/components/schemas/UpdateInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "InstantAddresses_Yahoo_Msg": { "allOf": [ { "$ref": "#/components/schemas/UpdateInstantAddresses" } ], "description": "A collection of the contact's social and instant messaging addresses (e.g., Skype, Twitter, Facetime, Google Talk)", "nullable": true }, "JobTypeIds": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "The type of job this Contact works or is willing to work (\"Full time\", \"Part Time\", \"Hourly\", etc.)", "nullable": true }, "KeyDates_Anniversary": { "allOf": [ { "$ref": "#/components/schemas/UpdateDates" } ], "description": "A collection of key dates for this Contact (Birthday, Anniversary, etc.)", "nullable": true }, "KeyDates_Birthday": { "allOf": [ { "$ref": "#/components/schemas/UpdateDates" } ], "description": "A collection of key dates for this Contact (Birthday, Anniversary, etc.)", "nullable": true }, "KeyDates_Other": { "allOf": [ { "$ref": "#/components/schemas/UpdateDates" } ], "description": "A collection of key dates for this Contact (Birthday, Anniversary, etc.)", "nullable": true }, "Owners": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" }, "description": "Tracks the Crelate user (or users) who owns this Contact record.", "nullable": true }, "PhoneNumbers_Fax": { "allOf": [ { "$ref": "#/components/schemas/UpdatePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Home": { "allOf": [ { "$ref": "#/components/schemas/UpdatePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Mobile": { "allOf": [ { "$ref": "#/components/schemas/UpdatePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Mobile_Other": { "allOf": [ { "$ref": "#/components/schemas/UpdatePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Other": { "allOf": [ { "$ref": "#/components/schemas/UpdatePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Other_Alternate": { "allOf": [ { "$ref": "#/components/schemas/UpdatePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Potential": { "allOf": [ { "$ref": "#/components/schemas/UpdatePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Skype": { "allOf": [ { "$ref": "#/components/schemas/UpdatePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Work_Direct": { "allOf": [ { "$ref": "#/components/schemas/UpdatePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Work_Main": { "allOf": [ { "$ref": "#/components/schemas/UpdatePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PhoneNumbers_Work_Other": { "allOf": [ { "$ref": "#/components/schemas/UpdatePhoneNumbers" } ], "description": "A collection of the Contact's phone numbers (including Mobile, Work, Home, etc.)", "nullable": true }, "PreferredContactMethodTypeId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Contact's preferred contact method (Email, Phone, or Text)", "nullable": true }, "RelatedContacts_Assistant": { "allOf": [ { "$ref": "#/components/schemas/UpdateRelatedContacts" } ], "description": "A collection of other Contacts that are related to the contact (e.g., \"Spouse\", \"Assistant\", \"Referred By\")", "nullable": true }, "RelatedContacts_OtherContact": { "allOf": [ { "$ref": "#/components/schemas/UpdateRelatedContacts" } ], "description": "A collection of other Contacts that are related to the contact (e.g., \"Spouse\", \"Assistant\", \"Referred By\")", "nullable": true }, "RelatedContacts_ReferredBy": { "allOf": [ { "$ref": "#/components/schemas/UpdateRelatedContacts" } ], "description": "A collection of other Contacts that are related to the contact (e.g., \"Spouse\", \"Assistant\", \"Referred By\")", "nullable": true }, "RelatedContacts_Spouse": { "allOf": [ { "$ref": "#/components/schemas/UpdateRelatedContacts" } ], "description": "A collection of other Contacts that are related to the contact (e.g., \"Spouse\", \"Assistant\", \"Referred By\")", "nullable": true }, "Salutation": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Contact's salutation or name prefix (e.g. \"Mr.\", \"Mrs.\", \"Dr.\")", "nullable": true }, "SuffixId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The Contact's suffix (\"Sr.\", \"Jr.\", etc.)", "nullable": true }, "Tags": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" } }, "description": "The tags for the Contact.", "nullable": true }, "Websites_Blog": { "allOf": [ { "$ref": "#/components/schemas/UpdateUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_Business": { "allOf": [ { "$ref": "#/components/schemas/UpdateUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_Facebook": { "allOf": [ { "$ref": "#/components/schemas/UpdateUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_GitHub": { "allOf": [ { "$ref": "#/components/schemas/UpdateUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_LinkedIn": { "allOf": [ { "$ref": "#/components/schemas/UpdateUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_Other": { "allOf": [ { "$ref": "#/components/schemas/UpdateUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_Other_Alternate": { "allOf": [ { "$ref": "#/components/schemas/UpdateUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_Personal": { "allOf": [ { "$ref": "#/components/schemas/UpdateUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_Portfolio": { "allOf": [ { "$ref": "#/components/schemas/UpdateUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_Quora": { "allOf": [ { "$ref": "#/components/schemas/UpdateUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true }, "Websites_RSSFeed": { "allOf": [ { "$ref": "#/components/schemas/UpdateUrls" } ], "description": "A collection of website addresses or URLs (LinkedIn, Facebook, Personal Blog, etc.)", "nullable": true } }, "additionalProperties": false } ], "description": "The model for updating Contacts." }, "UpdateDates": { "allOf": [ { "$ref": "#/components/schemas/DatesBase" }, { "type": "object", "properties": { "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true } }, "additionalProperties": false } ], "description": "The model for updating Dates." }, "UpdateEducationTimelineItem": { "required": [ "IsPrimary" ], "type": "object", "properties": { "AcademicHonorIds": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "Any academic honors achieved.", "nullable": true }, "AccreditationId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The accreditation, or degree, achieved.", "nullable": true }, "AccreditingInstitutionId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The accrediting institution where the accreditation was achieved.", "nullable": true }, "Details": { "type": "string", "description": "Text details or other notes about an education item. Allows some basic HTML.", "nullable": true }, "IsPrimary": { "type": "boolean", "description": "Whether an education item is the highest education achieved." }, "WhenEnd": { "type": "string", "description": "The year when education ended.", "format": "date-time", "nullable": true }, "WhenStart": { "type": "string", "description": "The year when education started.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "The model for updating an Education Timeline Item." }, "UpdateEmailAddresses": { "allOf": [ { "$ref": "#/components/schemas/EmailAddressesBase" }, { "type": "object", "properties": { "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true } }, "additionalProperties": false } ], "description": "The model for updating EmailAddresses." }, "UpdateInstantAddresses": { "allOf": [ { "$ref": "#/components/schemas/InstantAddressesBase" }, { "type": "object", "properties": { "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true } }, "additionalProperties": false } ], "description": "The model for updating InstantAddresses." }, "UpdateJobPostings": { "type": "object", "properties": { "PortalAccountId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The portal company associated with this Job.", "nullable": true }, "PortalCity": { "type": "string", "nullable": true }, "PortalCompensation": { "type": "string", "nullable": true }, "PortalCountryId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "A lookup to a related entity of a single entity type.", "nullable": true }, "PortalDescription": { "type": "string", "nullable": true }, "PortalState": { "type": "string", "nullable": true }, "PortalTitle": { "type": "string", "nullable": true }, "PortalUrlSlug": { "type": "string", "nullable": true }, "PortalVisibility": { "type": "integer", "description": "Determines the visibility of the Job on the Portal. Possible values are - 0 = Shown, 1 = Featured, 2 = Hidden", "format": "int32", "nullable": true }, "PortalZip": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "The model for updating Job Postings." }, "UpdateJobs": { "allOf": [ { "$ref": "#/components/schemas/JobsBase" }, { "type": "object", "properties": { "AccountId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The company associated with this Job", "nullable": true }, "AccountManagerId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Account manager for the job", "nullable": true }, "AdditionalContacts_Billing": { "allOf": [ { "$ref": "#/components/schemas/UpdateRelatedContacts" } ], "description": "Contacts related to this Job (Hiring manager, executive sponsor, etc.)", "nullable": true }, "AdditionalContacts_ExecutiveSponsor": { "allOf": [ { "$ref": "#/components/schemas/UpdateRelatedContacts" } ], "description": "Contacts related to this Job (Hiring manager, executive sponsor, etc.)", "nullable": true }, "AdditionalContacts_HiringManager": { "allOf": [ { "$ref": "#/components/schemas/UpdateRelatedContacts" } ], "description": "Contacts related to this Job (Hiring manager, executive sponsor, etc.)", "nullable": true }, "AdditionalContacts_InternalRecruiter": { "allOf": [ { "$ref": "#/components/schemas/UpdateRelatedContacts" } ], "description": "Contacts related to this Job (Hiring manager, executive sponsor, etc.)", "nullable": true }, "AdditionalContacts_OtherContact": { "allOf": [ { "$ref": "#/components/schemas/UpdateRelatedContacts" } ], "description": "Contacts related to this Job (Hiring manager, executive sponsor, etc.)", "nullable": true }, "AdditionalContacts_Sales_ClientContact": { "allOf": [ { "$ref": "#/components/schemas/UpdateRelatedContacts" } ], "description": "Contacts related to this Job (Hiring manager, executive sponsor, etc.)", "nullable": true }, "CustomField31": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField32": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField33": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField34": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField35": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField36": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField37": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField38": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField39": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField40": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField71": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField72": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField73": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField74": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField75": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField76": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField77": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField78": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField79": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "CustomField80": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "This field is being deprecated in a future release and is only included for legacy support. Please use the Custom Fields property bag for all reads/edits.", "nullable": true }, "HiringManagerId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Hiring manager for the Job. The person responsible for communicating with the agency.", "nullable": true }, "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "JobTitleId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The job title or short description for this Job.", "nullable": true }, "JobTypeIds": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" }, "description": "The type of job (Full time, Part time, Hourly, etc.)", "nullable": true }, "LeadSourceId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The standardized Lead Source of the Job.", "nullable": true }, "Locations_Business": { "allOf": [ { "$ref": "#/components/schemas/UpdateAddresses" } ], "description": "The location where this Job is available", "nullable": true }, "Locations_Other": { "allOf": [ { "$ref": "#/components/schemas/UpdateAddresses" } ], "description": "The location where this Job is available", "nullable": true }, "Owners": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" }, "description": "The owners of this Job record", "nullable": true }, "ParentJobId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The linked parent Job of the Job.", "nullable": true }, "PriorityId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The priority of the Job (e.g., Cold, Medium, Hot)", "nullable": true }, "RecruiterId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The id of the primary recruiter for this job", "nullable": true }, "SecondaryRecruiterId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "An additional Recruiter working on this Job alongside the primary Recruiter.", "nullable": true }, "SourcerId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "Sourcer for the job", "nullable": true }, "Tags": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Lookup" } }, "description": "Tags for the Job.", "nullable": true }, "TimeCardApproverId": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "The time keeping approver for this job.", "nullable": true }, "Websites_Description": { "allOf": [ { "$ref": "#/components/schemas/UpdateUrls" } ], "description": "Website addresses or URLs associated with this Job", "nullable": true }, "Websites_Other": { "allOf": [ { "$ref": "#/components/schemas/UpdateUrls" } ], "description": "Website addresses or URLs associated with this Job", "nullable": true } }, "additionalProperties": false } ], "description": "The model for updating Jobs." }, "UpdateNotes": { "type": "object", "properties": { "Display": { "type": "string", "description": "Plaintext note content.", "nullable": true }, "ExternalPrimaryKey": { "type": "string", "description": "The external primary key of a record. Not guaranteed to be globally unique.", "nullable": true }, "IsEngagement": { "type": "boolean", "description": "Whether a note constitutes any form of engagement.", "nullable": true }, "IsReachOut": { "type": "boolean", "description": "Whether a note constitutes any form of a reach-out.", "nullable": true }, "RegardingId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The job a note is regarding.", "nullable": true } }, "additionalProperties": false, "description": "The model for updating Note activities." }, "UpdatePhoneNumbers": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumbersBase" }, { "type": "object", "properties": { "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true } }, "additionalProperties": false } ], "description": "The model for updating PhoneNumbers." }, "UpdateRelatedContacts": { "allOf": [ { "$ref": "#/components/schemas/RelatedContactsBase" }, { "type": "object", "properties": { "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "Value": { "allOf": [ { "$ref": "#/components/schemas/LookupAny" } ], "description": "A lookup to a related entity of a single entity type within a set of allowed entity types.", "nullable": true } }, "additionalProperties": false } ], "description": "The model for updating Related Contacts." }, "UpdateTags": { "allOf": [ { "$ref": "#/components/schemas/TagsBase" }, { "type": "object", "properties": { "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true } }, "additionalProperties": false } ], "description": "The model for updating Tags." }, "UpdateTasks": { "type": "object", "properties": { "Display": { "type": "string", "description": "Free-form plaintext information about a task such as notes, reminders, or outcome of a task.", "nullable": true }, "ExternalPrimaryKey": { "type": "string", "description": "The external primary key of a record. Not guaranteed to be globally unique.", "nullable": true }, "Owners": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" }, "description": "The Crelate user, or users, who owns a record.", "nullable": true }, "RegardingId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The job a task is regarding.", "nullable": true }, "When": { "type": "string", "description": "For a scheduled task, when it occurs in UTC time.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "The model for updating Task activities." }, "UpdateUrls": { "allOf": [ { "$ref": "#/components/schemas/UrlsBase" }, { "type": "object", "properties": { "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true } }, "additionalProperties": false } ], "description": "The model for updating Urls." }, "UpdateWorkHistoryTimelineItem": { "required": [ "IsPrimary" ], "type": "object", "properties": { "CompanyId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The company of a work history item.", "nullable": true }, "Details": { "type": "string", "description": "Text details or other notes about a work history item. Allows some basic HTML.", "nullable": true }, "IsPrimary": { "type": "boolean", "description": "Whether a work history item is the current position of the target." }, "JobTitle": { "type": "string", "description": "The job title of a work history item.", "nullable": true }, "WhenEnd": { "type": "string", "description": "The month and year when work ended.", "format": "date-time", "nullable": true }, "WhenStart": { "type": "string", "description": "The month and year when work started.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "The model for updating a Work History Timeline Item." }, "UpdateWorksites": { "allOf": [ { "$ref": "#/components/schemas/WorksitesBase" }, { "type": "object", "properties": { "Id": { "type": "string", "description": "The globally unique primary key of a record.", "format": "uuid", "nullable": true }, "PhoneNumbers_Main": { "allOf": [ { "$ref": "#/components/schemas/UpdatePhoneNumbers" } ], "description": "Phone number for the worksite.", "nullable": true }, "PrimaryContactId": { "allOf": [ { "$ref": "#/components/schemas/Lookup" } ], "description": "The primary point of contact for the worksite.", "nullable": true } }, "additionalProperties": false } ], "description": "The model for updating Worksites." }, "UrlsBase": { "type": "object", "properties": { "IsPrimary": { "type": "boolean", "description": "Whether a URL is the primary URL for a record.", "nullable": true }, "Value": { "type": "string", "description": "The URL value.", "nullable": true } }, "additionalProperties": false, "description": "Base class containing properties shared across all operation models for URLs." }, "UserEntity": { "required": [ "Count", "Email", "EntityName", "IsReadOnly", "Keys", "UserStateId", "Values" ], "type": "object", "properties": { "Addresses": { "allOf": [ { "$ref": "#/components/schemas/MultiPass" } ], "description": "", "nullable": true }, "BillRate": { "type": "number", "description": "The internal bill rate for this user", "format": "double", "nullable": true }, "Color": { "maxLength": 7, "type": "string", "description": "The hex color code to represent this user with, including the pound sign.", "nullable": true }, "CompanyName": { "maxLength": 255, "type": "string", "description": "", "nullable": true }, "CompensationType": { "type": "integer", "description": "Method of paying an employee for their services", "format": "int32", "nullable": true }, "ContactId": { "allOf": [ { "$ref": "#/components/schemas/ContactsLookup" } ], "description": "The contact this user is linked to.", "nullable": true }, "CreatedById": { "allOf": [ { "$ref": "#/components/schemas/UsersLookup" } ], "description": "The user who created a record.", "nullable": true }, "CreatedOn": { "type": "string", "description": "The date a record was created on, either in Crelate or an external system.", "format": "date-time", "nullable": true }, "DefaultTeamId": { "allOf": [ { "$ref": "#/components/schemas/TeamsLookup" } ], "description": "Default team for this user", "nullable": true }, "Email": { "minLength": 1, "type": "string", "description": "The email of the Crelate User." }, "EmailSignatureHtml": { "maxLength": 500000, "type": "string", "description": "", "nullable": true }, "EmailSignatureText": { "maxLength": 5000, "type": "string", "description": "", "nullable": true }, "EmployeeId": { "maxLength": 255, "type": "string", "description": "An Id that is agnostic of Crelate and used across multiple systems to denote a User", "nullable": true }, "EnableApi": { "type": "boolean", "description": "", "nullable": true }, "EntityName": { "type": "string" }, "EntityStatus": { "type": "integer", "format": "int32", "nullable": true }, "ExternalPrimaryKey": { "type": "string", "description": "The external primary key of a record. Not guaranteed to be globally unique.", "nullable": true }, "FirstName": { "type": "string", "description": "The first name of the Crelate User.", "nullable": true }, "FullName": { "type": "string", "description": "The full name of the Crelate User. This field is calculated and read-only.", "nullable": true }, "IconAttachmentId": { "allOf": [ { "$ref": "#/components/schemas/AttachmentsLookup" } ], "description": "The Artifact shown as the icon for the Crelate User.", "nullable": true }, "Id": { "type": "string", "format": "uuid", "nullable": true }, "Initials": { "maxLength": 6, "type": "string", "description": "An abbreviated name to show when space for the full name is not available in a user interface.", "nullable": true }, "InternalTimekeepingEnabled": { "type": "boolean", "description": "Determines if the user's internal timekeeping is enabled", "nullable": true }, "IsNotificationsEnabled": { "type": "boolean", "description": "", "nullable": true }, "IsSubscribedToEmailAlerts": { "type": "boolean", "description": "", "nullable": true }, "IsWeeklyJobEmailEnabled": { "type": "boolean", "description": "", "nullable": true }, "LanguageCode": { "maxLength": 100, "type": "string", "description": "Language", "nullable": true }, "LastName": { "type": "string", "description": "The last name of the Crelate User.", "nullable": true }, "ModifiedOn": { "type": "string", "description": "The date a record was last modified on.", "format": "date-time", "nullable": true }, "OrganizationId": { "allOf": [ { "$ref": "#/components/schemas/OrganizationsLookup" } ], "description": "The organization a record belongs to.", "nullable": true }, "PayRate": { "type": "number", "description": "The internal pay rate for this user", "format": "double", "nullable": true }, "PayrollOnboardStatus": { "type": "integer", "description": "Represents the state of the user during payroll onboarding.", "format": "int32", "nullable": true }, "PayrollOnboardStatusReason": { "type": "string", "description": "Text displaying the various states of the onboarding status.", "nullable": true }, "PayScheduleId": { "allOf": [ { "$ref": "#/components/schemas/PaySchedulesLookup" } ], "description": "The associated pay schedule for this User", "nullable": true }, "PhoneNumbers": { "allOf": [ { "$ref": "#/components/schemas/MultiPass" } ], "description": "", "nullable": true }, "PrimaryWorksiteId": { "allOf": [ { "$ref": "#/components/schemas/WorksitesLookup" } ], "description": "The primary worksite for the user", "nullable": true }, "Profile": { "type": "string", "description": "", "nullable": true }, "TimeZoneId": { "allOf": [ { "$ref": "#/components/schemas/TimeZoneInfosLookup" } ], "description": "The preferred time zone of the Crelate User.", "nullable": true }, "Title": { "type": "string", "description": "", "nullable": true }, "UpdatedById": { "allOf": [ { "$ref": "#/components/schemas/UsersLookup" } ], "description": "The user who last updated a record.", "nullable": true }, "UserStateId": { "allOf": [ { "$ref": "#/components/schemas/UserStatesLookup" } ], "description": "The user state of the Crelate User." }, "UserTypeId": { "allOf": [ { "$ref": "#/components/schemas/UserTypeIdsLookup" } ], "description": "The user type of the Crelate User.", "nullable": true }, "WorkerClassification": { "allOf": [ { "$ref": "#/components/schemas/WorkerType" } ], "description": "Represents different kinds of workers an organization can hire.\n\n0 = Employee\n\n1 = Contractor", "nullable": true } }, "additionalProperties": false }, "UserStatesLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserTypeIdsLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UsersLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UsersMultiLookup": { "required": [ "Lookups" ], "type": "object", "properties": { "Lookups": { "type": "array", "items": { "$ref": "#/components/schemas/EntityLookup" } } }, "additionalProperties": false }, "VeteranStatusType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "\n\n0 = None\n\n1 = Declined\n\n2 = NotQualified\n\n3 = Qualified", "format": "int32", "x-enumNames": [ "None", "Declined", "NotQualified", "Qualified" ], "x-enumDescriptions": [ "", "", "", "" ] }, "VisibilityOptionTypes": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "Describes whether a record status should hide records. Custom views may surface records with statuses that indicate they should be hidden.\n\n0 = Unknown\n\n1 = Hide\n\n2 = Show\n\n3 = SystemOnly", "format": "int32", "x-enumNames": [ "Unknown", "Hide", "Show", "SystemOnly" ], "x-enumDescriptions": [ "", "", "", "" ] }, "WAProviderType": { "enum": [ 0, 1 ], "type": "integer", "description": "\n\n0 = Unknown\n\n1 = EVerify", "format": "int32", "x-enumNames": [ "Unknown", "EVerify" ], "x-enumDescriptions": [ "", "" ] }, "WebhookDefinition": { "required": [ "EntityName", "OperationName" ], "type": "object", "properties": { "EntityName": { "type": "string", "description": "The display name of the entity, as accepted by webhook creation, such as Contacts." }, "EventName": { "type": "string", "description": "The named event that narrows the operation, or null to fire on every matching operation.", "nullable": true }, "OperationName": { "type": "string", "description": "The operation: Create, Update, or Delete." } }, "additionalProperties": false, "description": "A combination of entity, operation, and optional named event that a webhook can be created for." }, "WebhookDefinitionListCrelateResponse": { "required": [ "Errors", "Metadata" ], "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookDefinition" }, "description": "Some data resulting from a request such as to retrieve records or create a record. For errors, this is always null except in the case of a partial success where partial data and some errors are returned at the same time.", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/CrelateErrorDetails" }, "description": "Any errors that occurred during processing of a request. For a successful request with no errors, this will always be an empty array." }, "Metadata": { "allOf": [ { "$ref": "#/components/schemas/CrelateResponseMetadata" } ], "description": "Information about a request and response not necessarily relevant to the returned data." } }, "additionalProperties": false, "description": "The response object returned by all Crelate Unified API REST endpoints. Provides a consistent access mechanism for success, error, and partial success API responses." }, "WebhooksBase": { "type": "object", "properties": { "EntityName": { "type": "string", "nullable": true }, "EventName": { "type": "string", "description": "The named event that narrows when the Webhook fires. Empty fires on every matching operation", "nullable": true }, "Name": { "type": "string", "description": "The name of the Webhook", "nullable": true }, "OperationName": { "type": "string", "nullable": true }, "Status": { "type": "integer", "format": "int32", "nullable": true }, "Url": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Base class containing properties shared across all operation models for Webhooks." }, "WorkerType": { "enum": [ 0, 1 ], "type": "integer", "description": "Represents different kinds of employees an organization can hire.\n\n0 = Employee\n\n1 = Contractor", "format": "int32", "x-enumNames": [ "Employee", "Contractor" ], "x-enumDescriptions": [ "", "" ] }, "WorksitesBase": { "type": "object", "properties": { "Directions": { "type": "string", "description": "Written directions on how to reach the worksite.", "nullable": true }, "DressCode": { "type": "integer", "description": "Dress code for the worksite.", "format": "int32", "nullable": true }, "ExternalPrimaryKey": { "type": "string", "description": "The external primary key of a record. Not guaranteed to be globally unique.", "nullable": true }, "Name": { "type": "string", "description": "Name of the worksite.", "nullable": true }, "OtherDetails": { "type": "string", "description": "Other details about the worksite.", "nullable": true } }, "additionalProperties": false, "description": "Base class containing properties shared across all operation models for Worksites." }, "WorksitesLookup": { "required": [ "EntityType", "Id" ], "type": "object", "properties": { "AttachmentTypeId": { "type": "string", "description": "Type of document attachment", "format": "uuid", "default": null, "nullable": true }, "EntityType": { "allOf": [ { "$ref": "#/components/schemas/EntityTypes" } ], "description": "\n\n0 = None\n\n1 = MetabaseEntities\n\n2 = MetabaseAttributes\n\n3 = MetabaseRelationships\n\n4 = MetabaseMultiEntityLookups\n\n5 = Organizations\n\n6 = OrganizationSettings\n\n7 = MultiEntityLookupEmails\n\n8 = MultiEntityLookupList\n\n9 = MultiEntityLookupOwnerships\n\n10 = MultiEntityLookupSystem\n\n11 = OperationTypes\n\n12 = MetabaseAttributeTypeCategoryTypes\n\n13 = AcademicHonors\n\n14 = AccountSources\n\n15 = Accreditation\n\n16 = AccreditingInstitutions\n\n17 = Accounts\n\n18 = Applications\n\n19 = AsyncJobs\n\n20 = AsyncJobTypeIds\n\n21 = Attachments\n\n22 = AttachmentTypes\n\n23 = AutoNumber\n\n24 = Backups\n\n25 = BulkEmails\n\n26 = ContactMultiPasses\n\n27 = Contacts\n\n28 = ContactSources\n\n29 = ContactStatuses\n\n30 = Countries\n\n31 = Credentials\n\n32 = CredentialTypes\n\n33 = EEO_Ethnicity\n\n34 = EEO_Gender\n\n35 = EEOCSurveyResponse\n\n36 = EmailFlagTypeIds\n\n37 = EntityStatuses\n\n38 = ExperienceResult\n\n39 = Experiences\n\n40 = ExtResumePackages\n\n41 = ExtResumeRedemptions\n\n42 = FormDefinitions\n\n43 = FormFields\n\n44 = FormFieldTypes\n\n45 = FormLayouts\n\n46 = FormResponses\n\n47 = Forms\n\n48 = FormSections\n\n49 = FormTypes\n\n52 = ImportErrors\n\n53 = Imports\n\n54 = ImportSettings\n\n55 = JobBoardPlans\n\n56 = JobBoardPostings\n\n57 = JobBoards\n\n58 = JobBoardTransactions\n\n59 = JobCategories\n\n60 = JobClassification\n\n61 = JobClassificationCategory\n\n62 = JobHistory\n\n63 = Jobs\n\n64 = JobStatuses\n\n65 = JobTitles\n\n66 = JobTypes\n\n67 = LeadSources\n\n68 = LocationByZipPrefix\n\n69 = Losses\n\n70 = LossReasonTypes\n\n71 = Meanings\n\n72 = MetabaseAggregateTypes\n\n74 = Passed\n\n75 = PassReasonTypes\n\n76 = PhoneFlagTypeIds\n\n77 = PipelineSteps\n\n78 = Placements\n\n79 = PreferredContactMethodTypes\n\n80 = Priorities\n\n81 = Privileges\n\n82 = PrivilegeTypes\n\n83 = ReadAnnouncements\n\n84 = Recents\n\n85 = ReferrerTracking\n\n86 = ReportView\n\n87 = RoleGroupRoles\n\n88 = RoleGroups\n\n89 = RolePrivilege\n\n90 = Roles\n\n91 = SalutationTypes\n\n92 = SettingTypes\n\n93 = SmsContacts\n\n94 = SmsMessages\n\n95 = SmsNumbers\n\n97 = Sources\n\n98 = StaticListItems\n\n99 = StatusActivityExpectations\n\n100 = Submittals\n\n101 = SubmittalTemplateAttachments\n\n102 = SubmittalTemplates\n\n103 = SubmittalTemplateTypes\n\n104 = SuffixTypes\n\n105 = TagCategories\n\n106 = TagRelationships\n\n107 = Tags\n\n109 = TimeZoneInfos\n\n110 = UserRoleGroups\n\n111 = UserRoles\n\n112 = Users\n\n113 = UserSettings\n\n114 = UserStates\n\n115 = UserTypeIds\n\n118 = Verbs\n\n119 = Views\n\n120 = ViewTypes\n\n121 = Webhooks\n\n122 = WorkflowHistory\n\n123 = WorkflowItems\n\n124 = WorkflowItemStatuses\n\n125 = WorkflowRegistrations\n\n126 = WorkflowType\n\n127 = PrivacyRequests\n\n128 = ConsentActivity\n\n129 = OpportunityTypes\n\n130 = Rules\n\n131 = Portals\n\n132 = ThrottleConfig\n\n134 = PortalUsers\n\n137 = SharedLinks\n\n138 = PortalAttachments\n\n139 = ClientPortalSubscriptions\n\n140 = PortalHistory\n\n141 = CandidatePortalSettings\n\n142 = FormFieldCategories\n\n143 = Automations\n\n144 = AutomationInstances\n\n145 = AutomationHistory\n\n150 = Deletions\n\n160 = ResumeParseUsage\n\n161 = ParsedResumes\n\n162 = Worksites\n\n163 = LongTermCacheEntries\n\n165 = SystemPicklistOptions\n\n166 = SubmittalItems\n\n167 = JobBoardVettedBrands\n\n170 = ExportConfigs\n\n200 = Teams\n\n220 = AcademyUsers\n\n221 = AcademyGroups\n\n300 = Addresses\n\n301 = EmailAddresses\n\n302 = Dates\n\n303 = InstantAddresses\n\n304 = Urls\n\n305 = TimelineItems\n\n306 = PhoneNumbers\n\n307 = ExtExperiences\n\n308 = CustomPicklistItems\n\n309 = CustomPicklistSets\n\n310 = MEL_CustomPicklistItems\n\n311 = EmailCampaigns\n\n312 = EmailCampaignContacts\n\n313 = BulkEmailAddresses\n\n317 = MEL_CampaignJobStages\n\n318 = ArtifactCategories\n\n320 = RelationshipGroups\n\n321 = RelationshipTypes\n\n322 = Relationships\n\n350 = ExternalAuthDomains\n\n375 = SyncJobs\n\n376 = SyncState\n\n377 = SyncJobLogs\n\n400 = ContactsShadow\n\n401 = AccountsShadow\n\n405 = AgentSession\n\n406 = AgentMessages\n\n407 = AgentDataSets\n\n500 = ProcessTemplates\n\n501 = Processes\n\n502 = ProcessItems\n\n510 = Esignatures\n\n511 = EsignatureRecipients\n\n512 = EsignatureProviders\n\n513 = EsignatureTemplates\n\n514 = EsignatureErrors\n\n515 = EsignatureTemplateFields\n\n516 = EsignatureTemplateSigningRoles\n\n517 = EsignatureAudit\n\n550 = PayrollRuns\n\n551 = PayrollItems\n\n552 = PayrollItemTaxes\n\n553 = PayrollItemBenefits\n\n554 = PayrollItemPostTaxDeductions\n\n555 = PayrollTaxTypes\n\n556 = PayrollBenefitTypes\n\n557 = PayrollPostTaxDeductionTypes\n\n558 = PayrollBenefitTypeToUserRelation\n\n559 = PayrollPostTaxDeductionTypeToUserRelation\n\n650 = ScheduledReports\n\n651 = ScheduledReportCharts\n\n700 = SimilarJobTitles\n\n701 = SemanticSearchFeedback\n\n750 = Calendars\n\n751 = CalendarDates\n\n801 = PaySchedules\n\n802 = PayPeriodSheets\n\n803 = ExpenseEntries\n\n804 = TimeCards\n\n805 = PayableItems\n\n806 = BillableItems\n\n807 = TimeEntries\n\n808 = BillingProfiles\n\n809 = InvoiceTemplates\n\n810 = Invoices\n\n811 = InvoiceAdjustments\n\n812 = PayPeriods\n\n814 = InvoiceDetails\n\n815 = LedgerAccounts\n\n816 = LedgerActionMappings\n\n817 = Payments\n\n818 = InvoicePayments\n\n819 = LedgerItems\n\n820 = TaxableItems\n\n821 = BillingProfileTemplates\n\n822 = InvoiceCorrections\n\n823 = InvoiceMemos\n\n824 = InvoiceBalanceHistory\n\n827 = TimeTypes\n\n828 = ExpenseTypes\n\n829 = PlacementDeliveryTypeAccessMap\n\n830 = TimeSlots\n\n831 = PunchTimes\n\n832 = PayPlans\n\n833 = PayRules\n\n834 = Timesheets\n\n840 = PurchaseOrders\n\n841 = PurchaseOrderAuditEvents\n\n850 = VMSRegistrations\n\n851 = VMSRecords\n\n860 = Assignments\n\n900 = TermsAuditLog\n\n950 = GeofenceTemplates\n\n951 = GeofenceInstances\n\n952 = GeofenceLogs\n\n1000 = MSOrgModules\n\n1001 = MSOrgFeatures\n\n1002 = MSOrgFeatureSettings\n\n1003 = MSOrgFeatureMeters\n\n1004 = MSOrgModuleSubscriptions\n\n1005 = MSOrgBillQueue\n\n1006 = MSOrgIntervals\n\n1008 = MsBillingTransactions\n\n1100 = ProviderEntityMapping\n\n1101 = PartnerRequestConfig\n\n1200 = NamedEvents\n\n1201 = NamedEventTypes\n\n1300 = EventHistory\n\n2000 = OrgSeederTemplateData\n\n2001 = OrgSeederTemplates\n\n3000 = ArtifactFormFields\n\n5000 = Ideas\n\n5001 = IdeaItems\n\n5002 = PeopleYouCareAbout\n\n10000 = Test\n\n10001 = TestSub\n\n11000 = NamingRules\n\n12000 = TimekeepingTemplates\n\n12001 = TimeSubmissionPeriods", "x-enumNames": [ "None", "MetabaseEntities", "MetabaseAttributes", "MetabaseRelationships", "MetabaseMultiEntityLookups", "Organizations", "OrganizationSettings", "MultiEntityLookupEmails", "MultiEntityLookupList", "MultiEntityLookupOwnerships", "MultiEntityLookupSystem", "OperationTypes", "MetabaseAttributeTypeCategoryTypes", "AcademicHonors", "AccountSources", "Accreditation", "AccreditingInstitutions", "Accounts", "Applications", "AsyncJobs", "AsyncJobTypeIds", "Attachments", "AttachmentTypes", "AutoNumber", "Backups", "BulkEmails", "ContactMultiPasses", "Contacts", "ContactSources", "ContactStatuses", "Countries", "Credentials", "CredentialTypes", "EEO_Ethnicity", "EEO_Gender", "EEOCSurveyResponse", "EmailFlagTypeIds", "EntityStatuses", "ExperienceResult", "Experiences", "ExtResumePackages", "ExtResumeRedemptions", "FormDefinitions", "FormFields", "FormFieldTypes", "FormLayouts", "FormResponses", "Forms", "FormSections", "FormTypes", "ImportErrors", "Imports", "ImportSettings", "JobBoardPlans", "JobBoardPostings", "JobBoards", "JobBoardTransactions", "JobCategories", "JobClassification", "JobClassificationCategory", "JobHistory", "Jobs", "JobStatuses", "JobTitles", "JobTypes", "LeadSources", "LocationByZipPrefix", "Losses", "LossReasonTypes", "Meanings", "MetabaseAggregateTypes", "Passed", "PassReasonTypes", "PhoneFlagTypeIds", "PipelineSteps", "Placements", "PreferredContactMethodTypes", "Priorities", "Privileges", "PrivilegeTypes", "ReadAnnouncements", "Recents", "ReferrerTracking", "ReportView", "RoleGroupRoles", "RoleGroups", "RolePrivilege", "Roles", "SalutationTypes", "SettingTypes", "SmsContacts", "SmsMessages", "SmsNumbers", "Sources", "StaticListItems", "StatusActivityExpectations", "Submittals", "SubmittalTemplateAttachments", "SubmittalTemplates", "SubmittalTemplateTypes", "SuffixTypes", "TagCategories", "TagRelationships", "Tags", "TimeZoneInfos", "UserRoleGroups", "UserRoles", "Users", "UserSettings", "UserStates", "UserTypeIds", "Verbs", "Views", "ViewTypes", "Webhooks", "WorkflowHistory", "WorkflowItems", "WorkflowItemStatuses", "WorkflowRegistrations", "WorkflowType", "PrivacyRequests", "ConsentActivity", "OpportunityTypes", "Rules", "Portals", "ThrottleConfig", "PortalUsers", "SharedLinks", "PortalAttachments", "ClientPortalSubscriptions", "PortalHistory", "CandidatePortalSettings", "FormFieldCategories", "Automations", "AutomationInstances", "AutomationHistory", "Deletions", "ResumeParseUsage", "ParsedResumes", "Worksites", "LongTermCacheEntries", "SystemPicklistOptions", "SubmittalItems", "JobBoardVettedBrands", "ExportConfigs", "Teams", "AcademyUsers", "AcademyGroups", "Addresses", "EmailAddresses", "Dates", "InstantAddresses", "Urls", "TimelineItems", "PhoneNumbers", "ExtExperiences", "CustomPicklistItems", "CustomPicklistSets", "MEL_CustomPicklistItems", "EmailCampaigns", "EmailCampaignContacts", "BulkEmailAddresses", "MEL_CampaignJobStages", "ArtifactCategories", "RelationshipGroups", "RelationshipTypes", "Relationships", "ExternalAuthDomains", "SyncJobs", "SyncState", "SyncJobLogs", "ContactsShadow", "AccountsShadow", "AgentSession", "AgentMessages", "AgentDataSets", "ProcessTemplates", "Processes", "ProcessItems", "Esignatures", "EsignatureRecipients", "EsignatureProviders", "EsignatureTemplates", "EsignatureErrors", "EsignatureTemplateFields", "EsignatureTemplateSigningRoles", "EsignatureAudit", "PayrollRuns", "PayrollItems", "PayrollItemTaxes", "PayrollItemBenefits", "PayrollItemPostTaxDeductions", "PayrollTaxTypes", "PayrollBenefitTypes", "PayrollPostTaxDeductionTypes", "PayrollBenefitTypeToUserRelation", "PayrollPostTaxDeductionTypeToUserRelation", "ScheduledReports", "ScheduledReportCharts", "SimilarJobTitles", "SemanticSearchFeedback", "Calendars", "CalendarDates", "PaySchedules", "PayPeriodSheets", "ExpenseEntries", "TimeCards", "PayableItems", "BillableItems", "TimeEntries", "BillingProfiles", "InvoiceTemplates", "Invoices", "InvoiceAdjustments", "PayPeriods", "InvoiceDetails", "LedgerAccounts", "LedgerActionMappings", "Payments", "InvoicePayments", "LedgerItems", "TaxableItems", "BillingProfileTemplates", "InvoiceCorrections", "InvoiceMemos", "InvoiceBalanceHistory", "TimeTypes", "ExpenseTypes", "PlacementDeliveryTypeAccessMap", "TimeSlots", "PunchTimes", "PayPlans", "PayRules", "Timesheets", "PurchaseOrders", "PurchaseOrderAuditEvents", "VMSRegistrations", "VMSRecords", "Assignments", "TermsAuditLog", "GeofenceTemplates", "GeofenceInstances", "GeofenceLogs", "MSOrgModules", "MSOrgFeatures", "MSOrgFeatureSettings", "MSOrgFeatureMeters", "MSOrgModuleSubscriptions", "MSOrgBillQueue", "MSOrgIntervals", "MsBillingTransactions", "ProviderEntityMapping", "PartnerRequestConfig", "NamedEvents", "NamedEventTypes", "EventHistory", "OrgSeederTemplateData", "OrgSeederTemplates", "ArtifactFormFields", "Ideas", "IdeaItems", "PeopleYouCareAbout", "Test", "TestSub", "NamingRules", "TimekeepingTemplates", "TimeSubmissionPeriods" ], "x-enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] }, "Id": { "type": "string", "format": "uuid" }, "TagCategoryId": { "type": "string", "description": "Type of tag", "format": "uuid", "default": null, "nullable": true }, "Title": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "HeaderApiKey": { "type": "apiKey", "description": "A valid API key must appear in the HTTP headers as `X-Api-Key`.", "name": "X-Api-Key", "in": "header" } } }, "security": [ { "HeaderApiKey": [ ] } ], "tags": [ { "name": "Activities", "description": "Activities are used to track various tasks, notes, emails, and other events (e.g., interviews, phone calls) that happen in Crelate or outside of the system.\r\n\r\nRead more about Activities as a Crelate concept: What is an activity?\r\n\r\nEvery Activity has an Activity Type, which provides metadata about the activity's purpose and how it is displayed in\r\nCrelate. Crelate provides many Activity Types out of the box, some of which can be used to create activities; others are\r\ncreated by the Crelate system as a result of a process, like a job changing sales stages, or a client leaving feedback\r\non a candidate in the Client Portal. These system Activity Types are only available for retrieve in the Crelate API;\r\nActivities using these system types may not be created or updated. See the\r\n[Retrieve Activity Types](#tag/Activity-Types/operation/activityTypesGetRecords) endpoint for a list of all Activity\r\nTypes, which can be filtered down to only those valid for create via the API.\r\n\r\n## Activity content\r\n\r\nAn activity's content is in `Html`, `Display` or both, so request both. When `Html` is set it holds the full content,\r\nand `Display`, if also set, may be only a short preview. When `Html` is null the content is in `Display`, which may be\r\nplain text or JSON-wrapped text such as a JSON string array." }, { "name": "Activity Types", "description": "Activity types describe what kind of information activities of that type contain as well as how it behaves. There are\r\na number of immutable system activity types as well as user defined custom activity types. The Retrieve Activity Types\r\nendpoint provides a query parameter to filter the results to only those types that are valid for create via API.\r\n\r\nℹ️ Activity Types change less often and Crelate recommends Activity Types data be cached when possible." }, { "name": "Emails", "description": "Email activities are copies of emails sent to and from contacts in Crelate. This API allows one to create email activities as well as view existing email activities.\r\n\r\nAn email's content is in `Html`, `Display` or both, so request both. When `Html` is set it holds the full content,\r\nand `Display`, if also set, may be only a short preview. When `Html` is null the content is in `Display`, which may\r\nbe plain text or JSON-wrapped text such as a JSON string array.\r\n\r\n`RegardingId` links an email to a Job only when one was chosen: the Regarding Job picked when composing or supplied on\r\ncreate, inherited by a reply, set by an automation or sequence step, or named by a `#crjob` hashtag in the body.\r\nJournaled, BCC'd and add-in-logged mail usually has no `RegardingId`. To group emails by contact, use `ParentId`. To\r\ngroup them by Job, filter with `regarding_ids`, or retrieve activities whose parent is one of the Job's contacts." }, { "name": "Notes", "description": "A note is a type of activity available in Crelate. It's used to store text information. This API allows you to create, read, update, and delete individual notes.\r\n\r\nA note's content is in `Display`, which may be plain text or JSON-wrapped text such as a JSON string array. Notes have\r\nno `Html` field." }, { "name": "Tasks", "description": "Tasks are scheduled activities in Crelate. These are generally attached to Companies, Contacts, and Jobs." }, { "name": "Backups", "description": "Organization backups contain all of an organization's data split across csv files for tabular data and source files for all of the organization's file attachments. Backups can be created with a frequency that is defined by the organization's license level and are available for download for thirty days." }, { "name": "Organizations", "description": "Organizations are isolated tenants that a user can log in to. Records in Crelate each belong to one organization and all data access in Crelate is scoped to a single organization; data from one organization cannot be accessed from another. Information about an organization can be accessed from an organization entity.\r\n\r\nSome information is restricted based on level of privilege." }, { "name": "Users", "description": "A User represents an identity that can access an organization's Data. Users are granted a License and have Roles which\r\nin turn contain Privileges. Privileges and License level grant access to features, entities, and capabilities in\r\nthe system.\r\nUser management is performed exclusively from within the Crelate app, but some basic information is available via API." }, { "name": "Webhooks", "description": "Webhooks register an HTTPS endpoint you own to receive a `POST` from Crelate whenever a record of a given type is created, updated, or deleted. These endpoints manage webhook registrations. See [Webhooks](#section/General-API-Concepts/Webhooks) for the supported events, the payload Crelate sends, and how your endpoint must respond.\r\n\r\n## Managing webhooks\r\n\r\nCreating and deleting webhooks requires an administrator API key, and creating one requires the organization to have webhooks enabled (**Business Plus** plan or higher).\r\n\r\nEach webhook covers one `entityName` (`Contacts`, `Companies`, or `Jobs`) and one `operationName` (`Create`, `Update`, or `Delete`). To receive several events, create a webhook for each combination. The same `url` cannot be registered twice for the same entity and operation.\r\n\r\n`url` must be a publicly reachable address; private and local network addresses are rejected. `status` is `1` to create the webhook active or `0` to create it inactive.\r\n\r\nWebhooks cannot be modified through the API. To change one, delete it and create a replacement.\r\n" }, { "name": "Academic Honors", "description": "Academic Honors describe typically merit-based achievements at an institution such as a university; for example, but\r\nnot limited to, the system of [Latin honors](https://en.wikipedia.org/wiki/Latin_honors) used in the United States.\r\nAcademic honors are not an accreditation or degree, but a sign of academic excellence beyond the requirements for such\r\na degree.\r\n\r\nℹ️ Academic Honors change less often and Crelate recommends Academic Honors data be cached when possible.\r\n\r\nAdditionally note that new values may be created as a result of resume imports and other contact data ingestion, and\r\nvalues may be added/removed by organization administrators." }, { "name": "Accreditations", "description": "Accreditations describe educational achievements across all forms of education. Common examples of Accreditations are\r\ndegrees awarded from universities, certifications from regulatory bodies, and vocational programs. In Crelate, they\r\nprimarily describe education of Contacts.\r\n\r\nℹ️ Accreditations change less often and Crelate recommends Accreditations data be cached when possible.\r\n\r\nAdditionally note that new values may be created as a result of resume imports and other contact data ingestion, and\r\nvalues may be added/removed by organization administrators." }, { "name": "Accrediting Institutions", "description": "Accrediting Institutions describe universities, certifying bodies, and other entities that award accreditations like\r\ndegrees, certifications, and other educational achievements or proof of knowledge and/or skills.\r\n\r\nℹ️ Accrediting Institutions change less often and Crelate recommends Accrediting Institution data be cached when possible.\r\n\r\nAdditionally note that new values may be created as a result of resume imports and other contact data ingestion, and\r\nvalues may be added/removed by organization administrators." }, { "name": "Companies", "description": "In Crelate, Jobs and Contacts can belong to a Company. This API allows you to manage your companies by creating, updating, retrieving, and deleting them.\r\n\r\nA Company record in Crelate can serve a variety of purposes but is predominantly leveraged in two main ways:\r\n\r\n- To affiliate with a Contact record, meaning I can add a Company to a Contact record so that I am aware of their employment both past and present.\r\n- To affiliate to an Opportunity. This allows you to relate a company to a Job, Lead, Project or other Opportunity to provide a high level overview surrounding what you are currently or planning to work on regarding that particular Company." }, { "name": "Company Sources", "description": "Company sources provide context to where information about a Company came from, such as a job board. Company source\r\nvalues are Organization-specific and are configured by an Organization administrator.\r\n\r\nℹ️ Company Sources change rarely and Crelate recommends Company Sources data be cached." }, { "name": "Contact Sources", "description": "Contact Sources provide context to Applicants and Contacts entering Crelate. Since these records can come from many\r\ndifferent external sources like job boards, custom integrations, data imports, or the Crelate Job Portal, tracking where\r\neach record was sourced from provides valuable insight to an organization's data.\r\n\r\nContact Sources can only be managed directly in Crelate. If you are an integration partner and need a Contact Source\r\ncreated, reach out to your client to request the new value(s) be added.\r\n\r\nℹ️ Contact Sources change rarely and Crelate recommends Contact Source data be cached." }, { "name": "Contacts", "description": "Contacts hold information about an individual. This API allows you to manage contacts by creating, updating, retrieving, and deleting them.\r\n\r\n## Record Types\r\n\r\nRecord Types are used to categorize records. For example, a contact may be a candidate or a sales/client contact.\r\nHow different types of contacts are interacted with varies, so setting the correct record type helps. Sometimes, contacts\r\ncan have multiple applicable record types; this is covered by making Record Type a _bitmask_ value.\r\n\r\n| Record Type | Bit mask value | Integer value\r\n|---|---|---|\r\n| None | 0 | 0 |\r\n| Contact_Candidate | 1 << 0 | 1 |\r\n| Contact_Sales_Client_Contact | 1 << 1 | 2 |\r\n| Contact_Lead_Contact | 1 << 2 | 4 |\r\n| Contact_Employee | 1 << 3 | 8 |\r\n| Contact_Time_Approver | 1 << 4 | 16 |\r\n\r\nValues can be combined most easily by using the bitwise OR operator. In C#, for example, this looks like:\r\n\r\n```csharp\r\nint recordType = (1 << 0) | (1 << 3);\r\n```\r\n" }, { "name": "Countries", "description": "When creating or updating addresses of records in Crelate, such as the Headquarters of a Company, a Country may be\r\nspecified. Countries are not free-form in Crelate; thus, these operations expose the available values for associating\r\na country with a record or address.\r\n\r\nℹ️ Countries change rarely and Crelate recommends Countries data be cached." }, { "name": "Custom Picklist Items", "description": "Custom Picklist Items are string values, each with an associated GUID identifier and a lookup to the parent [Custom Picklist Set](#tag/Custom-Picklist-Sets), used to provide a custom bound set of values that can be chosen from throughout Crelate where the set is specified. Value uniqueness is not enforced across sets, so the same value could appear in multiple sets, but would have a different Id GUID in each. Custom Picklist Items can be managed from within Crelate (KBA)." }, { "name": "Custom Picklist Sets", "description": "Custom Picklist Sets are logical groups of Custom Picklist Items used to provide a custom bound set of values that can be chosen from throughout Crelate where the set is specified. Custom Picklist Sets can be managed from within Crelate (KBA)." }, { "name": "Job Titles", "description": "Job Titles provide a short description for the role of a Job." }, { "name": "Job Types", "description": "Job Types describe the type of employment of a job, such as Full-Time, Exempt, Temporary, or Internship. Job Types can be added within Crelate settings." }, { "name": "Jobs", "description": "In Crelate, jobs store information about a particular position. From job postings to workflows, jobs help users organize their open recruitment and staffing requests.\r\n\r\nIn Crelate, we support the notion of an opportunity. An opportunity can signal any potential, active, or completed chance at revenue. How about John Smith that works at ABC Company that I've been reaching out to in search of new job orders? Check. How about the active job order I have for XYZ Company who is hiring for a Sales Manager? Check. How about the role I closed for LMN Company 6 months ago? Check, albeit a closed opportunity.\r\n\r\n## Open and closed jobs\r\n\r\nWhether a Job is open comes from the `MeaningId` of its sales stage, not the stage name. \"New\" and \"In Progress\" are\r\nopen; \"Done\", \"Done, Positive Outcome\" and \"Done, Negative Outcome\" are closed. `published=true` returns only open Jobs\r\nthat are also published to the job portal.\r\n\r\n## Amounts\r\n\r\n`Fee`, `ActualValue`, `PotentialValue` and `ExpectedValue` are not reconciled with Placement `Value` or `Fee`. The\r\nserver never derives `ActualValue` from placements, but when a Placement is created the app offers to add its `Value`\r\nto the Job's `ActualValue`, so `ActualValue` often already includes Placement values; do not add them together.\r\n`ExpectedValue` is `PotentialValue` * `Probability` / 100 unless it is set directly. For a parent Job whose opportunity\r\ntype sums its child Jobs, `ActualValue`, `PotentialValue` and `ExpectedValue` are the sums of the child Jobs, so do not\r\nadd parent and child values together." }, { "name": "Loss Reason Types", "description": "Loss Reason Types in Crelate represent predefined categories that explain why a job opportunity was not\r\nsuccessful, enabling organizations to track and analyze common patterns in lost opportunities for better decision-making\r\nand process improvement. These classifications help maintain consistent reporting and provide valuable insights into\r\nsales workflow data. Values may be managed within the Settings area in the Crelate web app.\r\n\r\nℹ️ Loss Reason Types change rarely and Crelate recommends Loss Reason Types data be cached.\r\n\r\nThe display text of a Loss Reason Type is its `Value` field; there is no `Name` or `Title` field. Job stage change\r\nhistory returns the reason for a loss as `LossReason`, with this text as its `Title`, when `include_loss_reasons=true`." }, { "name": "Opportunity Types", "description": "Opportunity types are used to categorize opportunities and describe how those workflows behave. This includes value\r\ncalculation, placement and lead forms, submittal templates, and the type of workflow associated with the type.\r\n\r\nℹ️ Opportunity Types change rarely and Crelate recommends Opportunity Types data be cached." }, { "name": "Pass Reason Types", "description": "Pass Reason Types represent predefined categorizations for why a candidate was passed on or rejected during the hiring\r\nprocess in Crelate. These entities enable standardized tracking and reporting of candidate disposition reasons across\r\nthe recruitment workflow, allowing organizations to analyze patterns in their candidate evaluation process. Values can\r\nbe added and removed within the main Crelate app under Settings.\r\n\r\nℹ️ Pass Reason Types change rarely and Crelate recommends Pass Reason Types data be cached.\r\n\r\nThe display text of a Pass Reason Type is its `Value` field; there is no `Name` or `Title` field. Candidate stage change\r\nhistory returns the reason for a pass as `PassReason`, with this text as its `Title`, when `include_pass_reasons=true`." }, { "name": "Placements", "description": "A Placement represents the successful matching of a candidate with a job opportunity in the Crelate platform. It serves\r\nas a record of when a candidate is hired or assigned to a position, capturing essential information such as start and \r\nend dates, salary details, shift information, and the relationship between the candidate, the job, and the hiring\r\ncompany. Placements can vary by recruiting type (such as Direct Hire or Temporary assignments) and may trigger automated\r\nprocesses like billable item creation for invoicing. The Placement entity maintains connections to both the candidate\r\n(Contact) and the job opportunity, allowing recruiters to track the full lifecycle of a successful placement and manage\r\nthe associated workflow, documentation, and financial aspects of the hiring process.\r\n\r\n## Placements and activities\r\n\r\nEach Placement belongs to one placement-type activity, identified by `ExperienceId`, and `VerbId` is that activity's\r\ntype. An organization can have several placement-type activity types, so one hire can have several Placements. To count\r\nhires, count only the Placements whose `VerbId` is the activity type the organization counts as the hire. Which\r\nPlacements a caller sees can depend on their access to each placement activity type.\r\n\r\n## Amounts\r\n\r\nA Placement's `Value` and `Fee` are separate amounts, and neither is reconciled with its Job's `Fee` or `ActualValue`.\r\nBy default `Value` is `Salary * FeePercent / 100` for direct hire and `Margin * TotalHours` for temporary placements,\r\nbut each organization can change its placement forms." }, { "name": "Relationships", "description": "A Relationship links two records together and describes how they are connected; for example, a contact who referred another contact, or a contact who is the hiring manager at a company.\r\n\r\nEvery relationship has two sides:\r\n\r\n| Side | Meaning |\r\n|---|---|\r\n| **Parent** | The record the relationship belongs to (the \"from\" side). |\r\n| **Target** | The record the relationship references (the \"to\" side). |\r\n\r\nBoth sides are polymorphic: a relationship can connect several different kinds of records (such as Contacts, Companies, Jobs, or Placements). In the API, each side is returned as a lookup carrying the related record's `Id`, its entity name, and its title, so a single relationship fully identifies both records it connects.\r\n\r\nℹ️ _Crelate organizations on specific product tiers can rename core entities (for example, Contacts → \"Candidates\", Companies → \"Clients\"). The names used in this documentation reflect the default names Crelate sets._\r\n\r\n## Groups and types\r\n\r\nEach relationship is categorized by a **relationship group** and a **relationship type**, both configured per organization in the Crelate UI:\r\n\r\n- A **relationship group** is a broad category (for example, \"Referrals\" or \"Vendors\").\r\n- A **relationship type** is a specific role within a group (for example, \"Referred By\" or \"Preferred Vendor\"). Each type belongs to one or more groups.\r\n\r\nGroups and types are identified by stable, organization-specific **numeric codes** (`RelationshipGroupCode` and `RelationshipTypeCode`) rather than IDs. These same codes are used to filter relationships. A relationship record returns both the code and its resolved friendly name for each.\r\n\r\nBecause the available codes differ per organization, discover them with the _Retrieve available relationship groups and types_ endpoint before retrieving or filtering. For each group and type it returns:\r\n\r\n- the numeric `Code` and friendly `Name`,\r\n- the record types the group/type applies to (`AvailableOn` / `AppliesTo`), and\r\n- for each type, the group codes it belongs to (`GroupCodes`).\r\n\r\n## Splits\r\n\r\nWhen a group has splits enabled (`EnableSplits`), its relationships can carry a **split percentage** and/or **split amount**. These are used, for example, to divide commission across multiple owners. The split percentage is expressed as a fraction between 0 and 1 (so `0.5` represents 50%). Relationships in groups without splits enabled leave these values empty.\r\n\r\n## Recommended pattern\r\n\r\n1. **Discover the available group and type codes** using the _Retrieve available relationship groups and types_ endpoint. Note which codes apply to the record types you care about and how types map to groups.\r\n2. **Retrieve relationships** using the _Retrieve relationships_ endpoint, optionally filtering by parent record, target record, group code, or type code.\r\n3. **Retrieve a single relationship** by its identifier using the _Retrieve a relationship_ endpoint when you already have its ID.\r\n\r\n## Filtering and paging\r\n\r\nThe _Retrieve relationships_ endpoint accepts the following optional query filters, which are combined together:\r\n\r\n| Filter | Effect |\r\n|---|---|\r\n| `parent_id` | Only relationships whose parent (owning) record matches this ID. |\r\n| `target_id` | Only relationships whose target (referenced) record matches this ID. |\r\n| `group_code` | Only relationships in this relationship group. |\r\n| `type_code` | Only relationships of this relationship type. |\r\n\r\nResults are paged with `offset` and `limit`, and the response includes the total count and whether more records are available. Use `sort_by` to order results (descending) by `CreatedOn`, `ModifiedOn`, `RelationshipGroupCode`, or `RelationshipTypeCode`; any other value falls back to `ModifiedOn`.\r\n" }, { "name": "Artifact Types", "description": "Artifact Types provide context to the capabilities of an Artifact. They can be limited to certain entity types to \r\nenforce business processes. Some Artifact Types are managed by Crelate and cannot be modified.\r\n\r\nℹ️ Artifact Types change rarely and Crelate recommends Artifact Type data be cached." }, { "name": "Artifacts", "description": "Artifacts are the outcome of a process. These are information items within Crelate that can be customized to capture details needed to complete a variety of workflows. Like a standard document, an Artifact can include an attached file but it does not need one because it can also be used to capture and store information." }, { "name": "Billable Items", "description": "Billable items represent an amount billable via Invoicing." }, { "name": "Expense Types", "description": "Expense Types add context to an expense for time recorders, time keepers, and time approvers. They also dictate business rules such as data validation.\r\n\r\nℹ️ Expense Types change rarely and Crelate recommends Expense Types data be cached." }, { "name": "Invoices", "description": "Invoices are documents representing an amount owed by one party to another. They are generated based on billable items in Crelate." }, { "name": "Ledger Accounts", "description": "Ledgers are used to mirror an organization's accounting system and allow customers to synchronize invoicing actions with their external systems." }, { "name": "Ledgers", "description": "This API allows users to query for ledger entries with a variety of filters." }, { "name": "Payments", "description": "Payments represent a transfer of money, typically in response to paying an invoice. Note that payments in Crelate are only a record of a transfer of money." }, { "name": "Time Types", "description": "Time Types add context to timecards for time recorders, time keepers, and time approvers.\r\nThey also dictate business rules such as data validation.\r\n\r\nℹ️ Time Types change rarely and Crelate recommends Time Types data be cached." }, { "name": "Form Requests", "description": "Form Requests allow Crelate users to send a Form Template to a Contact's primary email address for external completion. A request specifies the Contact, the Form Template or document type to use, and an optional personalized message.\r\n\r\nWhen the Contact submits the form, a Form record and its Form Responses are automatically created in Crelate. See [Forms](#tag/Forms) and [Form Responses](#tag/Form-Responses) for the resulting records.\r\n\r\nUse `GET /api/v3/forms/templates` to discover the activity forms and document types available for use in a form request. Use `POST formrequests/send` to dispatch a request, `GET formrequests` to retrieve its status and optionally its form layout, `POST formrequests/resend` to resend the email, and `PATCH formrequests/revoke` to cancel a pending request.\r\n" }, { "name": "Form Responses", "description": "Form Responses are the answer data submitted when a Form is completed. Each Form Response belongs to a single Form (see [Forms](#tag/Forms)) and records the answer to one specific [Form Field](#tag/Form-Fields). To render a completed form, pair these responses with the associated [Form Template](#tag/Form-Templates), which provides the presentation structure they slot into.\r\n\r\nUse `GET /api/v3/forms/responses` to retrieve all responses for a form. You can look up responses by form ID, by the activity that produced the form, or by the artifact (like a Form Request) that delivered it.\r\n" }, { "name": "Form Templates", "description": "Form Templates define the presentation structure of a form: its sections, which Form Fields appear in each section, which fields are required, and any post-submission workflows. When rendering a submitted form, use the template to determine layout and then populate it with the submitted [Form Responses](#tag/Form-Responses).\r\n\r\nTemplates are typed by form type (e.g., Activity Form, Application Form, Scorecard) and are versioned — editing a template in use produces a new version while preserving the original on historical Forms. Inactive templates are hidden from new submissions.\r\n\r\nUse `GET /api/v3/formtemplates/{id}` to retrieve a specific template's full definition, including its sections and field layout. For the individual question definitions, see [Form Fields](#tag/Form-Fields).\r\n" }, { "name": "Forms", "description": "Forms are submitted instances of a Form Template. Each Form belongs to a parent record (e.g., a Contact or Job) and may target a related record such as a specific Job opening.\r\n\r\nA Form ties together two concerns: its associated [Form Template](#tag/Form-Templates) defines the presentation structure — the sections, questions, and layout — while its [Form Responses](#tag/Form-Responses) hold the answer data submitted within that structure. To render a completed form, fetch both.\r\n\r\nForms can be filtered by parent, regarding record, form type, template, and completion status.\r\n" }, { "name": "Lists", "description": "Lists are a feature that allows users to organize collections of core records (Contacts, Companies, and Jobs). These lists are static and do not update automatically. This API will show all lists that exist and are available to the current user." }, { "name": "Applications", "description": "Applications serve as the record of a candidate's request for consideration for hiring, either for a specific job\r\nopportunity, or general consideration amongst open job opportunities, and store only basic candidate information, mostly\r\npersonal details (name, contact information, address) and the application source.\r\nThey can be created through various intake methods including job board integrations, portal submissions, or manual entry.\r\nAn Application record by itself does not contain recruiting workflow data; once processed, a Contact record is created\r\nif a duplicate did not already exist. The progress of a candidate through a job opportunity's recruiting workflow is\r\nthen tracked using a Workflow Item linker. This API exposes many of the functions found in the Intake tab in Crelate.\r\n\r\n## Limitations\r\n\r\nAt this time, the API does not support creating an application that is not attached to a job (\"general consideration\")." }, { "name": "Losses", "description": "Losses represent the loss of an opportunity and store information about why." }, { "name": "Tag Categories", "description": "Tag Categories are logical containers for a group of Tags. Each Tag in a category must have a unique value. Tags are\r\nalso visually grouped by category in Crelate applications. Tags may be added without a Tag Category, which groups\r\nthem in the \"default\" Tag Category. The default Tag Category cannot be modified or removed.\r\n\r\nAs many as ten (10) Tag Categories may exist in one Crelate organization at a time, though this number may change based\r\non Crelate subscription tier. The default Tag Category does not count against this limit and cannot be deleted.\r\n\r\nTag Categories may be allowed on one or more entity types; currently, `contacts`, `companies`, and `jobs` are valid\r\nentity types when creating new Tag Categories. Note that a Tag Category with no types allowed implicitly allows all\r\nentity types.\r\n\r\nℹ️ Tag Categories change rarely and Crelate recommends Tag Category data be cached." }, { "name": "Tags", "description": "Tags allow users to quickly categorize taggable records with free-form text values. Tags can belong to a tag category\r\nor the default tag category. To add tags to the default tag category, a `TagCategoryId` of `null` or an empty\r\nGUID (`00000000-0000-0000-0000-000000000000`) should be specified.\r\n\r\nIt is important to remember that a Tag entity itself is only a value. Tags are applied to taggable records via a linking\r\ntable, so changing a Tag entity will affect all records with that Tag applied.\r\n\r\nWhen updating tags to have a new text value, note that updates will not be reflected in real-time due to the cascade\r\nupdate operation which takes longer on larger data sets.\r\n\r\nTo apply a new Tag value to a record, that Tag must be created prior to applying it.\r\n\r\nℹ️ Tags change less often and Crelate recommends Tags data be cached when possible." }, { "name": "Workflow Actions", "description": "A Workflow Stage (or Workflow Status; they are interchangeable terms) is a named step in a workflow pipeline, such as \"Applied\", \"Phone Screen\", or \"Offer Extended\".\r\nEach organization configures its own set of stages via the Crelate UI.\r\n\r\nCrelate organizes records through four distinct **Workflow** types, each representing a different area of the business:\r\n\r\nℹ️ _Crelate organizations on specific product tiers can rename each workflow to fit their processes. The names used in this documentation reflect the default names Crelate sets._\r\n\r\n| Workflow | Typical target records |\r\n|---|---|\r\n| **Recruiting** | Contacts (candidates) moving through a hiring pipeline for a specific Job |\r\n| **Sales** | Jobs or Leads (opportunities) moving through a sales pipeline |\r\n| **Employment Search** | Jobs or Companies being tracked through a search engagement. Sometimes referred to as an MPC search. |\r\n| **Business Development** | Leads or Jobs being developed into new business |\r\n\r\nEach record's position in a workflow is represented by a **Workflow Item** — an entity that links a target record (and, for Recruiting, an associated Job) to a **Workflow Stage** (also called a Workflow Status). Workflow Items can be retrieved and managed via the [Workflow Items](#tag/Workflow-Items) endpoints.\r\n\r\n## Recommended pattern\r\n\r\nBecause each Workflow Stage can carry custom rules that govern what is required or allowed when moving a record into it, the recommended API pattern is:\r\n\r\n1. **Retrieve the destination stage's rules** using the appropriate _Retrieve … workflow stage rules_ endpoint for your workflow type, passing the target stage ID.\r\n2. **Inspect the rules** to understand what optional fields (activity, loss reason, etc.) are supported and which stages cannot be changed via the API.\r\n3. **Submit the stage change** using the matching _Change … workflow stage_ endpoint.\r\n\r\n## Stage rules and API restrictions\r\n\r\nSome Workflow Stage configurations require interactive UI flows that cannot be replicated via the API, or execute actions not allowed via API, like sending email.\r\nIf a stage has any of the following rules enabled, the _Change … workflow stage_ endpoint will reject the request with an error — the stage transition must be performed manually inside Crelate:\r\n\r\n| Rule | Workflows affected |\r\n|---|---|\r\n| `SendEmail` | All workflow types |\r\n| `CreateChecklist` | Recruiting |\r\n| `CreateSubmittal` | Recruiting |\r\n| `CreateLead` | Business Development |\r\n\r\nAll other rules are informational or optional: the stage change will succeed, and the API will create associated records (such as an Activity) automatically where appropriate.\r\n\r\n## Creating an activity on stage change\r\n\r\nThe `Activity` field in the stage change request is accepted, required, or rejected based on the destination stage's rules:\r\n\r\n| `CreateActivity` | `CreateActivityPrompt` | `CreateActivityOptional` | Behavior |\r\n|---|---|---|---|\r\n| `false` | — | — | No activity is created. Providing `Activity` returns a **validation error**. |\r\n| `true` | `false` | — | The platform auto-generates a stage-change activity internally. Providing `Activity` returns a **validation error** (would create a duplicate). |\r\n| `true` | `true` | `false` | Activity is **required**. `Activity` must be provided. If `CreateActivityType` is set, the activity's verb must match that type. |\r\n| `true` | `true` | `true` | Activity is **optional**. `Activity` may be omitted or provided. |\r\n\r\nAn optional file attachment for the created activity can be included in the multipart form request body as `ActivityAttachment`. If the activity type requires an attachment (`AttachmentRequired: true`), omitting it returns a validation error.\r\n\r\n## Request format\r\n\r\nThe _Change … workflow stage_ endpoints accept `multipart/form-data`.\r\nThe `ChangeStageRequest` field must be a JSON-encoded object; `ActivityAttachment` is an optional binary file part.\r\n\r\n## Workflow-specific notes\r\n\r\n**Recruiting** — The `TargetId` must be a Contact. A `JobId` is always required, identifying the Job the candidate is being tracked against.\r\n\r\n**Sales** — The `TargetId` must be a Job or Lead (the opportunity itself is the target).\r\nIf `AskLostReason` is true on the destination stage, a `LossReason` may be provided.\r\nIf `RequiresLeadConversion` is true, any lead without an Opportunity Type assigned should be converted before or alongside the stage change.\r\n\r\n**Employment Search** — The `TargetId` must be a Job or Company.\r\nStage rules follow the common pattern with no Employment Search-specific restrictions.\r\n\r\n**Business Development** — The `TargetId` is a Lead or Job.\r\nStages with `CreateLead: true` cannot be transitioned via the API.\r\n" }, { "name": "Workflow Statuses", "description": "A Workflow Status (also called a Workflow Stage) is a named pipeline step — such as \"Applied\", \"Phone Screen\", or \"Offer Extended\" — that records can be moved through within a Crelate workflow.\r\nEach organization configures its own set of statuses via the Crelate UI; they cannot be created, updated, or deleted through the API.\r\n\r\nWorkflow Statuses are the building blocks used by the [Workflow Stages](#tag/Workflow-Stages) endpoints when moving records between pipeline steps.\r\n\r\n## Workflow types\r\n\r\nEvery Workflow Status belongs to exactly one workflow type, identified by `WorkflowTypeId`.\r\nUse the `workflow_type_ids` filter on the [Retrieve Workflow Statuses](#tag/Workflow-Statuses/operation/workflowstatusesGetRecords) endpoint to scope results to a single type.\r\nThe four workflow types are Recruiting, Sales, Employment Search, and Business Development — see [Workflow Stages](#tag/Workflow-Stages) for details on each type and the records they track.\r\n\r\n## Meanings\r\n\r\nEach Workflow Status carries a `MeaningId` that maps it to one of six standardized system meanings.\r\nMeanings let Crelate reason about pipeline position without depending on custom stage names.\r\nMeanings come from a fixed set of values that are standardized across all organizations.\r\n\r\n| Meaning | Description | GUID Value |\r\n|---|---|---|\r\n| **New** | The record has entered the workflow but has not yet been actively worked. Typically the first or earliest stages. | `249C0D5D-6BF6-4E1F-9D18-A1790104EAE6` |\r\n| **In Progress** | The record is actively being worked through the pipeline. | `7E801283-C05D-4A93-AEBD-A17901061EA7` |\r\n| **Done** | The process has concluded without a clearly positive or negative outcome (e.g., a candidate was hired elsewhere, or an opportunity was closed for unspecified reasons). | `C5909127-002F-494E-B7E2-A179010639BE` |\r\n| **Done — Positive Outcome** | The process concluded successfully (e.g., a candidate was placed, or a deal was won). | `61C3B34C-9B20-45F2-BEBE-A17901065D4A` |\r\n| **Done — Negative Outcome** | The process concluded unsuccessfully (e.g., a candidate was rejected, or a deal was lost). | `0EF86DD1-2131-444C-BD24-A17901067610` |\r\n| **Related** | The record has a relationship to this workflow but is not actively being worked through it. | `586D36FD-10E7-466E-AD99-A1790106893C` |\r\n\r\nUse `MeaningId`, not `Name`, to decide whether a stage is open. \"New\" and \"In Progress\" are open; \"Done\",\r\n\"Done, Positive Outcome\" and \"Done, Negative Outcome\" are closed; \"Related\" is neither.\r\n\r\n## Stage hierarchy\r\n\r\nWorkflow Statuses can be nested. A status with a `ParentId` is a child of another status, forming a grouped view in the Crelate UI.\r\nThe `AllowItemsInParentStage` field on a parent status controls whether records can be placed directly into that parent, or whether they must be placed into one of its children.\r\n\r\n## Visual and display properties\r\n\r\nEach Workflow Status carries display metadata used throughout the Crelate UI:\r\n\r\n- **`Name`** — The label shown to users, up to 50 characters.\r\n- **`Color` / `LightColor` / `DarkColor`** — A color triplet (hex values) used to visually distinguish the stage in pipeline boards and lists.\r\n- **`Icon`** — An optional icon identifier for graphical representation.\r\n- **`SortOrder`** — The position of this status relative to others in the same workflow type and hierarchy level.\r\n- **`Description`** — A short description of the stage, up to 200 characters. When `ShowDescription` is true, this description is surfaced in the Client Portal." } ], "x-tagGroups": [ { "name": "Activities", "tags": [ "Activities", "Activity Types", "Emails", "Notes", "Tasks" ] }, { "name": "Admin", "tags": [ "Backups", "Organizations", "Users", "Webhooks" ] }, { "name": "Core Records", "tags": [ "Academic Honors", "Accreditations", "Accrediting Institutions", "Activities", "Companies", "Company Sources", "Contact Sources", "Contacts", "Countries", "Custom Picklist Items", "Custom Picklist Sets", "Job Titles", "Job Types", "Jobs", "Loss Reason Types", "Opportunity Types", "Pass Reason Types", "Placements", "Relationships" ] }, { "name": "Deliver", "tags": [ "Artifact Types", "Artifacts", "Billable Items", "Expense Types", "Invoices", "Ledger Accounts", "Ledgers", "Payments", "Time Types" ] }, { "name": "Forms", "tags": [ "Form Requests", "Form Responses", "Form Templates", "Forms" ] }, { "name": "Hire", "tags": [ "Worksites" ] }, { "name": "Lists", "tags": [ "Lists" ] }, { "name": "Recruit", "tags": [ "Applications", "Losses", "Tag Categories", "Tags" ] }, { "name": "Workflows", "tags": [ "Workflow Actions", "Workflow Statuses" ] } ], "x-crelate-mcp": { "exposurePolicy": "opt-in", "defaultInject": [ { "target": "header", "name": "X-Api-Key", "from": "auth.upstreamCredential" } ] } }