API Reference
Log In
API Reference
These docs are for v2.0. Click to read the latest docs for v2.1.

List Labels for Applicant

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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
Path Params
string
required
Defaults to 22222222-0000-0000-0000-000000000000

ID of the applicant

Headers
string
required
Defaults to secret-api-token

Access Token

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json