Socialboards
  • Developer hub
  • APIs
    • Ticket API
      • Getting Started
        • Guidelines and data privacy
      • Authorization
        • Access tokens
      • Categories
      • Custom Fields
      • Action Log
      • Notes
      • Replies
      • Tags
      • Tickets
      • Teammates
      • User Groups
      • Widgets
      • Webhooks
        • Getting Started
        • Create Endpoint
        • Configure the Webhooks
        • Testing your webhooks
      • Reference
        • Endpoints
          • Get Access Token v2
          • Get Full Community Category List
          • Get Subcategories by Parent Id
          • Get Category By Id
          • Get Full Community Custom Field List
          • Add Custom Field
          • Get Custom Field
          • Get All Teammates
          • Get All User Groups for Community
          • Update Custom Field
          • Delete Custom Field
          • Create Ticket
          • List Tickets
          • List Ticket Ids By Field Ids
          • Get Ticket by Id
          • Update Ticket Custom Field Value
          • Update Ticket Assignee
          • Get Ticket Log
          • Update Ticket Status
          • Update Ticket Category (Obsolete)
          • Update Ticket Category
          • Create Reply
          • List Replies
          • Add Note To Ticket
          • Update Note
          • Delete Note
          • List tags
          • Replace Ticket Tags
          • Replace Reply Tags
          • Get Widget Schedule List
        • API Request Result
        • Webhook Payload
        • Objects
          • Base Attachment
          • Category
          • Custom Field
          • Custom Field Id with Value
          • Custom Field Possible Value
          • Custom Field Value
          • Custom Times Widget Schedule
          • Note
          • Reply
          • Reply/Note Creator
          • Reply Properties
          • Schedule Time
          • Tag
          • Teammate
          • Ticket
          • Ticket Action Included Items
          • Ticket Creator
          • Ticket Id with Field Value
          • Ticket Log
          • Ticket Properties
          • User
          • User Group
          • Widget Schedule
        • Events
          • Ticket Creation
          • Ticket Status Change
          • Ticket Tags Change
          • Ticket Category Change
          • Reply Creation
          • Reply Update
          • Reply Deletion
          • Note Creation
          • Note Update
          • Note Deletion
        • Enumerations
          • Custom Field Types and Values Formats
          • Sentiment
          • Ticket Action Type
          • Ticket List Order By
          • Ticket Source
          • Ticket Status
          • User Role
          • Detailed Ticket Source
      • Glossary
    • External Chat API
      • Conversations Overview
      • Configure the Webhooks
      • Glossary
      • Reference
        • Endpoints
          • Create conversation
          • Add messages to conversation
          • Get conversation by id
          • List conversation messages
          • Get conversation queue information
          • Get takeover state
          • Change takeover state
          • Update conversation feedback
          • Update conversation latest url
          • Close conversation
        • Objects
          • Bot
          • Conversation
          • Conversation feedback
          • Conversation message
          • Conversation takeover
          • Conversation queue position
          • User
          • User Value
        • Events
          • Conversation created
          • Conversation Message Added
          • Conversation Takeover State Changed
          • Conversation Status Changed
        • Enumerations
          • Bot type
          • Order by
          • User status
          • Conversation Status
    • FAQ API
      • Glossary
      • Categories
      • FAQ Instances
      • Tags
      • Topics
      • Reference
        • Endpoints
          • List FAQ Instances
          • List Tags
          • List Categories
          • List Topics
          • Get Specific Topic
          • Add Vote to Topic
          • Increase View Count for Topic
          • Search Topics by Params
        • Objects
          • Attachment
          • Category
          • Instance
          • Tag
          • Topic
          • Topic Search Result
        • Enumerations
          • Localization Language
          • Template Type
          • Topic Downvote Reason
          • Topics Sort Options
    • Support Widget
      • Installation
      • Configuration options
      • Full script example
      • Javascript changelog
      • Widget schedule API
    • Reporting & Statistics
      • Data warehouse (DWH)
        • Entity relationship diagram (ERD)
        • Most used views and values
      • Reports and dashboards
  • Security
    • Introduction to Security
    • Data centers & network security
    • Product security features
    • Application security
    • Data Processing
    • Sub-Processors
      • 2023-04 Intility AS
        • Addendum 2023-4
  • Updates
    • Changelog
Powered by GitBook
On this page

Was this helpful?

  1. APIs
  2. Ticket API
  3. Reference
  4. Endpoints

List Ticket Ids By Field Ids

PreviousList TicketsNextGet Ticket by Id

Last updated 1 year ago

Was this helpful?

All API requests should contain .

Request

POST /tickets/customFields/values/list

Query Parameters.

This endpoint doesn't require query parameters.

Request Body

{
    "customFieldIds": [
        26690,
        26703,
        26704,
        26706
        
    ],
    "fromTicketCreationTime": "2023-01-15T00:00:00+00:00",
    "isAllFieldsInTicketRequired": true,
    "skip": 0,
    "take": 500,
    "toTicketCreationTime": "2024-01-17T00:00:00+00:00"
}

Body of request should contain the following model serialized to JSON.

Field
Type
Required
Comments

customFieldIds

array of integers

no

An array of integers representing Custom Fields Ids. The search will match tickets based on these field ids. By default it is empty and a maximum count of field ids is limited to 50

fromTicketCreationTime

string

no

A datetime string in ISO 8601 format. Only tickets created after this time will be included in the search. By default it is null

isAllFieldsInTicketRequired

boolean

no

If true, all specified fields in the search request must be present in a tickets. If false, at least one field must match in a tickets. By default it is false

skip

nullable integer

no

Specifies the number of tickets to skip in the search results. By default it is 0

take

nullable integer

no

Specifies the maximum number of tickets to return. By default it is 250 and maximum count to take is limited to 500. The tickets are ordered by Id in ascending order

toTicketCreationTime

string

no

A datetime string in ISO 8601 format. Only tickets before this time will be included in the search. By default it is null

Response

The tickets are ordered by ID in ascending order.

{
    "data": [
        {
            "customFieldValues": [
                {
                    "id": 26690,
                    "value": "Magic Cloudy Shop"
                },
                {
                    "id": 26703,
                    "value": "Arrows with Frozen Darts"
                },
                {
                    "id": 26704,
                    "value": "100"
                },
                {
                    "id": 26706,
                    "value": "2024-01-23"
                }
            ],
            "ticketId": 256245
        }
    ],
    "errorCode": -1,
    "errorText": null
}

Data field will contain an array of models.

authorization headers
TicketIdWithFieldValue