List Labels for Applicant

This lists all labels for an applicant.

This way you can perform a quick check to see if the applicant has one label or another.

You can assign them a new label or remove an existing one using the corresponding API methods PUT request

🚧

NOTE: URL Encoding Matters!

The label names that you use in other methods must be URL encoded, e.g. 'New%20label' and not 'New label'.

Response Schema

  • additionalProperties: false
  • labels
    • Required: no
    • Type: array
    • Items
      • Required: no
      • additionalProperties: false
      • title
        • Required: no
        • Type: string
        • Example: "Label 0"
      • completed
        • Required: no
        • Type: boolean
        • Example: true
Language
Click Try It! to start a request and see the response here!