Candidate Tags

An association between a candidate and a corresponding tag for which the candidate has

Create a candidate tag

POST https://endorsed.ai/api/v1/candidate_tags

Creates a new candidate tag and returns the candidate tag's UUID id. Tags are also unique by the following fields (candidate_id, tag_id, and creation_method) 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
candidate_id*	string	The Candidate UUID from the /candidates entity resource.
tag_id*	string	The Tag UUID from the /tags entity resource.
creation_method*	string	The type of the method the candidate tag was created by: custom_input_by_candidate , selected_by_organization , or auto_generated_by_endorsed

201 Successfully created

{
  "is_error": false,
  "result": {
    "id": "b49fe98f-859d-4da1-92ac-d0a83c2816fa"
  }
}

401 Unauthorized

{
  "is_error": true,
  "error": {
    "code": "UNAUTHENTICATED",
    "issues": [
      {
        "message": "Resource requires authentication. Please provide a valid access token."
      }
    ]
  }
}

500: Internal Server Error

{
  "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

curl -X POST "${BASE_URL}/api/v1/candidate_tags" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${ACCESS_TOKEN}" \
-d '{
  "candidate_id": "172a09e0-9983-44df-a5ae-cd7cc2624cbd",
  "tag_id": "6b7061fd-634f-4b89-bb90-9cc182cd0c6d",
  "creation_method": "custom_input_by_candidate"
}'

Get an existing candidate tag

GET https://endorsed.ai/api/v1/candidate_tags/{id}

Get an existing candidate tag by it's UUID id.

Path Parameters

Name	Type	Description
id*	string	UUID id of the candidate tag

Headers

Name	Type	Description
Authorization*	string	Authorization header containing the Bearer Access Token from the /auth/tokens endpoint. Example: Bearer <ACCESS_TOKEN>

200 Successfully fetched

{
  "is_error": false,
  "result": {
    "id": "b49fe98f-859d-4da1-92ac-d0a83c2816fa",
    "candidate_id": "172a09e0-9983-44df-a5ae-cd7cc2624cbd",
    "tag_id": "6b7061fd-634f-4b89-bb90-9cc182cd0c6d",
    "creation_method": "custom_input_by_candidate",
    "created_at": "2023-09-25T22:06:01.000Z"
  }
}

401 Unauthorized

{
  "is_error": true,
  "error": {
    "code": "UNAUTHENTICATED",
    "issues": [
      {
        "message": "Resource requires authentication. Please provide a valid access token."
      }
    ]
  }
}

403: Forbidden Permission denied

{
  "is_error": true,
  "error": {
    "code": "FORBIDDEN",
    "issues": [
      {
        "message": "Access to this resource is not authorized."
      }
    ]
  }
}

404: Not Found

{
  "is_error": true,
  "error": {
    "code": "NOT_FOUND",
    "issues": [
      {
        "message": "This resource entity does not exist."
      }
    ]
  }
}

500: Internal Server Error

{
  "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

curl -X GET "${BASE_URL}/api/v1/candidate_tags/b49fe98f-859d-4da1-92ac-d0a83c2816fa" \
-H "Authorization: Bearer ${ACCESS_TOKEN}"

Delete an existing candidate tag

DELETE https://endorsed.ai/api/v1/candidate_tags/{id}

Deletes an existing candidate tag by it's UUID id.

Path Parameters

Name	Type	Description
id*	string	UUID id of the candidate tag

Headers

Name	Type	Description
Authorization*	string	Authorization header containing the Bearer Access Token from the /auth/tokens endpoint. Example: Bearer <ACCESS_TOKEN>

200 Successfully updated

{
  "is_error": false,
  "result": {
    "id": "b49fe98f-859d-4da1-92AC-d0a83c2816fa"
  }
}

401 Unauthorized

{
  "is_error": true,
  "error": {
    "code": "UNAUTHENTICATED",
    "issues": [
      {
        "message": "Resource requires authentication. Please provide a valid access token."
      }
    ]
  }
}

403: Forbidden Permission denied

{
  "is_error": true,
  "error": {
    "code": "FORBIDDEN",
    "issues": [
      {
        "message": "Access to this resource is not authorized."
      }
    ]
  }
}

404: Not Found

{
  "is_error": true,
  "error": {
    "code": "NOT_FOUND",
    "issues": [
      {
        "message": "This resource entity does not exist."
      }
    ]
  }
}

500: Internal Server Error

{
  "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

curl -X DELETE "${BASE_URL}/api/v1/candidate_tags/b49fe98f-859d-4da1-92ac-d0a83c2816fa" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${ACCESS_TOKEN}"