> ## Documentation Index
> Fetch the complete documentation index at: https://docs.jobin.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# List contact tags

> Find tags in your Jobin workgroup to use in contact searches.

Find a tag by name, then pass its `tagId` to the `tagIds` filter when searching contacts.

Each result includes the tag's identifier (`tagId`) and name (`value`).

Use the optional `name` filter to match the beginning of a tag name. Matching is case-sensitive; the filter accepts up to 256 characters.

*Rate limit: 120 requests/minute per endpoint and workgroup. [Details](/development#rate-limits).*


## OpenAPI

````yaml openapi/jobin-integration.json GET /contacts/tags
openapi: 3.1.0
info:
  title: Jobin Integration API
  version: 1.0.0
  description: >-
    Work with Jobin contacts and outreach sequences from your recruiting tools
    and AI assistants. See [integration
    guidelines](https://docs.jobin.cloud/development#rate-limits) for rate
    limits and retries.
servers:
  - url: https://my.jobin.cloud/api/openapi/v1
    description: Public OpenAPI base URL. Append each path below to this base URL.
security: []
paths:
  /contacts/tags:
    get:
      summary: List contact tags
      description: >-
        Downloads contact tags in the authenticated workgroup. Use the optional
        name query parameter for prefix filtering before passing returned tagId
        values to GET /contacts?tagIds=...
      parameters:
        - name: name
          in: query
          description: >-
            Optional case-sensitive tag name prefix. The value is trimmed and
            capped at 256 characters.
          schema:
            type: string
            minLength: 1
            maxLength: 256
        - name: limit
          in: query
          description: >-
            Maximum tags to return. Defaults to 100 and is capped at 500 to keep
            free discovery requests bounded.
          schema:
            type: integer
            minimum: 1
            default: 100
            maximum: 500
      responses:
        '200':
          description: Contact tags for the authenticated workgroup.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactTagListResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/InternalServerError'
        default:
          $ref: '#/components/responses/ApiError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ContactTagListResponse:
      type: object
      description: >-
        All contact tags in the authenticated workgroup that match the optional
        name prefix.
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ContactTagSummary'
        count:
          type: integer
          description: Number of tags returned.
    ContactTagSummary:
      type: object
      description: Minimal contact tag metadata exposed for integration filtering.
      additionalProperties: false
      required:
        - tagId
        - value
      properties:
        tagId:
          type: string
          description: Identifier to pass as tagIds when filtering contacts.
        value:
          type: string
          description: Tag label shown in Jobin.
    Error:
      type: object
      required:
        - code
        - error
      properties:
        code:
          type: string
          description: Stable error code. Input validation uses VALIDATION_ERROR.
        error:
          type: string
          description: >-
            User-facing message. Unknown failures return a generic message
            without internal details.
      example:
        code: UNHANDLED_EXCEPTION
        error: Unexpected error
    RateLimitError:
      type: object
      description: Returned when a public OpenAPI rate limit is exceeded.
      properties:
        statusCode:
          type: integer
          example: 429
        error:
          type: string
          example: Too Many Requests
        message:
          type: string
          description: Human-readable description of the limit that was exceeded.
        retryAfterSeconds:
          type: integer
          description: Seconds to wait before retrying the request.
  responses:
    BadRequest:
      description: Invalid request or expected business-rule failure.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: >-
        Missing or invalid authentication, or missing required authentication
        context.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimitExceeded:
      description: >-
        Rate limit exceeded. Wait for the retry-after header before sending the
        next request.
      headers:
        retry-after:
          description: Seconds to wait before retrying.
          schema:
            type: integer
        x-ratelimit-limit:
          description: Maximum requests allowed in the current window.
          schema:
            type: integer
        x-ratelimit-remaining:
          description: Requests remaining in the current window.
          schema:
            type: integer
        x-ratelimit-reset:
          description: Seconds until the current window resets.
          schema:
            type: integer
      content:
        application/json:
          schema:
            oneOf:
              - $ref: '#/components/schemas/RateLimitError'
              - $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Unexpected server failure. Internal details are masked.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ApiError:
      description: Other client or server failure. Unknown errors expose a generic message.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Primary public authentication method. Create keys in Jobin.cloud under
        Workgroups > Integrations > Custom integration.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.