API endpoints for creating, updating, and deleting tags.

Create Tagpost

copied!
# You can also use wgetcurl -X POST https://api-qa.phenompro.com/tags-api/v1/tags 
-H 'Content-type: application/json' 
-H 'Accept: application/json' 
-H 'Authorization: string' 
-H 'x-ph-userid: string'

POST /tags-api/v1/tags

This API allows you to Create a Tag.

Headers

Name	In	Type	Required
Authorization	header	string	true
x-ph-userid	header	string	true

Body Parameter


copied!
[
  {
    "type": "object",
    "description": "Request object for creating a new tag.",
    "properties": {
      "tagName": {
        "type": "string",
        "description": "The name of the tag to be created."
      }
    },
    "required": {
      "0": "tagName"
    }
  }
]

Request Parameters

Type	Name
application/json	CreateTagRequest

Response

Tag created successfully.


copied!
[
  {
    "type": "object",
    "description": "Response object for the tag creation operation.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the response."
      },
      "message": {
        "type": "string",
        "description": "Human-readable message describing the result of the tag creation."
      },
      "tagName": {
        "type": "string",
        "description": "The name of the tag that was created."
      }
    },
    "required": {
      "0": "status",
      "1": "message",
      "2": "tagName"
    }
  }
]

Bad request — missing or invalid headers or tag name.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Conflict — a tag with the same name already exists.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Internal server error.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Responses

Status	Description	Schema
201	Tag created successfully.	CreateTagResponse
400	Bad request — missing or invalid headers or tag name.	ErrorResponse
409	Conflict — a tag with the same name already exists.	ErrorResponse
500	Internal server error.	ErrorResponse

Get Tagsget

shell

copied!
# You can also use wgetcurl -X GET https://api-qa.phenompro.com/tags-api/v1/tags 
-H 'Content-type: application/json' 
-H 'Accept: application/json' 
-H 'Authorization: string' 
-H 'x-ph-userid: string'

GET /tags-api/v1/tags

This API allows you to get all Tags.

Headers

Name	In	Type	Required
Authorization	header	string	true
x-ph-userid	header	string	true

Parameters

Name	In	Type	Required
from	query	integer	false
size	query	integer	false

Response

Tags retrieved successfully.


copied!
[
  {
    "type": "object",
    "description": "Response object for the get tags operation.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the response."
      },
      "message": {
        "type": "string",
        "description": "Human-readable message describing the result of the get tags operation."
      },
      "from": {
        "type": "integer",
        "description": "Starting index of the returned results."
      },
      "size": {
        "type": "integer",
        "description": "Number of results returned in the response."
      },
      "total": {
        "type": "integer",
        "description": "Total number of tags available."
      },
      "data": {
        "type": "array",
        "description": "List of tag records.",
        "items": {
          "TagListItem": {
            "type": "object",
            "description": "A tag record returned in the get tags response.",
            "properties": {
              "tag": {
                "type": "string",
                "description": "The name of the tag."
              }
            },
            "required": {
              "0": "tag"
            }
          }
        }
      }
    },
    "required": {
      "0": "status",
      "1": "message",
      "2": "from",
      "3": "size",
      "4": "total",
      "5": "data"
    }
  }
]

Bad request — missing or invalid headers or pagination parameters.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Internal server error.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Responses

Status	Description	Schema
200	Tags retrieved successfully.	GetTagsResponse
400	Bad request — missing or invalid headers or pagination parameters.	ErrorResponse
500	Internal server error.	ErrorResponse

Delete the tagdelete

shell

copied!
# You can also use wgetcurl -X DELETE https://api-qa.phenompro.com/tags-api/v1/tags/{tag} 
-H 'Content-type: application/json' 
-H 'Accept: application/json' 
-H 'Authorization: string' 
-H 'x-ph-userid: string'

DELETE /tags-api/v1/tags/{tag}

This API Deletes Tag.

Headers

Name	In	Type	Required
Authorization	header	string	true
x-ph-userid	header	string	true

Parameters

Name	In	Type	Required
tag	path	string	true

Response

Tag deleted successfully.


copied!
[
  {
    "type": "object",
    "description": "Response object for a tag-related operation.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the response."
      },
      "message": {
        "type": "string",
        "description": "Human-readable message describing the result of the tag-related operation."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Bad request — missing or invalid headers or tag name.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Internal server error.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Responses

Status	Description	Schema
200	Tag deleted successfully.	TagResponse
400	Bad request — missing or invalid headers or tag name.	ErrorResponse
500	Internal server error.	ErrorResponse

Update the Tagput

shell

copied!
# You can also use wgetcurl -X PUT https://api-qa.phenompro.com/tags-api/v1/tags/{tag} 
-H 'Content-type: application/json' 
-H 'Accept: application/json' 
-H 'Authorization: string' 
-H 'x-ph-userid: string'

PUT /tags-api/v1/tags/{tag}

This API facilitates to Update the Tag.

Headers

Name	In	Type	Required
Authorization	header	string	true
x-ph-userid	header	string	true

Body Parameter


copied!
[
  {
    "type": "object",
    "description": "Request object for updating a tag.",
    "properties": {
      "newTagName": {
        "type": "string",
        "description": "The new name of the tag."
      }
    },
    "required": {
      "0": "newTagName"
    },
    "example": {
      "newTagName": "UpdatedTagName"
    }
  }
]

Parameters

Name	In	Type	Required
tag	path	string	true

Request Parameters

Type	Name
application/json	UpdateTagRequest

Response

Tag updated successfully.


copied!
[
  {
    "type": "object",
    "description": "Response object for a tag-related operation.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the response."
      },
      "message": {
        "type": "string",
        "description": "Human-readable message describing the result of the tag-related operation."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Bad request — missing or invalid headers, tag name, or new tag name.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Conflict — a tag with the new name already exists.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Internal server error.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Responses

Status	Description	Schema
200	Tag updated successfully.	TagResponse
400	Bad request — missing or invalid headers, tag name, or new tag name.	ErrorResponse
409	Conflict — a tag with the new name already exists.	ErrorResponse
500	Internal server error.	ErrorResponse

API endpoints for associating tags with candidates and querying tag associations.

Associate Tags to Candidatespost

shell

copied!
# You can also use wgetcurl -X POST https://api-qa.phenompro.com/tags-api/v1/tags/candidates 
-H 'Content-type: application/json' 
-H 'Accept: application/json' 
-H 'Authorization: string' 
-H 'x-ph-userid: string'

POST /tags-api/v1/tags/candidates

This API allows you to Associate Tags to Candidates.

Headers

Name	In	Type	Required
Authorization	header	string	true
x-ph-userid	header	string	true

Body Parameter


copied!
[
  {
    "type": "object",
    "description": "Request object for associating tags with candidate IDs.",
    "properties": {
      "candidateIds": {
        "type": "array",
        "description": "An array of candidate IDs to be associated with the specified tags.",
        "items": {
          "type": "string"
        }
      },
      "tags": {
        "type": "array",
        "description": "An array of tags to be associated with the specified candidates.",
        "items": {
          "type": "string"
        }
      }
    },
    "required": {
      "0": "candidateIds",
      "1": "tags"
    }
  }
]

Request Parameters

Type	Name
application/json	CandidateTagsAssociation

Response

Tags successfully associated with candidates.


copied!
[
  {
    "type": "object",
    "description": "Response object for a tag-related operation.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the response."
      },
      "message": {
        "type": "string",
        "description": "Human-readable message describing the result of the tag-related operation."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Bad request — missing or invalid headers, candidate IDs, or tag names.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Conflict — one or more tag associations already exist.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Internal server error.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Responses

Status	Description	Schema
201	Tags successfully associated with candidates.	TagResponse
400	Bad request — missing or invalid headers, candidate IDs, or tag names.	ErrorResponse
409	Conflict — one or more tag associations already exist.	ErrorResponse
500	Internal server error.	ErrorResponse

Remove Tags from candidatespost

shell

copied!
# You can also use wgetcurl -X POST https://api-qa.phenompro.com/tags-api/v1/tags/candidates/delete 
-H 'Content-type: application/json' 
-H 'Accept: application/json' 
-H 'Authorization: string' 
-H 'x-ph-userid: string'

POST /tags-api/v1/tags/candidates/delete

This API allows you to Remove tags from Candidates.

Headers

Name	In	Type	Required
Authorization	header	string	true
x-ph-userid	header	string	true

Body Parameter


copied!
[
  {
    "type": "object",
    "description": "Request object for associating tags with candidate IDs.",
    "properties": {
      "candidateIds": {
        "type": "array",
        "description": "An array of candidate IDs to be associated with the specified tags.",
        "items": {
          "type": "string"
        }
      },
      "tags": {
        "type": "array",
        "description": "An array of tags to be associated with the specified candidates.",
        "items": {
          "type": "string"
        }
      }
    },
    "required": {
      "0": "candidateIds",
      "1": "tags"
    }
  }
]

Request Parameters

Type	Name
application/json	CandidateTagsAssociation

Response

Tags successfully removed from candidates.


copied!
[
  {
    "type": "object",
    "description": "Response object for a tag-related operation.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the response."
      },
      "message": {
        "type": "string",
        "description": "Human-readable message describing the result of the tag-related operation."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Bad request — missing or invalid headers, candidate IDs, or tag names.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Internal server error.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Responses

Status	Description	Schema
200	Tags successfully removed from candidates.	TagResponse
400	Bad request — missing or invalid headers, candidate IDs, or tag names.	ErrorResponse
500	Internal server error.	ErrorResponse

Get CandidateIds for Tagget

shell

copied!
# You can also use wgetcurl -X GET https://api-qa.phenompro.com/tags-api/v1/tags/{tag}/candidates 
-H 'Content-type: application/json' 
-H 'Accept: application/json' 
-H 'Authorization: string' 
-H 'x-ph-userid: string'

GET /tags-api/v1/tags/{tag}/candidates

This API allows you to get all CandidateIds for given Tag.

Headers

Name	In	Type	Required
Authorization	header	string	true
x-ph-userid	header	string	true

Parameters

Name	In	Type	Required
tag	path	string	true
from	query	integer	false
size	query	integer	false

Response

Candidate IDs retrieved successfully. Returns an empty list when no candidates are associated with the tag.


copied!
[
  {
    "type": "object",
    "description": "Response object for retrieving candidate IDs associated with a tag.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the response."
      },
      "message": {
        "type": "string",
        "description": "Human-readable message describing the result."
      },
      "data": {
        "type": "array",
        "description": "List of candidate ID records for the requested tag.",
        "items": {
          "TagCandidateIdItem": {
            "type": "object",
            "description": "A candidate ID associated with the requested tag.",
            "properties": {
              "candidateId": {
                "type": "string",
                "description": "Unique identifier of the candidate."
              }
            },
            "required": {
              "0": "candidateId"
            }
          }
        }
      },
      "from": {
        "type": "integer",
        "description": "Starting index of the returned results."
      },
      "size": {
        "type": "integer",
        "description": "Number of results returned in the response."
      },
      "total": {
        "type": "integer",
        "description": "Total number of results matching the query."
      }
    },
    "required": {
      "0": "status",
      "1": "message",
      "2": "data",
      "3": "from",
      "4": "size",
      "5": "total"
    }
  }
]

Bad request — missing or invalid headers, tag name, or pagination parameters.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Internal server error.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Responses

Status	Description	Schema
200	Candidate IDs retrieved successfully. Returns an empty list when no candidates are associated with the tag.	GetTagAssociationsResponse
400	Bad request — missing or invalid headers, tag name, or pagination parameters.	ErrorResponse
500	Internal server error.	ErrorResponse

Get tags for Candidateget

shell

copied!
# You can also use wgetcurl -X GET https://api-qa.phenompro.com/tags-api/v1/candidates/{candidateId}/tags 
-H 'Content-type: application/json' 
-H 'Accept: application/json' 
-H 'Authorization: string' 
-H 'x-ph-userid: string'

GET /tags-api/v1/candidates/{candidateId}/tags

This API allows you to get all tags for given Candidate.

Headers

Name	In	Type	Required
Authorization	header	string	true
x-ph-userid	header	string	true

Parameters

Name	In	Type	Required
candidateId	path	string	true
from	query	integer	false
size	query	integer	false

Response

Tags retrieved successfully. Returns an empty list when the candidate has no associated tags.


copied!
[
  {
    "type": "object",
    "description": "Response object for retrieving tags associated with a candidate.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the response."
      },
      "message": {
        "type": "string",
        "description": "Human-readable message describing the result."
      },
      "data": {
        "type": "array",
        "description": "List of tag records for the requested candidate.",
        "items": {
          "CandidateTagItem": {
            "type": "object",
            "description": "A tag associated with the requested candidate.",
            "properties": {
              "tag": {
                "type": "string",
                "description": "Name of the tag."
              }
            },
            "required": {
              "0": "tag"
            }
          }
        }
      },
      "from": {
        "type": "integer",
        "description": "Starting index of the returned results."
      },
      "size": {
        "type": "integer",
        "description": "Number of results returned in the response."
      },
      "total": {
        "type": "integer",
        "description": "Total number of results matching the query."
      }
    },
    "required": {
      "0": "status",
      "1": "message",
      "2": "data",
      "3": "from",
      "4": "size",
      "5": "total"
    }
  }
]

Bad request — missing or invalid headers, candidate ID, or pagination parameters.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Internal server error.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Responses

Status	Description	Schema
200	Tags retrieved successfully. Returns an empty list when the candidate has no associated tags.	GetCandidateAssociationsResponse
400	Bad request — missing or invalid headers, candidate ID, or pagination parameters.	ErrorResponse
500	Internal server error.	ErrorResponse

Schemas

TagCandidateIdItem


copied!
{
  "type": "object",
  "description": "A candidate ID associated with the requested tag.",
  "properties": {
    "candidateId": {
      "type": "string",
      "description": "Unique identifier of the candidate."
    }
  },
  "required": [
    "candidateId"
  ]
}

Properties

Name	Type	Description
candidateId	string	Unique identifier of the candidate.

CandidateTagItem


copied!
{
  "type": "object",
  "description": "A tag associated with the requested candidate.",
  "properties": {
    "tag": {
      "type": "string",
      "description": "Name of the tag."
    }
  },
  "required": [
    "tag"
  ]
}

Properties

Name	Type	Description
tag	string	Name of the tag.

GetTagAssociationsResponse


copied!
{
  "type": "object",
  "description": "Response object for retrieving candidate IDs associated with a tag.",
  "properties": {
    "status": {
      "type": "integer",
      "description": "HTTP status code of the response."
    },
    "message": {
      "type": "string",
      "description": "Human-readable message describing the result."
    },
    "data": {
      "type": "array",
      "description": "List of candidate ID records for the requested tag.",
      "items": {
        "TagCandidateIdItem": {
          "type": "object",
          "description": "A candidate ID associated with the requested tag.",
          "properties": {
            "candidateId": {
              "type": "string",
              "description": "Unique identifier of the candidate."
            }
          },
          "required": [
            "candidateId"
          ]
        }
      }
    },
    "from": {
      "type": "integer",
      "description": "Starting index of the returned results."
    },
    "size": {
      "type": "integer",
      "description": "Number of results returned in the response."
    },
    "total": {
      "type": "integer",
      "description": "Total number of results matching the query."
    }
  },
  "required": [
    "status",
    "message",
    "data",
    "from",
    "size",
    "total"
  ]
}

Properties

Name	Type	Description
status	integer	HTTP status code of the response.
message	string	Human-readable message describing the result.
data	array	TagCandidateIdItem
from	integer	Starting index of the returned results.
size	integer	Number of results returned in the response.
total	integer	Total number of results matching the query.

GetCandidateAssociationsResponse


copied!
{
  "type": "object",
  "description": "Response object for retrieving tags associated with a candidate.",
  "properties": {
    "status": {
      "type": "integer",
      "description": "HTTP status code of the response."
    },
    "message": {
      "type": "string",
      "description": "Human-readable message describing the result."
    },
    "data": {
      "type": "array",
      "description": "List of tag records for the requested candidate.",
      "items": {
        "CandidateTagItem": {
          "type": "object",
          "description": "A tag associated with the requested candidate.",
          "properties": {
            "tag": {
              "type": "string",
              "description": "Name of the tag."
            }
          },
          "required": [
            "tag"
          ]
        }
      }
    },
    "from": {
      "type": "integer",
      "description": "Starting index of the returned results."
    },
    "size": {
      "type": "integer",
      "description": "Number of results returned in the response."
    },
    "total": {
      "type": "integer",
      "description": "Total number of results matching the query."
    }
  },
  "required": [
    "status",
    "message",
    "data",
    "from",
    "size",
    "total"
  ]
}

Properties

Name	Type	Description
status	integer	HTTP status code of the response.
message	string	Human-readable message describing the result.
data	array	CandidateTagItem
from	integer	Starting index of the returned results.
size	integer	Number of results returned in the response.
total	integer	Total number of results matching the query.

UpdateTagRequest


copied!
{
  "type": "object",
  "description": "Request object for updating a tag.",
  "properties": {
    "newTagName": {
      "type": "string",
      "description": "The new name of the tag."
    }
  },
  "required": [
    "newTagName"
  ],
  "example": {
    "newTagName": "UpdatedTagName"
  }
}

Properties

Name	Type	Description
newTagName	string	The new name of the tag.

CreateTagRequest


copied!
{
  "type": "object",
  "description": "Request object for creating a new tag.",
  "properties": {
    "tagName": {
      "type": "string",
      "description": "The name of the tag to be created."
    }
  },
  "required": [
    "tagName"
  ]
}

Properties

Name	Type	Description
tagName	string	The name of the tag to be created.

CreateTagResponse


copied!
{
  "type": "object",
  "description": "Response object for the tag creation operation.",
  "properties": {
    "status": {
      "type": "integer",
      "description": "HTTP status code of the response."
    },
    "message": {
      "type": "string",
      "description": "Human-readable message describing the result of the tag creation."
    },
    "tagName": {
      "type": "string",
      "description": "The name of the tag that was created."
    }
  },
  "required": [
    "status",
    "message",
    "tagName"
  ]
}

Properties

Name	Type	Description
status	integer	HTTP status code of the response.
message	string	Human-readable message describing the result of the tag creation.
tagName	string	The name of the tag that was created.

GetTagsResponse


copied!
{
  "type": "object",
  "description": "Response object for the get tags operation.",
  "properties": {
    "status": {
      "type": "integer",
      "description": "HTTP status code of the response."
    },
    "message": {
      "type": "string",
      "description": "Human-readable message describing the result of the get tags operation."
    },
    "from": {
      "type": "integer",
      "description": "Starting index of the returned results."
    },
    "size": {
      "type": "integer",
      "description": "Number of results returned in the response."
    },
    "total": {
      "type": "integer",
      "description": "Total number of tags available."
    },
    "data": {
      "type": "array",
      "description": "List of tag records.",
      "items": {
        "TagListItem": {
          "type": "object",
          "description": "A tag record returned in the get tags response.",
          "properties": {
            "tag": {
              "type": "string",
              "description": "The name of the tag."
            }
          },
          "required": [
            "tag"
          ]
        }
      }
    }
  },
  "required": [
    "status",
    "message",
    "from",
    "size",
    "total",
    "data"
  ]
}

Properties

Name	Type	Description
status	integer	HTTP status code of the response.
message	string	Human-readable message describing the result of the get tags operation.
from	integer	Starting index of the returned results.
size	integer	Number of results returned in the response.
total	integer	Total number of tags available.
data	array	TagListItem

TagListItem


copied!
{
  "type": "object",
  "description": "A tag record returned in the get tags response.",
  "properties": {
    "tag": {
      "type": "string",
      "description": "The name of the tag."
    }
  },
  "required": [
    "tag"
  ]
}

Properties

Name	Type	Description
tag	string	The name of the tag.

TagResponse


copied!
{
  "type": "object",
  "description": "Response object for a tag-related operation.",
  "properties": {
    "status": {
      "type": "integer",
      "description": "HTTP status code of the response."
    },
    "message": {
      "type": "string",
      "description": "Human-readable message describing the result of the tag-related operation."
    }
  },
  "required": [
    "status",
    "message"
  ]
}

Properties

Name	Type	Description
status	integer	HTTP status code of the response.
message	string	Human-readable message describing the result of the tag-related operation.

CandidateTagsAssociation


copied!
{
  "type": "object",
  "description": "Request object for associating tags with candidate IDs.",
  "properties": {
    "candidateIds": {
      "type": "array",
      "description": "An array of candidate IDs to be associated with the specified tags.",
      "items": {
        "type": "string"
      }
    },
    "tags": {
      "type": "array",
      "description": "An array of tags to be associated with the specified candidates.",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "candidateIds",
    "tags"
  ]
}

Properties

Name	Type	Description
candidateIds	[string]	An array of candidate IDs to be associated with the specified tags.
tags	[string]	An array of tags to be associated with the specified candidates.

ErrorResponse


copied!
{
  "type": "object",
  "description": "Standard error response returned for all 4xx and 5xx responses.",
  "properties": {
    "status": {
      "type": "integer",
      "description": "HTTP status code of the error."
    },
    "message": {
      "type": "string",
      "description": "Human-readable description of the error."
    }
  },
  "required": [
    "status",
    "message"
  ]
}

Properties

Name	Type	Description
status	integer	HTTP status code of the error.
message	string	Human-readable description of the error.

API endpoints for creating, updating, and deleting tags.

Create Tagpost

shell

copied!
# You can also use wgetcurl -X POST https://api-qa.phenompro.com/tags-api/v1/tags 
-H 'Content-type: application/json' 
-H 'Accept: application/json' 
-H 'Authorization: string' 
-H 'x-ph-userid: string'

POST /tags-api/v1/tags

This API allows you to Create a Tag.

Headers

Name	In	Type	Required
Authorization	header	string	true
x-ph-userid	header	string	true

Body Parameter


copied!
[
  {
    "type": "object",
    "description": "Request object for creating a new tag.",
    "properties": {
      "tagName": {
        "type": "string",
        "description": "The name of the tag to be created."
      }
    },
    "required": {
      "0": "tagName"
    }
  }
]

Request Parameters

Type	Name
application/json	CreateTagRequest

Response

Tag created successfully.


copied!
[
  {
    "type": "object",
    "description": "Response object for the tag creation operation.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the response."
      },
      "message": {
        "type": "string",
        "description": "Human-readable message describing the result of the tag creation."
      },
      "tagName": {
        "type": "string",
        "description": "The name of the tag that was created."
      }
    },
    "required": {
      "0": "status",
      "1": "message",
      "2": "tagName"
    }
  }
]

Bad request — missing or invalid headers or tag name.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Conflict — a tag with the same name already exists.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Internal server error.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Responses

Status	Description	Schema
201	Tag created successfully.	CreateTagResponse
400	Bad request — missing or invalid headers or tag name.	ErrorResponse
409	Conflict — a tag with the same name already exists.	ErrorResponse
500	Internal server error.	ErrorResponse

Get Tagsget

shell

copied!
# You can also use wgetcurl -X GET https://api-qa.phenompro.com/tags-api/v1/tags 
-H 'Content-type: application/json' 
-H 'Accept: application/json' 
-H 'Authorization: string' 
-H 'x-ph-userid: string'

GET /tags-api/v1/tags

This API allows you to get all Tags.

Headers

Name	In	Type	Required
Authorization	header	string	true
x-ph-userid	header	string	true

Parameters

Name	In	Type	Required
from	query	integer	false
size	query	integer	false

Response

Tags retrieved successfully.


copied!
[
  {
    "type": "object",
    "description": "Response object for the get tags operation.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the response."
      },
      "message": {
        "type": "string",
        "description": "Human-readable message describing the result of the get tags operation."
      },
      "from": {
        "type": "integer",
        "description": "Starting index of the returned results."
      },
      "size": {
        "type": "integer",
        "description": "Number of results returned in the response."
      },
      "total": {
        "type": "integer",
        "description": "Total number of tags available."
      },
      "data": {
        "type": "array",
        "description": "List of tag records.",
        "items": {
          "TagListItem": {
            "type": "object",
            "description": "A tag record returned in the get tags response.",
            "properties": {
              "tag": {
                "type": "string",
                "description": "The name of the tag."
              }
            },
            "required": {
              "0": "tag"
            }
          }
        }
      }
    },
    "required": {
      "0": "status",
      "1": "message",
      "2": "from",
      "3": "size",
      "4": "total",
      "5": "data"
    }
  }
]

Bad request — missing or invalid headers or pagination parameters.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Internal server error.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Responses

Status	Description	Schema
200	Tags retrieved successfully.	GetTagsResponse
400	Bad request — missing or invalid headers or pagination parameters.	ErrorResponse
500	Internal server error.	ErrorResponse

Delete the tagdelete

shell

copied!
# You can also use wgetcurl -X DELETE https://api-qa.phenompro.com/tags-api/v1/tags/{tag} 
-H 'Content-type: application/json' 
-H 'Accept: application/json' 
-H 'Authorization: string' 
-H 'x-ph-userid: string'

DELETE /tags-api/v1/tags/{tag}

This API Deletes Tag.

Headers

Name	In	Type	Required
Authorization	header	string	true
x-ph-userid	header	string	true

Parameters

Name	In	Type	Required
tag	path	string	true

Response

Tag deleted successfully.


copied!
[
  {
    "type": "object",
    "description": "Response object for a tag-related operation.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the response."
      },
      "message": {
        "type": "string",
        "description": "Human-readable message describing the result of the tag-related operation."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Bad request — missing or invalid headers or tag name.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Internal server error.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Responses

Status	Description	Schema
200	Tag deleted successfully.	TagResponse
400	Bad request — missing or invalid headers or tag name.	ErrorResponse
500	Internal server error.	ErrorResponse

Update the Tagput

shell

copied!
# You can also use wgetcurl -X PUT https://api-qa.phenompro.com/tags-api/v1/tags/{tag} 
-H 'Content-type: application/json' 
-H 'Accept: application/json' 
-H 'Authorization: string' 
-H 'x-ph-userid: string'

PUT /tags-api/v1/tags/{tag}

This API facilitates to Update the Tag.

Headers

Name	In	Type	Required
Authorization	header	string	true
x-ph-userid	header	string	true

Body Parameter


copied!
[
  {
    "type": "object",
    "description": "Request object for updating a tag.",
    "properties": {
      "newTagName": {
        "type": "string",
        "description": "The new name of the tag."
      }
    },
    "required": {
      "0": "newTagName"
    },
    "example": {
      "newTagName": "UpdatedTagName"
    }
  }
]

Parameters

Name	In	Type	Required
tag	path	string	true

Request Parameters

Type	Name
application/json	UpdateTagRequest

Response

Tag updated successfully.


copied!
[
  {
    "type": "object",
    "description": "Response object for a tag-related operation.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the response."
      },
      "message": {
        "type": "string",
        "description": "Human-readable message describing the result of the tag-related operation."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Bad request — missing or invalid headers, tag name, or new tag name.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Conflict — a tag with the new name already exists.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Internal server error.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Responses

Status	Description	Schema
200	Tag updated successfully.	TagResponse
400	Bad request — missing or invalid headers, tag name, or new tag name.	ErrorResponse
409	Conflict — a tag with the new name already exists.	ErrorResponse
500	Internal server error.	ErrorResponse

API endpoints for associating tags with candidates and querying tag associations.

Associate Tags to Candidatespost

shell

copied!
# You can also use wgetcurl -X POST https://api-qa.phenompro.com/tags-api/v1/tags/candidates 
-H 'Content-type: application/json' 
-H 'Accept: application/json' 
-H 'Authorization: string' 
-H 'x-ph-userid: string'

POST /tags-api/v1/tags/candidates

This API allows you to Associate Tags to Candidates.

Headers

Name	In	Type	Required
Authorization	header	string	true
x-ph-userid	header	string	true

Body Parameter


copied!
[
  {
    "type": "object",
    "description": "Request object for associating tags with candidate IDs.",
    "properties": {
      "candidateIds": {
        "type": "array",
        "description": "An array of candidate IDs to be associated with the specified tags.",
        "items": {
          "type": "string"
        }
      },
      "tags": {
        "type": "array",
        "description": "An array of tags to be associated with the specified candidates.",
        "items": {
          "type": "string"
        }
      }
    },
    "required": {
      "0": "candidateIds",
      "1": "tags"
    }
  }
]

Request Parameters

Type	Name
application/json	CandidateTagsAssociation

Response

Tags successfully associated with candidates.


copied!
[
  {
    "type": "object",
    "description": "Response object for a tag-related operation.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the response."
      },
      "message": {
        "type": "string",
        "description": "Human-readable message describing the result of the tag-related operation."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Bad request — missing or invalid headers, candidate IDs, or tag names.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Conflict — one or more tag associations already exist.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Internal server error.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Responses

Status	Description	Schema
201	Tags successfully associated with candidates.	TagResponse
400	Bad request — missing or invalid headers, candidate IDs, or tag names.	ErrorResponse
409	Conflict — one or more tag associations already exist.	ErrorResponse
500	Internal server error.	ErrorResponse

Remove Tags from candidatespost

shell

copied!
# You can also use wgetcurl -X POST https://api-qa.phenompro.com/tags-api/v1/tags/candidates/delete 
-H 'Content-type: application/json' 
-H 'Accept: application/json' 
-H 'Authorization: string' 
-H 'x-ph-userid: string'

POST /tags-api/v1/tags/candidates/delete

This API allows you to Remove tags from Candidates.

Headers

Name	In	Type	Required
Authorization	header	string	true
x-ph-userid	header	string	true

Body Parameter


copied!
[
  {
    "type": "object",
    "description": "Request object for associating tags with candidate IDs.",
    "properties": {
      "candidateIds": {
        "type": "array",
        "description": "An array of candidate IDs to be associated with the specified tags.",
        "items": {
          "type": "string"
        }
      },
      "tags": {
        "type": "array",
        "description": "An array of tags to be associated with the specified candidates.",
        "items": {
          "type": "string"
        }
      }
    },
    "required": {
      "0": "candidateIds",
      "1": "tags"
    }
  }
]

Request Parameters

Type	Name
application/json	CandidateTagsAssociation

Response

Tags successfully removed from candidates.


copied!
[
  {
    "type": "object",
    "description": "Response object for a tag-related operation.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the response."
      },
      "message": {
        "type": "string",
        "description": "Human-readable message describing the result of the tag-related operation."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Bad request — missing or invalid headers, candidate IDs, or tag names.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Internal server error.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Responses

Status	Description	Schema
200	Tags successfully removed from candidates.	TagResponse
400	Bad request — missing or invalid headers, candidate IDs, or tag names.	ErrorResponse
500	Internal server error.	ErrorResponse

Get CandidateIds for Tagget

shell

copied!
# You can also use wgetcurl -X GET https://api-qa.phenompro.com/tags-api/v1/tags/{tag}/candidates 
-H 'Content-type: application/json' 
-H 'Accept: application/json' 
-H 'Authorization: string' 
-H 'x-ph-userid: string'

GET /tags-api/v1/tags/{tag}/candidates

This API allows you to get all CandidateIds for given Tag.

Headers

Name	In	Type	Required
Authorization	header	string	true
x-ph-userid	header	string	true

Parameters

Name	In	Type	Required
tag	path	string	true
from	query	integer	false
size	query	integer	false

Response

Candidate IDs retrieved successfully. Returns an empty list when no candidates are associated with the tag.


copied!
[
  {
    "type": "object",
    "description": "Response object for retrieving candidate IDs associated with a tag.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the response."
      },
      "message": {
        "type": "string",
        "description": "Human-readable message describing the result."
      },
      "data": {
        "type": "array",
        "description": "List of candidate ID records for the requested tag.",
        "items": {
          "TagCandidateIdItem": {
            "type": "object",
            "description": "A candidate ID associated with the requested tag.",
            "properties": {
              "candidateId": {
                "type": "string",
                "description": "Unique identifier of the candidate."
              }
            },
            "required": {
              "0": "candidateId"
            }
          }
        }
      },
      "from": {
        "type": "integer",
        "description": "Starting index of the returned results."
      },
      "size": {
        "type": "integer",
        "description": "Number of results returned in the response."
      },
      "total": {
        "type": "integer",
        "description": "Total number of results matching the query."
      }
    },
    "required": {
      "0": "status",
      "1": "message",
      "2": "data",
      "3": "from",
      "4": "size",
      "5": "total"
    }
  }
]

Bad request — missing or invalid headers, tag name, or pagination parameters.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Internal server error.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Responses

Status	Description	Schema
200	Candidate IDs retrieved successfully. Returns an empty list when no candidates are associated with the tag.	GetTagAssociationsResponse
400	Bad request — missing or invalid headers, tag name, or pagination parameters.	ErrorResponse
500	Internal server error.	ErrorResponse

Get tags for Candidateget

shell

copied!
# You can also use wgetcurl -X GET https://api-qa.phenompro.com/tags-api/v1/candidates/{candidateId}/tags 
-H 'Content-type: application/json' 
-H 'Accept: application/json' 
-H 'Authorization: string' 
-H 'x-ph-userid: string'

GET /tags-api/v1/candidates/{candidateId}/tags

This API allows you to get all tags for given Candidate.

Headers

Name	In	Type	Required
Authorization	header	string	true
x-ph-userid	header	string	true

Parameters

Name	In	Type	Required
candidateId	path	string	true
from	query	integer	false
size	query	integer	false

Response

Tags retrieved successfully. Returns an empty list when the candidate has no associated tags.


copied!
[
  {
    "type": "object",
    "description": "Response object for retrieving tags associated with a candidate.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the response."
      },
      "message": {
        "type": "string",
        "description": "Human-readable message describing the result."
      },
      "data": {
        "type": "array",
        "description": "List of tag records for the requested candidate.",
        "items": {
          "CandidateTagItem": {
            "type": "object",
            "description": "A tag associated with the requested candidate.",
            "properties": {
              "tag": {
                "type": "string",
                "description": "Name of the tag."
              }
            },
            "required": {
              "0": "tag"
            }
          }
        }
      },
      "from": {
        "type": "integer",
        "description": "Starting index of the returned results."
      },
      "size": {
        "type": "integer",
        "description": "Number of results returned in the response."
      },
      "total": {
        "type": "integer",
        "description": "Total number of results matching the query."
      }
    },
    "required": {
      "0": "status",
      "1": "message",
      "2": "data",
      "3": "from",
      "4": "size",
      "5": "total"
    }
  }
]

Bad request — missing or invalid headers, candidate ID, or pagination parameters.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Internal server error.


copied!
[
  {
    "type": "object",
    "description": "Standard error response returned for all 4xx and 5xx responses.",
    "properties": {
      "status": {
        "type": "integer",
        "description": "HTTP status code of the error."
      },
      "message": {
        "type": "string",
        "description": "Human-readable description of the error."
      }
    },
    "required": {
      "0": "status",
      "1": "message"
    }
  }
]

Responses

Status	Description	Schema
200	Tags retrieved successfully. Returns an empty list when the candidate has no associated tags.	GetCandidateAssociationsResponse
400	Bad request — missing or invalid headers, candidate ID, or pagination parameters.	ErrorResponse
500	Internal server error.	ErrorResponse

Schemas

TagCandidateIdItem


copied!
{
  "type": "object",
  "description": "A candidate ID associated with the requested tag.",
  "properties": {
    "candidateId": {
      "type": "string",
      "description": "Unique identifier of the candidate."
    }
  },
  "required": [
    "candidateId"
  ]
}

Properties

Name	Type	Description
candidateId	string	Unique identifier of the candidate.

CandidateTagItem


copied!
{
  "type": "object",
  "description": "A tag associated with the requested candidate.",
  "properties": {
    "tag": {
      "type": "string",
      "description": "Name of the tag."
    }
  },
  "required": [
    "tag"
  ]
}

Properties

Name	Type	Description
tag	string	Name of the tag.

GetTagAssociationsResponse


copied!
{
  "type": "object",
  "description": "Response object for retrieving candidate IDs associated with a tag.",
  "properties": {
    "status": {
      "type": "integer",
      "description": "HTTP status code of the response."
    },
    "message": {
      "type": "string",
      "description": "Human-readable message describing the result."
    },
    "data": {
      "type": "array",
      "description": "List of candidate ID records for the requested tag.",
      "items": {
        "TagCandidateIdItem": {
          "type": "object",
          "description": "A candidate ID associated with the requested tag.",
          "properties": {
            "candidateId": {
              "type": "string",
              "description": "Unique identifier of the candidate."
            }
          },
          "required": [
            "candidateId"
          ]
        }
      }
    },
    "from": {
      "type": "integer",
      "description": "Starting index of the returned results."
    },
    "size": {
      "type": "integer",
      "description": "Number of results returned in the response."
    },
    "total": {
      "type": "integer",
      "description": "Total number of results matching the query."
    }
  },
  "required": [
    "status",
    "message",
    "data",
    "from",
    "size",
    "total"
  ]
}

Properties

Name	Type	Description
status	integer	HTTP status code of the response.
message	string	Human-readable message describing the result.
data	array	TagCandidateIdItem
from	integer	Starting index of the returned results.
size	integer	Number of results returned in the response.
total	integer	Total number of results matching the query.

GetCandidateAssociationsResponse


copied!
{
  "type": "object",
  "description": "Response object for retrieving tags associated with a candidate.",
  "properties": {
    "status": {
      "type": "integer",
      "description": "HTTP status code of the response."
    },
    "message": {
      "type": "string",
      "description": "Human-readable message describing the result."
    },
    "data": {
      "type": "array",
      "description": "List of tag records for the requested candidate.",
      "items": {
        "CandidateTagItem": {
          "type": "object",
          "description": "A tag associated with the requested candidate.",
          "properties": {
            "tag": {
              "type": "string",
              "description": "Name of the tag."
            }
          },
          "required": [
            "tag"
          ]
        }
      }
    },
    "from": {
      "type": "integer",
      "description": "Starting index of the returned results."
    },
    "size": {
      "type": "integer",
      "description": "Number of results returned in the response."
    },
    "total": {
      "type": "integer",
      "description": "Total number of results matching the query."
    }
  },
  "required": [
    "status",
    "message",
    "data",
    "from",
    "size",
    "total"
  ]
}

Properties

Name	Type	Description
status	integer	HTTP status code of the response.
message	string	Human-readable message describing the result.
data	array	CandidateTagItem
from	integer	Starting index of the returned results.
size	integer	Number of results returned in the response.
total	integer	Total number of results matching the query.

UpdateTagRequest


copied!
{
  "type": "object",
  "description": "Request object for updating a tag.",
  "properties": {
    "newTagName": {
      "type": "string",
      "description": "The new name of the tag."
    }
  },
  "required": [
    "newTagName"
  ],
  "example": {
    "newTagName": "UpdatedTagName"
  }
}

Properties

Name	Type	Description
newTagName	string	The new name of the tag.

CreateTagRequest


copied!
{
  "type": "object",
  "description": "Request object for creating a new tag.",
  "properties": {
    "tagName": {
      "type": "string",
      "description": "The name of the tag to be created."
    }
  },
  "required": [
    "tagName"
  ]
}

Properties

Name	Type	Description
tagName	string	The name of the tag to be created.

CreateTagResponse


copied!
{
  "type": "object",
  "description": "Response object for the tag creation operation.",
  "properties": {
    "status": {
      "type": "integer",
      "description": "HTTP status code of the response."
    },
    "message": {
      "type": "string",
      "description": "Human-readable message describing the result of the tag creation."
    },
    "tagName": {
      "type": "string",
      "description": "The name of the tag that was created."
    }
  },
  "required": [
    "status",
    "message",
    "tagName"
  ]
}

Properties

Name	Type	Description
status	integer	HTTP status code of the response.
message	string	Human-readable message describing the result of the tag creation.
tagName	string	The name of the tag that was created.

GetTagsResponse


copied!
{
  "type": "object",
  "description": "Response object for the get tags operation.",
  "properties": {
    "status": {
      "type": "integer",
      "description": "HTTP status code of the response."
    },
    "message": {
      "type": "string",
      "description": "Human-readable message describing the result of the get tags operation."
    },
    "from": {
      "type": "integer",
      "description": "Starting index of the returned results."
    },
    "size": {
      "type": "integer",
      "description": "Number of results returned in the response."
    },
    "total": {
      "type": "integer",
      "description": "Total number of tags available."
    },
    "data": {
      "type": "array",
      "description": "List of tag records.",
      "items": {
        "TagListItem": {
          "type": "object",
          "description": "A tag record returned in the get tags response.",
          "properties": {
            "tag": {
              "type": "string",
              "description": "The name of the tag."
            }
          },
          "required": [
            "tag"
          ]
        }
      }
    }
  },
  "required": [
    "status",
    "message",
    "from",
    "size",
    "total",
    "data"
  ]
}

Properties

Name	Type	Description
status	integer	HTTP status code of the response.
message	string	Human-readable message describing the result of the get tags operation.
from	integer	Starting index of the returned results.
size	integer	Number of results returned in the response.
total	integer	Total number of tags available.
data	array	TagListItem

TagListItem


copied!
{
  "type": "object",
  "description": "A tag record returned in the get tags response.",
  "properties": {
    "tag": {
      "type": "string",
      "description": "The name of the tag."
    }
  },
  "required": [
    "tag"
  ]
}

Properties

Name	Type	Description
tag	string	The name of the tag.

TagResponse


copied!
{
  "type": "object",
  "description": "Response object for a tag-related operation.",
  "properties": {
    "status": {
      "type": "integer",
      "description": "HTTP status code of the response."
    },
    "message": {
      "type": "string",
      "description": "Human-readable message describing the result of the tag-related operation."
    }
  },
  "required": [
    "status",
    "message"
  ]
}

Properties

Name	Type	Description
status	integer	HTTP status code of the response.
message	string	Human-readable message describing the result of the tag-related operation.

CandidateTagsAssociation


copied!
{
  "type": "object",
  "description": "Request object for associating tags with candidate IDs.",
  "properties": {
    "candidateIds": {
      "type": "array",
      "description": "An array of candidate IDs to be associated with the specified tags.",
      "items": {
        "type": "string"
      }
    },
    "tags": {
      "type": "array",
      "description": "An array of tags to be associated with the specified candidates.",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "candidateIds",
    "tags"
  ]
}

Properties

Name	Type	Description
candidateIds	[string]	An array of candidate IDs to be associated with the specified tags.
tags	[string]	An array of tags to be associated with the specified candidates.

ErrorResponse


copied!
{
  "type": "object",
  "description": "Standard error response returned for all 4xx and 5xx responses.",
  "properties": {
    "status": {
      "type": "integer",
      "description": "HTTP status code of the error."
    },
    "message": {
      "type": "string",
      "description": "Human-readable description of the error."
    }
  },
  "required": [
    "status",
    "message"
  ]
}

Properties

Name	Type	Description
status	integer	HTTP status code of the error.
message	string	Human-readable description of the error.