A generic tag that could be be applied to candidates
Create a tag
POSThttps://endorsed.ai/api/v1/tags
Creates a new tag and returns the tag's UUID id. Tags are also unique by the following fields (tag_type, is_standardized, and name) as these fields serve as a composite key in addition to the unique id field.
Headers
Name
Type
Description
Authorization*
string
Authorization header containing the Bearer Access Token from the /auth/tokens endpoint. Example: Bearer <ACCESS_TOKEN>
Content-Type
string
Must be application/json. If not set, defaults to application/json
Request Body
Name
Type
Description
tag_type*
string
The type of the tag:
preferred_role_title
,
experience_based_role_title
, or
specialty_name
is_standardized*
boolean
Whether the tag is a organization-wide standardized tag (as opposed to generated by users).
{"is_error":true,"error": {"code":"UNAUTHENTICATED","issues": [ {"message":"Resource requires authentication. Please provide a valid access token." } ] }}
{"is_error":true,"error": {"code":"INTERNAL_SERVER_ERROR","issues": [ { "message": "An unexpected error occurred on our end. Please try again later, and if the problem persists, contact our support team"
} ] }}
Examples:
curl-XPOST"${BASE_URL}/api/v1/tags" \-H "Content-Type: application/json" \-H "Authorization: Bearer ${ACCESS_TOKEN}" \-d '{ "tag_type": "specialty_name", "is_standardized": true, "name": "Videographer", "description": "Adept in filming and operating camera equipment"}'
Get an existing tag
GEThttps://endorsed.ai/api/v1/tags/{id}
Get an existing tag by it's UUID id.
Path Parameters
Name
Type
Description
id*
string
UUID id of the tag
Headers
Name
Type
Description
Authorization*
string
Authorization header containing the Bearer Access Token from the /auth/tokens endpoint. Example: Bearer <ACCESS_TOKEN>
{"is_error":false,"result": {"id":"ec8e6d58-65f5-44e5-998C-6b50701164fd","tag_type":"specialty_name","is_standardized":true,"name":"Videographer","description":"Adept in filming and operating camera equipment","created_at":"2023-09-25T22:06:01.000Z" }}
{"is_error":true,"error": {"code":"UNAUTHENTICATED","issues": [ {"message":"Resource requires authentication. Please provide a valid access token." } ] }}
{"is_error":true,"error": {"code":"FORBIDDEN","issues": [ {"message":"Access to this resource is not authorized." } ] }}
{"is_error":true,"error": {"code":"NOT_FOUND","issues": [ {"message":"This resource entity does not exist." } ] }}
{"is_error":true,"error": {"code":"INTERNAL_SERVER_ERROR","issues": [ { "message": "An unexpected error occurred on our end. Please try again later, and if the problem persists, contact our support team"
} ] }}
{"is_error":true,"error": {"code":"UNAUTHENTICATED","issues": [ {"message":"Resource requires authentication. Please provide a valid access token." } ] }}
{"is_error":true,"error": {"code":"FORBIDDEN","issues": [ {"message":"Access to this resource is not authorized." } ] }}
{"is_error":true,"error": {"code":"NOT_FOUND","issues": [ {"message":"This resource entity does not exist." } ] }}
{"is_error":true,"error": {"code":"INTERNAL_SERVER_ERROR","issues": [ { "message": "An unexpected error occurred on our end. Please try again later, and if the problem persists, contact our support team"
} ] }}