find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/freshworks-requesters-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Freshworks Freshservice Requesters API
  description: The Freshservice API v2 is a RESTful API for managing IT service desk operations programmatically. It provides endpoints for tickets, problems, changes, releases, assets, requesters, agents, and other ITSM resources. The API supports Cross-Origin Resource Sharing (CORS) for web-based applications, uses API key authentication via Base64-encoded authorization headers, and allows organizations to automate IT service management workflows and integrate Freshservice with other enterprise tools.
  version: '2.0'
  contact:
    name: Freshworks Support
    url: https://support.freshservice.com/
  termsOfService: https://www.freshworks.com/terms/
servers:
- url: https://{domain}.freshservice.com/api/v2
  description: Freshservice Production Server
  variables:
    domain:
      default: yourdomain
      description: Your Freshservice subdomain
security:
- basicAuth: []
tags:
- name: Requesters
  description: Manage requesters who submit tickets to the service desk.
paths:
  /requesters:
    get:
      operationId: listRequesters
      summary: List all requesters
      description: Retrieves a paginated list of all requesters in the service desk.
      tags:
      - Requesters
      parameters:
      - $ref: '#/components/parameters/PageParam'
      - $ref: '#/components/parameters/PerPageParam'
      - name: email
        in: query
        description: Filter requesters by email address.
        schema:
          type: string
          format: email
      - name: query
        in: query
        description: Search query to filter requesters by name or email.
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  requesters:
                    type: array
                    items:
                      $ref: '#/components/schemas/Requester'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createRequester
      summary: Create a requester
      description: Creates a new requester in the service desk.
      tags:
      - Requesters
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequesterCreate'
      responses:
        '201':
          description: Requester created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  requester:
                    $ref: '#/components/schemas/Requester'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /requesters/{requester_id}:
    get:
      operationId: getRequester
      summary: View a requester
      description: Retrieves the details of a specific requester by their ID.
      tags:
      - Requesters
      parameters:
      - $ref: '#/components/parameters/RequesterIdParam'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  requester:
                    $ref: '#/components/schemas/Requester'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      operationId: updateRequester
      summary: Update a requester
      description: Updates the properties of an existing requester.
      tags:
      - Requesters
      parameters:
      - $ref: '#/components/parameters/RequesterIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequesterCreate'
      responses:
        '200':
          description: Requester updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  requester:
                    $ref: '#/components/schemas/Requester'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteRequester
      summary: Delete a requester
      description: Deletes a requester from the service desk.
      tags:
      - Requesters
      parameters:
      - $ref: '#/components/parameters/RequesterIdParam'
      responses:
        '204':
          description: Requester deleted successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    BadRequest:
      description: The request body or parameters are invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication credentials are missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        description:
          type: string
          description: Human-readable error message.
        errors:
          type: array
          description: List of specific validation errors.
          items:
            type: object
            properties:
              field:
                type: string
                description: Field that caused the error.
              message:
                type: string
                description: Error message.
              code:
                type: string
                description: Error code.
    Requester:
      type: object
      properties:
        id:
          type: integer
          description: Unique ID of the requester.
        first_name:
          type: string
          description: First name.
        last_name:
          type: string
          description: Last name.
        primary_email:
          type: string
          format: email
          description: Primary email address.
        work_phone_number:
          type: string
          description: Work phone number.
        mobile_phone_number:
          type: string
          description: Mobile phone number.
        job_title:
          type: string
          description: Job title.
        department_id:
          type: integer
          description: ID of the department.
        location_id:
          type: integer
          description: ID of the location.
        is_agent:
          type: boolean
          description: Whether the requester is also an agent.
        active:
          type: boolean
          description: Whether the requester is active.
        custom_fields:
          type: object
          additionalProperties: true
          description: Custom field values.
        created_at:
          type: string
          format: date-time
          description: Timestamp when created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when last updated.
    RequesterCreate:
      type: object
      required:
      - first_name
      - primary_email
      properties:
        first_name:
          type: string
          description: First name.
        last_name:
          type: string
          description: Last name.
        primary_email:
          type: string
          format: email
          description: Primary email address.
        work_phone_number:
          type: string
          description: Work phone number.
        mobile_phone_number:
          type: string
          description: Mobile phone number.
        job_title:
          type: string
          description: Job title.
        department_id:
          type: integer
          description: ID of the department.
        location_id:
          type: integer
          description: ID of the location.
        custom_fields:
          type: object
          additionalProperties: true
          description: Custom field values.
  parameters:
    PageParam:
      name: page
      in: query
      description: Page number for pagination.
      schema:
        type: integer
        minimum: 1
        default: 1
    PerPageParam:
      name: per_page
      in: query
      description: Number of results per page (max 100).
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 30
    RequesterIdParam:
      name: requester_id
      in: path
      required: true
      description: The ID of the requester.
      schema:
        type: integer
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: Use your API key as the username and X as the password. The API key can be found in your Freshservice profile settings.
externalDocs:
  description: Freshservice API Documentation
  url: https://api.freshservice.com/